sfn

package
v3.18.0 Latest Latest
Warning

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

 Go to latest Published: Dec 4, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

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
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides a Step Function Activity resource

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v2/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 added in v3.13.0 

func (Activity) ElementType() reflect.Type

func (Activity) ToActivityOutput added in v3.13.0 

func (i Activity) ToActivityOutput() ActivityOutput

func (Activity) ToActivityOutputWithContext added in v3.13.0 

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
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a Activity resource.

func (ActivityArgs) ElementType 

func (ActivityArgs) ElementType() reflect.Type

type ActivityInput added in v3.13.0 

type ActivityInput interface {
	pulumi.Input

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

type ActivityOutput added in v3.13.0 

type ActivityOutput struct {
	*pulumi.OutputState
}

func (ActivityOutput) ElementType added in v3.13.0 

func (ActivityOutput) ElementType() reflect.Type

func (ActivityOutput) ToActivityOutput added in v3.13.0 

func (o ActivityOutput) ToActivityOutput() ActivityOutput

func (ActivityOutput) ToActivityOutputWithContext added in v3.13.0 

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
	Tags pulumi.StringMapInput
}

func (ActivityState) ElementType 

func (ActivityState) ElementType() reflect.Type

type LookupActivityArgs 

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

A collection of arguments for invoking getActivity.

type LookupActivityResult 

type LookupActivityResult struct {
	Arn string `pulumi:"arn"`
	// The 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/v3/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"

) 

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

```

type LookupStateMachineArgs 

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

A collection of arguments for invoking getStateMachine.

type LookupStateMachineResult 

type LookupStateMachineResult struct {
	// Set to the arn of the state function.
	Arn string `pulumi:"arn"`
	// The 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/v3/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v2/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 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 definition of the state machine.
	Definition pulumi.StringOutput `pulumi:"definition"`
	// The name of the state machine.
	Name pulumi.StringOutput `pulumi:"name"`
	// 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
	Tags pulumi.StringMapOutput `pulumi:"tags"`
}

Provides a Step Function State Machine resource

## Example Usage

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-aws/sdk/v3/go/aws/sfn"
"github.com/pulumi/pulumi/sdk/v2/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("%v%v%v%v%v%v%v%v%v%v%v%v%v", "{\n", "  \"Comment\": \"A Hello World example of the Amazon States Language using an AWS Lambda Function\",\n", "  \"StartAt\": \"HelloWorld\",\n", "  \"States\": {\n", "    \"HelloWorld\": {\n", "      \"Type\": \"Task\",\n", "      \"Resource\": \"", aws_lambda_function.Lambda.Arn, "\",\n", "      \"End\": true\n", "    }\n", "  }\n", "}\n")),
		})
		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 added in v3.13.0 

func (StateMachine) ElementType() reflect.Type

func (StateMachine) ToStateMachineOutput added in v3.13.0 

func (i StateMachine) ToStateMachineOutput() StateMachineOutput

func (StateMachine) ToStateMachineOutputWithContext added in v3.13.0 

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

type StateMachineArgs 

type StateMachineArgs struct {
	// The Amazon States Language definition of the state machine.
	Definition pulumi.StringInput
	// The name of the state machine.
	Name 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
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a StateMachine resource.

func (StateMachineArgs) ElementType 

func (StateMachineArgs) ElementType() reflect.Type

type StateMachineInput added in v3.13.0 

type StateMachineInput interface {
	pulumi.Input

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

type StateMachineOutput added in v3.13.0 

type StateMachineOutput struct {
	*pulumi.OutputState
}

func (StateMachineOutput) ElementType added in v3.13.0 

func (StateMachineOutput) ElementType() reflect.Type

func (StateMachineOutput) ToStateMachineOutput added in v3.13.0 

func (o StateMachineOutput) ToStateMachineOutput() StateMachineOutput

func (StateMachineOutput) ToStateMachineOutputWithContext added in v3.13.0 

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

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 definition of the state machine.
	Definition pulumi.StringPtrInput
	// The name of the state machine.
	Name 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
	Tags pulumi.StringMapInput
}

func (StateMachineState) ElementType 

func (StateMachineState) ElementType() reflect.Type

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.