sfn

package
v5.43.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 21, 2023 License: Apache-2.0 Imports: 7 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Activity 

type Activity struct {
	pulumi.CustomResourceState

	// The date the activity was created.
	CreationDate pulumi.StringOutput `pulumi:"creationDate"`
	// The name of the activity to create.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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"`
}

Provides a Step Function Activity resource

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewActivity(ctx, "sfnActivity", nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Activities can be imported using the `arn`, e.g.,

```sh 

$ pulumi import aws:sfn/activity:Activity foo arn:aws:states:eu-west-1:123456789098:activity:bar

```

func GetActivity 

func GetActivity(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ActivityState, opts ...pulumi.ResourceOption) (*Activity, error)

GetActivity gets an existing Activity 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 NewActivity 

func NewActivity(ctx *pulumi.Context,
	name string, args *ActivityArgs, opts ...pulumi.ResourceOption) (*Activity, error)

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

func (*Activity) ElementType 

func (*Activity) ElementType() reflect.Type

func (*Activity) ToActivityOutput 

func (i *Activity) ToActivityOutput() ActivityOutput

func (*Activity) ToActivityOutputWithContext 

func (i *Activity) ToActivityOutputWithContext(ctx context.Context) ActivityOutput

type ActivityArgs 

type ActivityArgs struct {
	// The name of the activity to create.
	Name 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
}

The set of arguments for constructing a Activity resource.

func (ActivityArgs) ElementType 

func (ActivityArgs) ElementType() reflect.Type

type ActivityArray 

type ActivityArray []ActivityInput

func (ActivityArray) ElementType 

func (ActivityArray) ElementType() reflect.Type

func (ActivityArray) ToActivityArrayOutput 

func (i ActivityArray) ToActivityArrayOutput() ActivityArrayOutput

func (ActivityArray) ToActivityArrayOutputWithContext 

func (i ActivityArray) ToActivityArrayOutputWithContext(ctx context.Context) ActivityArrayOutput

type ActivityArrayInput 

type ActivityArrayInput interface {
	pulumi.Input

	ToActivityArrayOutput() ActivityArrayOutput
	ToActivityArrayOutputWithContext(context.Context) ActivityArrayOutput
}

ActivityArrayInput is an input type that accepts ActivityArray and ActivityArrayOutput values. You can construct a concrete instance of `ActivityArrayInput` via: 

ActivityArray{ ActivityArgs{...} }

type ActivityArrayOutput 

type ActivityArrayOutput struct{ *pulumi.OutputState }

func (ActivityArrayOutput) ElementType 

func (ActivityArrayOutput) ElementType() reflect.Type

func (ActivityArrayOutput) Index 

func (o ActivityArrayOutput) Index(i pulumi.IntInput) ActivityOutput

func (ActivityArrayOutput) ToActivityArrayOutput 

func (o ActivityArrayOutput) ToActivityArrayOutput() ActivityArrayOutput

func (ActivityArrayOutput) ToActivityArrayOutputWithContext 

func (o ActivityArrayOutput) ToActivityArrayOutputWithContext(ctx context.Context) ActivityArrayOutput

type ActivityInput 

type ActivityInput interface {
	pulumi.Input

	ToActivityOutput() ActivityOutput
	ToActivityOutputWithContext(ctx context.Context) ActivityOutput
}

type ActivityMap 

type ActivityMap map[string]ActivityInput

func (ActivityMap) ElementType 

func (ActivityMap) ElementType() reflect.Type

func (ActivityMap) ToActivityMapOutput 

func (i ActivityMap) ToActivityMapOutput() ActivityMapOutput

func (ActivityMap) ToActivityMapOutputWithContext 

func (i ActivityMap) ToActivityMapOutputWithContext(ctx context.Context) ActivityMapOutput

type ActivityMapInput 

type ActivityMapInput interface {
	pulumi.Input

	ToActivityMapOutput() ActivityMapOutput
	ToActivityMapOutputWithContext(context.Context) ActivityMapOutput
}

ActivityMapInput is an input type that accepts ActivityMap and ActivityMapOutput values. You can construct a concrete instance of `ActivityMapInput` via: 

ActivityMap{ "key": ActivityArgs{...} }

type ActivityMapOutput 

type ActivityMapOutput struct{ *pulumi.OutputState }

func (ActivityMapOutput) ElementType 

func (ActivityMapOutput) ElementType() reflect.Type

func (ActivityMapOutput) MapIndex 

func (o ActivityMapOutput) MapIndex(k pulumi.StringInput) ActivityOutput

func (ActivityMapOutput) ToActivityMapOutput 

func (o ActivityMapOutput) ToActivityMapOutput() ActivityMapOutput

func (ActivityMapOutput) ToActivityMapOutputWithContext 

func (o ActivityMapOutput) ToActivityMapOutputWithContext(ctx context.Context) ActivityMapOutput

type ActivityOutput 

type ActivityOutput struct{ *pulumi.OutputState }

func (ActivityOutput) CreationDate added in v5.4.0 

func (o ActivityOutput) CreationDate() pulumi.StringOutput

The date the activity was created.

func (ActivityOutput) ElementType 

func (ActivityOutput) ElementType() reflect.Type

func (ActivityOutput) Name added in v5.4.0 

func (o ActivityOutput) Name() pulumi.StringOutput

The name of the activity to create.

func (ActivityOutput) Tags added in v5.4.0 

func (o ActivityOutput) 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 (ActivityOutput) TagsAll added in v5.4.0 

func (o ActivityOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (ActivityOutput) ToActivityOutput 

func (o ActivityOutput) ToActivityOutput() ActivityOutput

func (ActivityOutput) ToActivityOutputWithContext 

func (o ActivityOutput) ToActivityOutputWithContext(ctx context.Context) ActivityOutput

type ActivityState 

type ActivityState struct {
	// The date the activity was created.
	CreationDate pulumi.StringPtrInput
	// The name of the activity to create.
	Name 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
}

func (ActivityState) ElementType 

func (ActivityState) ElementType() reflect.Type

type LookupActivityArgs 

type LookupActivityArgs struct {
	// ARN that identifies the activity.
	Arn *string `pulumi:"arn"`
	// Name that identifies the activity.
	Name *string `pulumi:"name"`
}

A collection of arguments for invoking getActivity.

type LookupActivityOutputArgs 

type LookupActivityOutputArgs struct {
	// ARN that identifies the activity.
	Arn pulumi.StringPtrInput `pulumi:"arn"`
	// Name that identifies the activity.
	Name pulumi.StringPtrInput `pulumi:"name"`
}

A collection of arguments for invoking getActivity.

func (LookupActivityOutputArgs) ElementType 

func (LookupActivityOutputArgs) ElementType() reflect.Type

type LookupActivityResult 

type LookupActivityResult struct {
	Arn string `pulumi:"arn"`
	// Date the activity was created.
	CreationDate string `pulumi:"creationDate"`
	// The provider-assigned unique ID for this managed resource.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
}

A collection of values returned by getActivity.

func LookupActivity 

func LookupActivity(ctx *pulumi.Context, args *LookupActivityArgs, opts ...pulumi.InvokeOption) (*LookupActivityResult, error)

Provides a Step Functions Activity data source

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.LookupActivity(ctx, &sfn.LookupActivityArgs{
			Name: pulumi.StringRef("my-activity"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupActivityResultOutput 

type LookupActivityResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getActivity.

func LookupActivityOutput 

func LookupActivityOutput(ctx *pulumi.Context, args LookupActivityOutputArgs, opts ...pulumi.InvokeOption) LookupActivityResultOutput

func (LookupActivityResultOutput) Arn 

func (o LookupActivityResultOutput) Arn() pulumi.StringOutput

func (LookupActivityResultOutput) CreationDate 

func (o LookupActivityResultOutput) CreationDate() pulumi.StringOutput

Date the activity was created.

func (LookupActivityResultOutput) ElementType 

func (LookupActivityResultOutput) ElementType() reflect.Type

func (LookupActivityResultOutput) Id 

func (o LookupActivityResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupActivityResultOutput) Name 

func (o LookupActivityResultOutput) Name() pulumi.StringOutput

func (LookupActivityResultOutput) ToLookupActivityResultOutput 

func (o LookupActivityResultOutput) ToLookupActivityResultOutput() LookupActivityResultOutput

func (LookupActivityResultOutput) ToLookupActivityResultOutputWithContext 

func (o LookupActivityResultOutput) ToLookupActivityResultOutputWithContext(ctx context.Context) LookupActivityResultOutput

type LookupStateMachineArgs 

type LookupStateMachineArgs struct {
	// Friendly name of the state machine to match.
	Name string `pulumi:"name"`
}

A collection of arguments for invoking getStateMachine.

type LookupStateMachineOutputArgs 

type LookupStateMachineOutputArgs struct {
	// Friendly name of the state machine to match.
	Name pulumi.StringInput `pulumi:"name"`
}

A collection of arguments for invoking getStateMachine.

func (LookupStateMachineOutputArgs) ElementType 

func (LookupStateMachineOutputArgs) ElementType() reflect.Type

type LookupStateMachineResult 

type LookupStateMachineResult struct {
	// Set to the arn of the state function.
	Arn string `pulumi:"arn"`
	// Date the state machine was created.
	CreationDate string `pulumi:"creationDate"`
	// Set to the state machine definition.
	Definition string `pulumi:"definition"`
	// The provider-assigned unique ID for this managed resource.
	Id   string `pulumi:"id"`
	Name string `pulumi:"name"`
	// Set to the roleArn used by the state function.
	RoleArn string `pulumi:"roleArn"`
	// Set to the current status of the state machine.
	Status string `pulumi:"status"`
}

A collection of values returned by getStateMachine.

func LookupStateMachine 

func LookupStateMachine(ctx *pulumi.Context, args *LookupStateMachineArgs, opts ...pulumi.InvokeOption) (*LookupStateMachineResult, error)

Use this data source to get the ARN of a State Machine in AWS Step Function (SFN). By using this data source, you can reference a state machine without having to hard code the ARNs as input.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.LookupStateMachine(ctx, &sfn.LookupStateMachineArgs{
			Name: "an_example_sfn_name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupStateMachineResultOutput 

type LookupStateMachineResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getStateMachine.

func LookupStateMachineOutput 

func LookupStateMachineOutput(ctx *pulumi.Context, args LookupStateMachineOutputArgs, opts ...pulumi.InvokeOption) LookupStateMachineResultOutput

func (LookupStateMachineResultOutput) Arn 

func (o LookupStateMachineResultOutput) Arn() pulumi.StringOutput

Set to the arn of the state function.

func (LookupStateMachineResultOutput) CreationDate 

func (o LookupStateMachineResultOutput) CreationDate() pulumi.StringOutput

Date the state machine was created.

func (LookupStateMachineResultOutput) Definition 

func (o LookupStateMachineResultOutput) Definition() pulumi.StringOutput

Set to the state machine definition.

func (LookupStateMachineResultOutput) ElementType 

func (LookupStateMachineResultOutput) ElementType() reflect.Type

func (LookupStateMachineResultOutput) Id 

func (o LookupStateMachineResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupStateMachineResultOutput) Name 

func (o LookupStateMachineResultOutput) Name() pulumi.StringOutput

func (LookupStateMachineResultOutput) RoleArn 

func (o LookupStateMachineResultOutput) RoleArn() pulumi.StringOutput

Set to the roleArn used by the state function.

func (LookupStateMachineResultOutput) Status 

func (o LookupStateMachineResultOutput) Status() pulumi.StringOutput

Set to the current status of the state machine.

func (LookupStateMachineResultOutput) ToLookupStateMachineResultOutput 

func (o LookupStateMachineResultOutput) ToLookupStateMachineResultOutput() LookupStateMachineResultOutput

func (LookupStateMachineResultOutput) ToLookupStateMachineResultOutputWithContext 

func (o LookupStateMachineResultOutput) ToLookupStateMachineResultOutputWithContext(ctx context.Context) LookupStateMachineResultOutput

type StateMachine 

type StateMachine struct {
	pulumi.CustomResourceState

	// The ARN of the state machine.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The date the state machine was created.
	CreationDate pulumi.StringOutput `pulumi:"creationDate"`
	// The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine.
	Definition pulumi.StringOutput `pulumi:"definition"`
	// Defines what execution history events are logged and where they are logged. The `loggingConfiguration` parameter is only valid when `type` is set to `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html) and [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.
	LoggingConfiguration StateMachineLoggingConfigurationOutput `pulumi:"loggingConfiguration"`
	// The name of the state machine. The name should only contain `0`-`9`, `A`-`Z`, `a`-`z`, `-` and `_`. If omitted, the 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"`
	// The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
	RoleArn pulumi.StringOutput `pulumi:"roleArn"`
	// The current status of the state machine. Either `ACTIVE` or `DELETING`.
	Status pulumi.StringOutput `pulumi:"status"`
	// 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"`
	// Selects whether AWS X-Ray tracing is enabled.
	TracingConfiguration StateMachineTracingConfigurationOutput `pulumi:"tracingConfiguration"`
	// Determines whether a Standard or Express state machine is created. The default is `STANDARD`. You cannot update the type of a state machine once it has been created. Valid values: `STANDARD`, `EXPRESS`.
	Type pulumi.StringPtrOutput `pulumi:"type"`
}

Provides a Step Function State Machine resource

## Example Usage ### Basic (Standard Workflow)

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewStateMachine(ctx, "sfnStateMachine", &sfn.StateMachineArgs{
			RoleArn: pulumi.Any(aws_iam_role.Iam_for_sfn.Arn),
			Definition: pulumi.String(fmt.Sprintf(`{
  "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda Function",
  "StartAt": "HelloWorld",
  "States": {
    "HelloWorld": {
      "Type": "Task",
      "Resource": "%v",
      "End": true
    }
  }
}

`, aws_lambda_function.Lambda.Arn)), 

		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Basic (Express Workflow)

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewStateMachine(ctx, "sfnStateMachine", &sfn.StateMachineArgs{
			RoleArn: pulumi.Any(aws_iam_role.Iam_for_sfn.Arn),
			Type:    pulumi.String("EXPRESS"),
			Definition: pulumi.String(fmt.Sprintf(`{
  "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda Function",
  "StartAt": "HelloWorld",
  "States": {
    "HelloWorld": {
      "Type": "Task",
      "Resource": "%v",
      "End": true
    }
  }
}

`, aws_lambda_function.Lambda.Arn)), 

		})
		if err != nil {
			return err
		}
		return nil
	})
}

``` ### Logging

> *NOTE:* See the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html) for more information about enabling Step Function logging.

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := sfn.NewStateMachine(ctx, "sfnStateMachine", &sfn.StateMachineArgs{
			RoleArn: pulumi.Any(aws_iam_role.Iam_for_sfn.Arn),
			Definition: pulumi.String(fmt.Sprintf(`{
  "Comment": "A Hello World example of the Amazon States Language using an AWS Lambda Function",
  "StartAt": "HelloWorld",
  "States": {
    "HelloWorld": {
      "Type": "Task",
      "Resource": "%v",
      "End": true
    }
  }
}

`, aws_lambda_function.Lambda.Arn)), 

			LoggingConfiguration: &sfn.StateMachineLoggingConfigurationArgs{
				LogDestination:       pulumi.String(fmt.Sprintf("%v:*", aws_cloudwatch_log_group.Log_group_for_sfn.Arn)),
				IncludeExecutionData: pulumi.Bool(true),
				Level:                pulumi.String("ERROR"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

State Machines can be imported using the `arn`, e.g.,

```sh 

$ pulumi import aws:sfn/stateMachine:StateMachine foo arn:aws:states:eu-west-1:123456789098:stateMachine:bar

```

func GetStateMachine 

func GetStateMachine(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *StateMachineState, opts ...pulumi.ResourceOption) (*StateMachine, error)

GetStateMachine gets an existing StateMachine 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 NewStateMachine 

func NewStateMachine(ctx *pulumi.Context,
	name string, args *StateMachineArgs, opts ...pulumi.ResourceOption) (*StateMachine, error)

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

func (*StateMachine) ElementType 

func (*StateMachine) ElementType() reflect.Type

func (*StateMachine) ToStateMachineOutput 

func (i *StateMachine) ToStateMachineOutput() StateMachineOutput

func (*StateMachine) ToStateMachineOutputWithContext 

func (i *StateMachine) ToStateMachineOutputWithContext(ctx context.Context) StateMachineOutput

type StateMachineArgs 

type StateMachineArgs struct {
	// The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine.
	Definition pulumi.StringInput
	// Defines what execution history events are logged and where they are logged. The `loggingConfiguration` parameter is only valid when `type` is set to `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html) and [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.
	LoggingConfiguration StateMachineLoggingConfigurationPtrInput
	// The name of the state machine. The name should only contain `0`-`9`, `A`-`Z`, `a`-`z`, `-` and `_`. If omitted, the 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
	// The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
	RoleArn pulumi.StringInput
	// 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
	// Selects whether AWS X-Ray tracing is enabled.
	TracingConfiguration StateMachineTracingConfigurationPtrInput
	// Determines whether a Standard or Express state machine is created. The default is `STANDARD`. You cannot update the type of a state machine once it has been created. Valid values: `STANDARD`, `EXPRESS`.
	Type pulumi.StringPtrInput
}

The set of arguments for constructing a StateMachine resource.

func (StateMachineArgs) ElementType 

func (StateMachineArgs) ElementType() reflect.Type

type StateMachineArray 

type StateMachineArray []StateMachineInput

func (StateMachineArray) ElementType 

func (StateMachineArray) ElementType() reflect.Type

func (StateMachineArray) ToStateMachineArrayOutput 

func (i StateMachineArray) ToStateMachineArrayOutput() StateMachineArrayOutput

func (StateMachineArray) ToStateMachineArrayOutputWithContext 

func (i StateMachineArray) ToStateMachineArrayOutputWithContext(ctx context.Context) StateMachineArrayOutput

type StateMachineArrayInput 

type StateMachineArrayInput interface {
	pulumi.Input

	ToStateMachineArrayOutput() StateMachineArrayOutput
	ToStateMachineArrayOutputWithContext(context.Context) StateMachineArrayOutput
}

StateMachineArrayInput is an input type that accepts StateMachineArray and StateMachineArrayOutput values. You can construct a concrete instance of `StateMachineArrayInput` via: 

StateMachineArray{ StateMachineArgs{...} }

type StateMachineArrayOutput 

type StateMachineArrayOutput struct{ *pulumi.OutputState }

func (StateMachineArrayOutput) ElementType 

func (StateMachineArrayOutput) ElementType() reflect.Type

func (StateMachineArrayOutput) Index 

func (o StateMachineArrayOutput) Index(i pulumi.IntInput) StateMachineOutput

func (StateMachineArrayOutput) ToStateMachineArrayOutput 

func (o StateMachineArrayOutput) ToStateMachineArrayOutput() StateMachineArrayOutput

func (StateMachineArrayOutput) ToStateMachineArrayOutputWithContext 

func (o StateMachineArrayOutput) ToStateMachineArrayOutputWithContext(ctx context.Context) StateMachineArrayOutput

type StateMachineInput 

type StateMachineInput interface {
	pulumi.Input

	ToStateMachineOutput() StateMachineOutput
	ToStateMachineOutputWithContext(ctx context.Context) StateMachineOutput
}

type StateMachineLoggingConfiguration 

type StateMachineLoggingConfiguration struct {
	// Determines whether execution data is included in your log. When set to `false`, data is excluded.
	IncludeExecutionData *bool `pulumi:"includeExecutionData"`
	// Defines which category of execution history events are logged. Valid values: `ALL`, `ERROR`, `FATAL`, `OFF`
	Level *string `pulumi:"level"`
	// Amazon Resource Name (ARN) of a CloudWatch log group. Make sure the State Machine has the correct IAM policies for logging. The ARN must end with `:*`
	LogDestination *string `pulumi:"logDestination"`
}

type StateMachineLoggingConfigurationArgs 

type StateMachineLoggingConfigurationArgs struct {
	// Determines whether execution data is included in your log. When set to `false`, data is excluded.
	IncludeExecutionData pulumi.BoolPtrInput `pulumi:"includeExecutionData"`
	// Defines which category of execution history events are logged. Valid values: `ALL`, `ERROR`, `FATAL`, `OFF`
	Level pulumi.StringPtrInput `pulumi:"level"`
	// Amazon Resource Name (ARN) of a CloudWatch log group. Make sure the State Machine has the correct IAM policies for logging. The ARN must end with `:*`
	LogDestination pulumi.StringPtrInput `pulumi:"logDestination"`
}

func (StateMachineLoggingConfigurationArgs) ElementType 

func (StateMachineLoggingConfigurationArgs) ElementType() reflect.Type

func (StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationOutput 

func (i StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationOutput() StateMachineLoggingConfigurationOutput

func (StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationOutputWithContext 

func (i StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationOutputWithContext(ctx context.Context) StateMachineLoggingConfigurationOutput

func (StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationPtrOutput 

func (i StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationPtrOutput() StateMachineLoggingConfigurationPtrOutput

func (StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationPtrOutputWithContext 

func (i StateMachineLoggingConfigurationArgs) ToStateMachineLoggingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineLoggingConfigurationPtrOutput

type StateMachineLoggingConfigurationInput 

type StateMachineLoggingConfigurationInput interface {
	pulumi.Input

	ToStateMachineLoggingConfigurationOutput() StateMachineLoggingConfigurationOutput
	ToStateMachineLoggingConfigurationOutputWithContext(context.Context) StateMachineLoggingConfigurationOutput
}

StateMachineLoggingConfigurationInput is an input type that accepts StateMachineLoggingConfigurationArgs and StateMachineLoggingConfigurationOutput values. You can construct a concrete instance of `StateMachineLoggingConfigurationInput` via: 

StateMachineLoggingConfigurationArgs{...}

type StateMachineLoggingConfigurationOutput 

type StateMachineLoggingConfigurationOutput struct{ *pulumi.OutputState }

func (StateMachineLoggingConfigurationOutput) ElementType 

func (StateMachineLoggingConfigurationOutput) ElementType() reflect.Type

func (StateMachineLoggingConfigurationOutput) IncludeExecutionData 

func (o StateMachineLoggingConfigurationOutput) IncludeExecutionData() pulumi.BoolPtrOutput

Determines whether execution data is included in your log. When set to `false`, data is excluded.

func (StateMachineLoggingConfigurationOutput) Level 

func (o StateMachineLoggingConfigurationOutput) Level() pulumi.StringPtrOutput

Defines which category of execution history events are logged. Valid values: `ALL`, `ERROR`, `FATAL`, `OFF`

func (StateMachineLoggingConfigurationOutput) LogDestination 

func (o StateMachineLoggingConfigurationOutput) LogDestination() pulumi.StringPtrOutput

Amazon Resource Name (ARN) of a CloudWatch log group. Make sure the State Machine has the correct IAM policies for logging. The ARN must end with `:*`

func (StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationOutput 

func (o StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationOutput() StateMachineLoggingConfigurationOutput

func (StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationOutputWithContext 

func (o StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationOutputWithContext(ctx context.Context) StateMachineLoggingConfigurationOutput

func (StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationPtrOutput 

func (o StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationPtrOutput() StateMachineLoggingConfigurationPtrOutput

func (StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationPtrOutputWithContext 

func (o StateMachineLoggingConfigurationOutput) ToStateMachineLoggingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineLoggingConfigurationPtrOutput

type StateMachineLoggingConfigurationPtrInput 

type StateMachineLoggingConfigurationPtrInput interface {
	pulumi.Input

	ToStateMachineLoggingConfigurationPtrOutput() StateMachineLoggingConfigurationPtrOutput
	ToStateMachineLoggingConfigurationPtrOutputWithContext(context.Context) StateMachineLoggingConfigurationPtrOutput
}

StateMachineLoggingConfigurationPtrInput is an input type that accepts StateMachineLoggingConfigurationArgs, StateMachineLoggingConfigurationPtr and StateMachineLoggingConfigurationPtrOutput values. You can construct a concrete instance of `StateMachineLoggingConfigurationPtrInput` via: 

        StateMachineLoggingConfigurationArgs{...}

or:

        nil

func StateMachineLoggingConfigurationPtr 

func StateMachineLoggingConfigurationPtr(v *StateMachineLoggingConfigurationArgs) StateMachineLoggingConfigurationPtrInput

type StateMachineLoggingConfigurationPtrOutput 

type StateMachineLoggingConfigurationPtrOutput struct{ *pulumi.OutputState }

func (StateMachineLoggingConfigurationPtrOutput) Elem 

func (o StateMachineLoggingConfigurationPtrOutput) Elem() StateMachineLoggingConfigurationOutput

func (StateMachineLoggingConfigurationPtrOutput) ElementType 

func (StateMachineLoggingConfigurationPtrOutput) ElementType() reflect.Type

func (StateMachineLoggingConfigurationPtrOutput) IncludeExecutionData 

func (o StateMachineLoggingConfigurationPtrOutput) IncludeExecutionData() pulumi.BoolPtrOutput

Determines whether execution data is included in your log. When set to `false`, data is excluded.

func (StateMachineLoggingConfigurationPtrOutput) Level 

func (o StateMachineLoggingConfigurationPtrOutput) Level() pulumi.StringPtrOutput

Defines which category of execution history events are logged. Valid values: `ALL`, `ERROR`, `FATAL`, `OFF`

func (StateMachineLoggingConfigurationPtrOutput) LogDestination 

func (o StateMachineLoggingConfigurationPtrOutput) LogDestination() pulumi.StringPtrOutput

Amazon Resource Name (ARN) of a CloudWatch log group. Make sure the State Machine has the correct IAM policies for logging. The ARN must end with `:*`

func (StateMachineLoggingConfigurationPtrOutput) ToStateMachineLoggingConfigurationPtrOutput 

func (o StateMachineLoggingConfigurationPtrOutput) ToStateMachineLoggingConfigurationPtrOutput() StateMachineLoggingConfigurationPtrOutput

func (StateMachineLoggingConfigurationPtrOutput) ToStateMachineLoggingConfigurationPtrOutputWithContext 

func (o StateMachineLoggingConfigurationPtrOutput) ToStateMachineLoggingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineLoggingConfigurationPtrOutput

type StateMachineMap 

type StateMachineMap map[string]StateMachineInput

func (StateMachineMap) ElementType 

func (StateMachineMap) ElementType() reflect.Type

func (StateMachineMap) ToStateMachineMapOutput 

func (i StateMachineMap) ToStateMachineMapOutput() StateMachineMapOutput

func (StateMachineMap) ToStateMachineMapOutputWithContext 

func (i StateMachineMap) ToStateMachineMapOutputWithContext(ctx context.Context) StateMachineMapOutput

type StateMachineMapInput 

type StateMachineMapInput interface {
	pulumi.Input

	ToStateMachineMapOutput() StateMachineMapOutput
	ToStateMachineMapOutputWithContext(context.Context) StateMachineMapOutput
}

StateMachineMapInput is an input type that accepts StateMachineMap and StateMachineMapOutput values. You can construct a concrete instance of `StateMachineMapInput` via: 

StateMachineMap{ "key": StateMachineArgs{...} }

type StateMachineMapOutput 

type StateMachineMapOutput struct{ *pulumi.OutputState }

func (StateMachineMapOutput) ElementType 

func (StateMachineMapOutput) ElementType() reflect.Type

func (StateMachineMapOutput) MapIndex 

func (o StateMachineMapOutput) MapIndex(k pulumi.StringInput) StateMachineOutput

func (StateMachineMapOutput) ToStateMachineMapOutput 

func (o StateMachineMapOutput) ToStateMachineMapOutput() StateMachineMapOutput

func (StateMachineMapOutput) ToStateMachineMapOutputWithContext 

func (o StateMachineMapOutput) ToStateMachineMapOutputWithContext(ctx context.Context) StateMachineMapOutput

type StateMachineOutput 

type StateMachineOutput struct{ *pulumi.OutputState }

func (StateMachineOutput) Arn added in v5.4.0 

func (o StateMachineOutput) Arn() pulumi.StringOutput

The ARN of the state machine.

func (StateMachineOutput) CreationDate added in v5.4.0 

func (o StateMachineOutput) CreationDate() pulumi.StringOutput

The date the state machine was created.

func (StateMachineOutput) Definition added in v5.4.0 

func (o StateMachineOutput) Definition() pulumi.StringOutput

The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine.

func (StateMachineOutput) ElementType 

func (StateMachineOutput) ElementType() reflect.Type

func (StateMachineOutput) LoggingConfiguration added in v5.4.0 

func (o StateMachineOutput) LoggingConfiguration() StateMachineLoggingConfigurationOutput

Defines what execution history events are logged and where they are logged. The `loggingConfiguration` parameter is only valid when `type` is set to `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html) and [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.

func (StateMachineOutput) Name added in v5.4.0 

func (o StateMachineOutput) Name() pulumi.StringOutput

The name of the state machine. The name should only contain `0`-`9`, `A`-`Z`, `a`-`z`, `-` and `_`. If omitted, the provider will assign a random, unique name.

func (StateMachineOutput) NamePrefix added in v5.20.0 

func (o StateMachineOutput) NamePrefix() pulumi.StringOutput

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

func (StateMachineOutput) RoleArn added in v5.4.0 

func (o StateMachineOutput) RoleArn() pulumi.StringOutput

The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

func (StateMachineOutput) Status added in v5.4.0 

func (o StateMachineOutput) Status() pulumi.StringOutput

The current status of the state machine. Either `ACTIVE` or `DELETING`.

func (StateMachineOutput) Tags added in v5.4.0 

func (o StateMachineOutput) 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 (StateMachineOutput) TagsAll added in v5.4.0 

func (o StateMachineOutput) TagsAll() pulumi.StringMapOutput

A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

func (StateMachineOutput) ToStateMachineOutput 

func (o StateMachineOutput) ToStateMachineOutput() StateMachineOutput

func (StateMachineOutput) ToStateMachineOutputWithContext 

func (o StateMachineOutput) ToStateMachineOutputWithContext(ctx context.Context) StateMachineOutput

func (StateMachineOutput) TracingConfiguration added in v5.4.0 

func (o StateMachineOutput) TracingConfiguration() StateMachineTracingConfigurationOutput

Selects whether AWS X-Ray tracing is enabled.

func (StateMachineOutput) Type added in v5.4.0 

func (o StateMachineOutput) Type() pulumi.StringPtrOutput

Determines whether a Standard or Express state machine is created. The default is `STANDARD`. You cannot update the type of a state machine once it has been created. Valid values: `STANDARD`, `EXPRESS`.

type StateMachineState 

type StateMachineState struct {
	// The ARN of the state machine.
	Arn pulumi.StringPtrInput
	// The date the state machine was created.
	CreationDate pulumi.StringPtrInput
	// The [Amazon States Language](https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html) definition of the state machine.
	Definition pulumi.StringPtrInput
	// Defines what execution history events are logged and where they are logged. The `loggingConfiguration` parameter is only valid when `type` is set to `EXPRESS`. Defaults to `OFF`. For more information see [Logging Express Workflows](https://docs.aws.amazon.com/step-functions/latest/dg/cw-logs.html) and [Log Levels](https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html) in the AWS Step Functions User Guide.
	LoggingConfiguration StateMachineLoggingConfigurationPtrInput
	// The name of the state machine. The name should only contain `0`-`9`, `A`-`Z`, `a`-`z`, `-` and `_`. If omitted, the 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
	// The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
	RoleArn pulumi.StringPtrInput
	// The current status of the state machine. Either `ACTIVE` or `DELETING`.
	Status 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
	// Selects whether AWS X-Ray tracing is enabled.
	TracingConfiguration StateMachineTracingConfigurationPtrInput
	// Determines whether a Standard or Express state machine is created. The default is `STANDARD`. You cannot update the type of a state machine once it has been created. Valid values: `STANDARD`, `EXPRESS`.
	Type pulumi.StringPtrInput
}

func (StateMachineState) ElementType 

func (StateMachineState) ElementType() reflect.Type

type StateMachineTracingConfiguration 

type StateMachineTracingConfiguration struct {
	// When set to `true`, AWS X-Ray tracing is enabled. Make sure the State Machine has the correct IAM policies for logging. See the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/xray-iam.html) for details.
	Enabled *bool `pulumi:"enabled"`
}

type StateMachineTracingConfigurationArgs 

type StateMachineTracingConfigurationArgs struct {
	// When set to `true`, AWS X-Ray tracing is enabled. Make sure the State Machine has the correct IAM policies for logging. See the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/xray-iam.html) for details.
	Enabled pulumi.BoolPtrInput `pulumi:"enabled"`
}

func (StateMachineTracingConfigurationArgs) ElementType 

func (StateMachineTracingConfigurationArgs) ElementType() reflect.Type

func (StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationOutput 

func (i StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationOutput() StateMachineTracingConfigurationOutput

func (StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationOutputWithContext 

func (i StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationOutputWithContext(ctx context.Context) StateMachineTracingConfigurationOutput

func (StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationPtrOutput 

func (i StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationPtrOutput() StateMachineTracingConfigurationPtrOutput

func (StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationPtrOutputWithContext 

func (i StateMachineTracingConfigurationArgs) ToStateMachineTracingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineTracingConfigurationPtrOutput

type StateMachineTracingConfigurationInput 

type StateMachineTracingConfigurationInput interface {
	pulumi.Input

	ToStateMachineTracingConfigurationOutput() StateMachineTracingConfigurationOutput
	ToStateMachineTracingConfigurationOutputWithContext(context.Context) StateMachineTracingConfigurationOutput
}

StateMachineTracingConfigurationInput is an input type that accepts StateMachineTracingConfigurationArgs and StateMachineTracingConfigurationOutput values. You can construct a concrete instance of `StateMachineTracingConfigurationInput` via: 

StateMachineTracingConfigurationArgs{...}

type StateMachineTracingConfigurationOutput 

type StateMachineTracingConfigurationOutput struct{ *pulumi.OutputState }

func (StateMachineTracingConfigurationOutput) ElementType 

func (StateMachineTracingConfigurationOutput) ElementType() reflect.Type

func (StateMachineTracingConfigurationOutput) Enabled 

func (o StateMachineTracingConfigurationOutput) Enabled() pulumi.BoolPtrOutput

When set to `true`, AWS X-Ray tracing is enabled. Make sure the State Machine has the correct IAM policies for logging. See the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/xray-iam.html) for details.

func (StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationOutput 

func (o StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationOutput() StateMachineTracingConfigurationOutput

func (StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationOutputWithContext 

func (o StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationOutputWithContext(ctx context.Context) StateMachineTracingConfigurationOutput

func (StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationPtrOutput 

func (o StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationPtrOutput() StateMachineTracingConfigurationPtrOutput

func (StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationPtrOutputWithContext 

func (o StateMachineTracingConfigurationOutput) ToStateMachineTracingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineTracingConfigurationPtrOutput

type StateMachineTracingConfigurationPtrInput 

type StateMachineTracingConfigurationPtrInput interface {
	pulumi.Input

	ToStateMachineTracingConfigurationPtrOutput() StateMachineTracingConfigurationPtrOutput
	ToStateMachineTracingConfigurationPtrOutputWithContext(context.Context) StateMachineTracingConfigurationPtrOutput
}

StateMachineTracingConfigurationPtrInput is an input type that accepts StateMachineTracingConfigurationArgs, StateMachineTracingConfigurationPtr and StateMachineTracingConfigurationPtrOutput values. You can construct a concrete instance of `StateMachineTracingConfigurationPtrInput` via: 

        StateMachineTracingConfigurationArgs{...}

or:

        nil

func StateMachineTracingConfigurationPtr 

func StateMachineTracingConfigurationPtr(v *StateMachineTracingConfigurationArgs) StateMachineTracingConfigurationPtrInput

type StateMachineTracingConfigurationPtrOutput 

type StateMachineTracingConfigurationPtrOutput struct{ *pulumi.OutputState }

func (StateMachineTracingConfigurationPtrOutput) Elem 

func (o StateMachineTracingConfigurationPtrOutput) Elem() StateMachineTracingConfigurationOutput

func (StateMachineTracingConfigurationPtrOutput) ElementType 

func (StateMachineTracingConfigurationPtrOutput) ElementType() reflect.Type

func (StateMachineTracingConfigurationPtrOutput) Enabled 

func (o StateMachineTracingConfigurationPtrOutput) Enabled() pulumi.BoolPtrOutput

When set to `true`, AWS X-Ray tracing is enabled. Make sure the State Machine has the correct IAM policies for logging. See the [AWS Step Functions Developer Guide](https://docs.aws.amazon.com/step-functions/latest/dg/xray-iam.html) for details.

func (StateMachineTracingConfigurationPtrOutput) ToStateMachineTracingConfigurationPtrOutput 

func (o StateMachineTracingConfigurationPtrOutput) ToStateMachineTracingConfigurationPtrOutput() StateMachineTracingConfigurationPtrOutput

func (StateMachineTracingConfigurationPtrOutput) ToStateMachineTracingConfigurationPtrOutputWithContext 

func (o StateMachineTracingConfigurationPtrOutput) ToStateMachineTracingConfigurationPtrOutputWithContext(ctx context.Context) StateMachineTracingConfigurationPtrOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.