AWS Classic

v5.16.0 published on Saturday, Sep 24, 2022 by Pulumi

Domain

Provides an SWF Domain resource.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var foo = new Aws.Swf.Domain("foo", new()
    {
        Description = "SWF Domain",
        WorkflowExecutionRetentionPeriodInDays = "30",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/swf"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := swf.NewDomain(ctx, "foo", &swf.DomainArgs{
			Description:                            pulumi.String("SWF Domain"),
			WorkflowExecutionRetentionPeriodInDays: pulumi.String("30"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.swf.Domain;
import com.pulumi.aws.swf.DomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var foo = new Domain("foo", DomainArgs.builder()        
            .description("SWF Domain")
            .workflowExecutionRetentionPeriodInDays(30)
            .build());

    }
}

import pulumi
import pulumi_aws as aws

foo = aws.swf.Domain("foo",
    description="SWF Domain",
    workflow_execution_retention_period_in_days="30")

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

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

resources:
  foo:
    type: aws:swf:Domain
    properties:
      description: SWF Domain
      workflowExecutionRetentionPeriodInDays: 30

Create a Domain Resource

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

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           name_prefix: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           workflow_execution_retention_period_in_days: Optional[str] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)

public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)

public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: aws:swf:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Domain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Domain resource accepts the following input properties:

WorkflowExecutionRetentionPeriodInDays 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.
Description string: The domain description.
Name string: The name of the domain. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags Dictionary<string, string>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

WorkflowExecutionRetentionPeriodInDays 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.
Description string: The domain description.
Name string: The name of the domain. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags map[string]string: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

workflowExecutionRetentionPeriodInDays 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.
description String: The domain description.
name String: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix String: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String,String>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

workflowExecutionRetentionPeriodInDays 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.
description string: The domain description.
name string: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags {[key: string]: string}: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

workflow_execution_retention_period_in_days str: 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.
description str: The domain description.
name str: The name of the domain. If omitted, this provider will assign a random, unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Mapping[str, str]: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

workflowExecutionRetentionPeriodInDays 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.
description String: The domain description.
name String: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix String: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

Arn string: Amazon Resource Name (ARN)
Id string: The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: Amazon Resource Name (ARN)
Id string: The provider-assigned unique ID for this managed resource.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN)
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: Amazon Resource Name (ARN)
id string: The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: Amazon Resource Name (ARN)
id str: The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: Amazon Resource Name (ARN)
id String: The provider-assigned unique ID for this managed resource.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up an Existing Domain Resource

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        workflow_execution_retention_period_in_days: Optional[str] = None) -> Domain

func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)

public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)

public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN)
Description string: The domain description.
Name string: The name of the domain. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags Dictionary<string, string>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
WorkflowExecutionRetentionPeriodInDays 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.

Arn string: Amazon Resource Name (ARN)
Description string: The domain description.
Name string: The name of the domain. If omitted, this provider will assign a random, unique name.
NamePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
Tags map[string]string: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
WorkflowExecutionRetentionPeriodInDays 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.

arn String: Amazon Resource Name (ARN)
description String: The domain description.
name String: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix String: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String,String>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
workflowExecutionRetentionPeriodInDays 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.

arn string: Amazon Resource Name (ARN)
description string: The domain description.
name string: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix string: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags {[key: string]: string}: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
workflowExecutionRetentionPeriodInDays 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.

arn str: Amazon Resource Name (ARN)
description str: The domain description.
name str: The name of the domain. If omitted, this provider will assign a random, unique name.
name_prefix str: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Mapping[str, str]: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
workflow_execution_retention_period_in_days str: 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.

arn String: Amazon Resource Name (ARN)
description String: The domain description.
name String: The name of the domain. If omitted, this provider will assign a random, unique name.
namePrefix String: Creates a unique name beginning with the specified prefix. Conflicts with name.
tags Map<String>: Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
workflowExecutionRetentionPeriodInDays 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.

Import

SWF Domains can be imported using the name, e.g.,

 $ pulumi import aws:swf/domain:Domain foo test-domain

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.