1. Docs
  2. Reference
  3. API
  4. @pulumi/aws
  5. swf

Module swf

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Resources

Others

Resources

Resource Domain

class Domain extends CustomResource

Provides an SWF Domain resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foo = new aws.swf.Domain("foo", {
    description: "SWF Domain",
    workflowExecutionRetentionPeriodInDays: "30",
});

constructor

new Domain(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions)

Create a Domain resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain

Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Domain

Returns true if the given object is an instance of Domain. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN)

property description

public description: pulumi.Output<string | undefined>;

The domain description.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the domain. If omitted, this provider will assign a random, unique name.

property namePrefix

public namePrefix: pulumi.Output<string | undefined>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property workflowExecutionRetentionPeriodInDays

public workflowExecutionRetentionPeriodInDays: pulumi.Output<string>;

Length of time that SWF will continue to retain information about the workflow execution after the workflow execution is complete, must be between 0 and 90 days.

Others

interface DomainArgs

interface DomainArgs

The set of arguments for constructing a Domain resource.

property description

description?: pulumi.Input<string>;

The domain description.

property name

name?: pulumi.Input<string>;

The name of the domain. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property workflowExecutionRetentionPeriodInDays

workflowExecutionRetentionPeriodInDays: pulumi.Input<string>;

Length of time that SWF will continue to retain information about the workflow execution after the workflow execution is complete, must be between 0 and 90 days.

interface DomainState

interface DomainState

Input properties used for looking up and filtering Domain resources.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN)

property description

description?: pulumi.Input<string>;

The domain description.

property name

name?: pulumi.Input<string>;

The name of the domain. If omitted, this provider will assign a random, unique name.

property namePrefix

namePrefix?: pulumi.Input<string>;

Creates a unique name beginning with the specified prefix. Conflicts with name.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

property workflowExecutionRetentionPeriodInDays

workflowExecutionRetentionPeriodInDays?: pulumi.Input<string>;

Length of time that SWF will continue to retain information about the workflow execution after the workflow execution is complete, must be between 0 and 90 days.