swf

Documentation

Index

• type Domain
  • func GetDomain(ctx *pulumi.Context, name string, id pulumi.IDInput, state *DomainState, ...) (*Domain, error)
  • func NewDomain(ctx *pulumi.Context, name string, args *DomainArgs, ...) (*Domain, error)
  • func (Domain) ElementType() reflect.Type
  • func (i Domain) ToDomainOutput() DomainOutput
  • func (i Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput
• type DomainArgs
  • func (DomainArgs) ElementType() reflect.Type
• type DomainInput
• type DomainOutput
  • func (DomainOutput) ElementType() reflect.Type
  • func (o DomainOutput) ToDomainOutput() DomainOutput
  • func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput
• type DomainState
  • func (DomainState) ElementType() reflect.Type

Types

type Domain

type Domain struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN)
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The domain description.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The name of the domain. If omitted, this provider will assign a random, unique name.
	Name pulumi.StringOutput `pulumi:"name"`
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix pulumi.StringPtrOutput `pulumi:"namePrefix"`
	// Key-value map of resource tags
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// 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.
	WorkflowExecutionRetentionPeriodInDays pulumi.StringOutput `pulumi:"workflowExecutionRetentionPeriodInDays"`
}

Provides an SWF Domain resource.

## Example Usage

To register a basic SWF domain:

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/swf"
"github.com/pulumi/pulumi/sdk/v2/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
	})
}

```

## Import

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

```sh

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

```

func GetDomain

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

GetDomain gets an existing Domain resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDomain

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

NewDomain registers a new resource with the given unique name, arguments, and options.

func (Domain) ElementType

func (Domain) ElementType() reflect.Type

func (Domain) ToDomainOutput

func (i Domain) ToDomainOutput() DomainOutput

func (Domain) ToDomainOutputWithContext

func (i Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput

type DomainArgs

type DomainArgs struct {
	// The domain description.
	Description pulumi.StringPtrInput
	// The name of the domain. If omitted, this provider will assign a random, unique name.
	Name pulumi.StringPtrInput
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix pulumi.StringPtrInput
	// Key-value map of resource tags
	Tags pulumi.StringMapInput
	// 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.
	WorkflowExecutionRetentionPeriodInDays pulumi.StringInput
}

The set of arguments for constructing a Domain resource.

func (DomainArgs) ElementType

func (DomainArgs) ElementType() reflect.Type

type DomainInput

type DomainInput interface {
	pulumi.Input

	ToDomainOutput() DomainOutput
	ToDomainOutputWithContext(ctx context.Context) DomainOutput
}

type DomainOutput

type DomainOutput struct {
	*pulumi.OutputState
}

func (DomainOutput) ElementType

func (DomainOutput) ElementType() reflect.Type

func (DomainOutput) ToDomainOutput

func (o DomainOutput) ToDomainOutput() DomainOutput

func (DomainOutput) ToDomainOutputWithContext

func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput

type DomainState

type DomainState struct {
	// Amazon Resource Name (ARN)
	Arn pulumi.StringPtrInput
	// The domain description.
	Description pulumi.StringPtrInput
	// The name of the domain. If omitted, this provider will assign a random, unique name.
	Name pulumi.StringPtrInput
	// Creates a unique name beginning with the specified prefix. Conflicts with `name`.
	NamePrefix pulumi.StringPtrInput
	// Key-value map of resource tags
	Tags pulumi.StringMapInput
	// 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.
	WorkflowExecutionRetentionPeriodInDays pulumi.StringPtrInput
}

func (DomainState) ElementType

func (DomainState) ElementType() reflect.Type