Documentation
¶
Index ¶
- type Domain
- type DomainArgs
- type DomainArray
- type DomainArrayInput
- type DomainArrayOutput
- type DomainInput
- type DomainMap
- type DomainMapInput
- type DomainMapOutput
- type DomainOutput
- func (o DomainOutput) Arn() pulumi.StringOutput
- func (o DomainOutput) Description() pulumi.StringPtrOutput
- func (DomainOutput) ElementType() reflect.Type
- func (o DomainOutput) Name() pulumi.StringOutput
- func (o DomainOutput) NamePrefix() pulumi.StringOutput
- func (o DomainOutput) Region() pulumi.StringOutput
- func (o DomainOutput) Tags() pulumi.StringMapOutput
- func (o DomainOutput) TagsAll() pulumi.StringMapOutput
- func (o DomainOutput) ToDomainOutput() DomainOutput
- func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput
- func (o DomainOutput) WorkflowExecutionRetentionPeriodInDays() pulumi.StringOutput
- type DomainState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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.StringOutput `pulumi:"namePrefix"`
// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
Region pulumi.StringOutput `pulumi:"region"`
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapOutput `pulumi:"tags"`
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
// 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/v7/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{
Name: pulumi.String("foo"),
Description: pulumi.String("SWF Domain"),
WorkflowExecutionRetentionPeriodInDays: pulumi.String("30"),
})
if err != nil {
return err
}
return nil
})
}
```
## Import
Using `pulumi import`, import SWF Domains using the `name`. For example:
```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) 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
// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
Region pulumi.StringPtrInput
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
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 DomainArray ¶
type DomainArray []DomainInput
func (DomainArray) ElementType ¶
func (DomainArray) ElementType() reflect.Type
func (DomainArray) ToDomainArrayOutput ¶
func (i DomainArray) ToDomainArrayOutput() DomainArrayOutput
func (DomainArray) ToDomainArrayOutputWithContext ¶
func (i DomainArray) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput
type DomainArrayInput ¶
type DomainArrayInput interface {
pulumi.Input
ToDomainArrayOutput() DomainArrayOutput
ToDomainArrayOutputWithContext(context.Context) DomainArrayOutput
}
DomainArrayInput is an input type that accepts DomainArray and DomainArrayOutput values. You can construct a concrete instance of `DomainArrayInput` via:
DomainArray{ DomainArgs{...} }
type DomainArrayOutput ¶
type DomainArrayOutput struct{ *pulumi.OutputState }
func (DomainArrayOutput) ElementType ¶
func (DomainArrayOutput) ElementType() reflect.Type
func (DomainArrayOutput) Index ¶
func (o DomainArrayOutput) Index(i pulumi.IntInput) DomainOutput
func (DomainArrayOutput) ToDomainArrayOutput ¶
func (o DomainArrayOutput) ToDomainArrayOutput() DomainArrayOutput
func (DomainArrayOutput) ToDomainArrayOutputWithContext ¶
func (o DomainArrayOutput) ToDomainArrayOutputWithContext(ctx context.Context) DomainArrayOutput
type DomainInput ¶
type DomainInput interface {
pulumi.Input
ToDomainOutput() DomainOutput
ToDomainOutputWithContext(ctx context.Context) DomainOutput
}
type DomainMap ¶
type DomainMap map[string]DomainInput
func (DomainMap) ElementType ¶
func (DomainMap) ToDomainMapOutput ¶
func (i DomainMap) ToDomainMapOutput() DomainMapOutput
func (DomainMap) ToDomainMapOutputWithContext ¶
func (i DomainMap) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput
type DomainMapInput ¶
type DomainMapInput interface {
pulumi.Input
ToDomainMapOutput() DomainMapOutput
ToDomainMapOutputWithContext(context.Context) DomainMapOutput
}
DomainMapInput is an input type that accepts DomainMap and DomainMapOutput values. You can construct a concrete instance of `DomainMapInput` via:
DomainMap{ "key": DomainArgs{...} }
type DomainMapOutput ¶
type DomainMapOutput struct{ *pulumi.OutputState }
func (DomainMapOutput) ElementType ¶
func (DomainMapOutput) ElementType() reflect.Type
func (DomainMapOutput) MapIndex ¶
func (o DomainMapOutput) MapIndex(k pulumi.StringInput) DomainOutput
func (DomainMapOutput) ToDomainMapOutput ¶
func (o DomainMapOutput) ToDomainMapOutput() DomainMapOutput
func (DomainMapOutput) ToDomainMapOutputWithContext ¶
func (o DomainMapOutput) ToDomainMapOutputWithContext(ctx context.Context) DomainMapOutput
type DomainOutput ¶
type DomainOutput struct{ *pulumi.OutputState }
func (DomainOutput) Arn ¶
func (o DomainOutput) Arn() pulumi.StringOutput
Amazon Resource Name (ARN)
func (DomainOutput) Description ¶
func (o DomainOutput) Description() pulumi.StringPtrOutput
The domain description.
func (DomainOutput) ElementType ¶
func (DomainOutput) ElementType() reflect.Type
func (DomainOutput) Name ¶
func (o DomainOutput) Name() pulumi.StringOutput
The name of the domain. If omitted, this provider will assign a random, unique name.
func (DomainOutput) NamePrefix ¶
func (o DomainOutput) NamePrefix() pulumi.StringOutput
Creates a unique name beginning with the specified prefix. Conflicts with `name`.
func (DomainOutput) Region ¶
func (o DomainOutput) Region() pulumi.StringOutput
Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
func (DomainOutput) Tags ¶
func (o DomainOutput) Tags() pulumi.StringMapOutput
Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
func (DomainOutput) TagsAll ¶
func (o DomainOutput) TagsAll() pulumi.StringMapOutput
A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
func (DomainOutput) ToDomainOutput ¶
func (o DomainOutput) ToDomainOutput() DomainOutput
func (DomainOutput) ToDomainOutputWithContext ¶
func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput
func (DomainOutput) WorkflowExecutionRetentionPeriodInDays ¶
func (o DomainOutput) WorkflowExecutionRetentionPeriodInDays() pulumi.StringOutput
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.
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
// Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
Region pulumi.StringPtrInput
// Key-value map of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Tags pulumi.StringMapInput
// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
TagsAll 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