AWS Native

Pulumi Official
Package maintained by Pulumi
v0.16.1 published on Saturday, Apr 30, 2022 by Pulumi

Workflow

Resource Type definition for AWS::Transfer::Workflow

Create a Workflow Resource

new Workflow(name: string, args: WorkflowArgs, opts?: CustomResourceOptions);
@overload
def Workflow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             description: Optional[str] = None,
             on_exception_steps: Optional[Sequence[WorkflowStepArgs]] = None,
             steps: Optional[Sequence[WorkflowStepArgs]] = None,
             tags: Optional[Sequence[WorkflowTagArgs]] = None)
@overload
def Workflow(resource_name: str,
             args: WorkflowArgs,
             opts: Optional[ResourceOptions] = None)
func NewWorkflow(ctx *Context, name string, args WorkflowArgs, opts ...ResourceOption) (*Workflow, error)
public Workflow(string name, WorkflowArgs args, CustomResourceOptions? opts = null)
public Workflow(String name, WorkflowArgs args)
public Workflow(String name, WorkflowArgs args, CustomResourceOptions options)
type: aws-native:transfer:Workflow
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args WorkflowArgs
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 WorkflowArgs
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 WorkflowArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WorkflowArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args WorkflowArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Workflow 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 Workflow resource accepts the following input properties:

Steps List<Pulumi.AwsNative.Transfer.Inputs.WorkflowStepArgs>

Specifies the details for the steps that are in the specified workflow.

Description string

A textual description for the workflow.

OnExceptionSteps List<Pulumi.AwsNative.Transfer.Inputs.WorkflowStepArgs>

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

Tags List<Pulumi.AwsNative.Transfer.Inputs.WorkflowTagArgs>

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Steps []WorkflowStepArgs

Specifies the details for the steps that are in the specified workflow.

Description string

A textual description for the workflow.

OnExceptionSteps []WorkflowStepArgs

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

Tags []WorkflowTagArgs

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

steps ListStepArgs>

Specifies the details for the steps that are in the specified workflow.

description String

A textual description for the workflow.

onExceptionSteps ListStepArgs>

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

tags ListTagArgs>

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

steps WorkflowStepArgs[]

Specifies the details for the steps that are in the specified workflow.

description string

A textual description for the workflow.

onExceptionSteps WorkflowStepArgs[]

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

tags WorkflowTagArgs[]

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

steps Sequence[WorkflowStepArgs]

Specifies the details for the steps that are in the specified workflow.

description str

A textual description for the workflow.

on_exception_steps Sequence[WorkflowStepArgs]

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

tags Sequence[WorkflowTagArgs]

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

steps List

Specifies the details for the steps that are in the specified workflow.

description String

A textual description for the workflow.

onExceptionSteps List

Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.

tags List

Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.

Outputs

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

Arn string

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Id string

The provider-assigned unique ID for this managed resource.

WorkflowId string

A unique identifier for the workflow.

Arn string

Specifies the unique Amazon Resource Name (ARN) for the workflow.

Id string

The provider-assigned unique ID for this managed resource.

WorkflowId string

A unique identifier for the workflow.

arn String

Specifies the unique Amazon Resource Name (ARN) for the workflow.

id String

The provider-assigned unique ID for this managed resource.

workflowId String

A unique identifier for the workflow.

arn string

Specifies the unique Amazon Resource Name (ARN) for the workflow.

id string

The provider-assigned unique ID for this managed resource.

workflowId string

A unique identifier for the workflow.

arn str

Specifies the unique Amazon Resource Name (ARN) for the workflow.

id str

The provider-assigned unique ID for this managed resource.

workflow_id str

A unique identifier for the workflow.

arn String

Specifies the unique Amazon Resource Name (ARN) for the workflow.

id String

The provider-assigned unique ID for this managed resource.

workflowId String

A unique identifier for the workflow.

Supporting Types

WorkflowInputFileLocation

WorkflowS3InputFileLocation

Bucket string

Specifies the S3 bucket that contains the file being copied.

Key string

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

Bucket string

Specifies the S3 bucket that contains the file being copied.

Key string

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

bucket String

Specifies the S3 bucket that contains the file being copied.

key String

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

bucket string

Specifies the S3 bucket that contains the file being copied.

key string

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

bucket str

Specifies the S3 bucket that contains the file being copied.

key str

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

bucket String

Specifies the S3 bucket that contains the file being copied.

key String

The name assigned to the file when it was created in S3. You use the object key to retrieve the object.

WorkflowS3Tag

Key string

The name assigned to the tag that you create.

Value string

The value that corresponds to the key.

Key string

The name assigned to the tag that you create.

Value string

The value that corresponds to the key.

key String

The name assigned to the tag that you create.

value String

The value that corresponds to the key.

key string

The name assigned to the tag that you create.

value string

The value that corresponds to the key.

key str

The name assigned to the tag that you create.

value str

The value that corresponds to the key.

key String

The name assigned to the tag that you create.

value String

The value that corresponds to the key.

WorkflowStep

CopyStepDetails WorkflowStepCopyStepDetailsProperties

Details for a step that performs a file copy.

CustomStepDetails WorkflowStepCustomStepDetailsProperties

Details for a step that invokes a lambda function.

DeleteStepDetails WorkflowStepDeleteStepDetailsProperties

Details for a step that deletes the file.

TagStepDetails WorkflowStepTagStepDetailsProperties

Details for a step that creates one or more tags.

Type WorkflowStepType
copyStepDetails WorkflowStepCopyStepDetailsProperties

Details for a step that performs a file copy.

customStepDetails WorkflowStepCustomStepDetailsProperties

Details for a step that invokes a lambda function.

deleteStepDetails WorkflowStepDeleteStepDetailsProperties

Details for a step that deletes the file.

tagStepDetails WorkflowStepTagStepDetailsProperties

Details for a step that creates one or more tags.

type WorkflowStepType
copyStepDetails WorkflowStepCopyStepDetailsProperties

Details for a step that performs a file copy.

customStepDetails WorkflowStepCustomStepDetailsProperties

Details for a step that invokes a lambda function.

deleteStepDetails WorkflowStepDeleteStepDetailsProperties

Details for a step that deletes the file.

tagStepDetails WorkflowStepTagStepDetailsProperties

Details for a step that creates one or more tags.

type WorkflowStepType
copy_step_details WorkflowStepCopyStepDetailsProperties

Details for a step that performs a file copy.

custom_step_details WorkflowStepCustomStepDetailsProperties

Details for a step that invokes a lambda function.

delete_step_details WorkflowStepDeleteStepDetailsProperties

Details for a step that deletes the file.

tag_step_details WorkflowStepTagStepDetailsProperties

Details for a step that creates one or more tags.

type WorkflowStepType
copyStepDetails Property Map

Details for a step that performs a file copy.

customStepDetails Property Map

Details for a step that invokes a lambda function.

deleteStepDetails Property Map

Details for a step that deletes the file.

tagStepDetails Property Map

Details for a step that creates one or more tags.

type "COPY" | "CUSTOM" | "DELETE" | "TAG"

WorkflowStepCopyStepDetailsProperties

DestinationFileLocation Pulumi.AwsNative.Transfer.Inputs.WorkflowInputFileLocation
Name string

The name of the step, used as an identifier.

OverwriteExisting Pulumi.AwsNative.Transfer.WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

DestinationFileLocation WorkflowInputFileLocation
Name string

The name of the step, used as an identifier.

OverwriteExisting WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

destinationFileLocation WorkflowInputFileLocation
name String

The name of the step, used as an identifier.

overwriteExisting WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

destinationFileLocation WorkflowInputFileLocation
name string

The name of the step, used as an identifier.

overwriteExisting WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

sourceFileLocation string

Specifies which file to use as input to the workflow step.

destination_file_location WorkflowInputFileLocation
name str

The name of the step, used as an identifier.

overwrite_existing WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

source_file_location str

Specifies which file to use as input to the workflow step.

destinationFileLocation Property Map
name String

The name of the step, used as an identifier.

overwriteExisting "TRUE" | "FALSE"

A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

WorkflowStepCopyStepDetailsPropertiesOverwriteExisting

True
TRUE
False
FALSE
WorkflowStepCopyStepDetailsPropertiesOverwriteExistingTrue
TRUE
WorkflowStepCopyStepDetailsPropertiesOverwriteExistingFalse
FALSE
True
TRUE
False
FALSE
True
TRUE
False
FALSE
TRUE
TRUE
FALSE
FALSE
"TRUE"
TRUE
"FALSE"
FALSE

WorkflowStepCustomStepDetailsProperties

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

Target string

The ARN for the lambda function that is being called.

TimeoutSeconds int

Timeout, in seconds, for the step.

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

Target string

The ARN for the lambda function that is being called.

TimeoutSeconds int

Timeout, in seconds, for the step.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

target String

The ARN for the lambda function that is being called.

timeoutSeconds Integer

Timeout, in seconds, for the step.

name string

The name of the step, used as an identifier.

sourceFileLocation string

Specifies which file to use as input to the workflow step.

target string

The ARN for the lambda function that is being called.

timeoutSeconds number

Timeout, in seconds, for the step.

name str

The name of the step, used as an identifier.

source_file_location str

Specifies which file to use as input to the workflow step.

target str

The ARN for the lambda function that is being called.

timeout_seconds int

Timeout, in seconds, for the step.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

target String

The ARN for the lambda function that is being called.

timeoutSeconds Number

Timeout, in seconds, for the step.

WorkflowStepDeleteStepDetailsProperties

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

name string

The name of the step, used as an identifier.

sourceFileLocation string

Specifies which file to use as input to the workflow step.

name str

The name of the step, used as an identifier.

source_file_location str

Specifies which file to use as input to the workflow step.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

WorkflowStepTagStepDetailsProperties

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

Tags List<Pulumi.AwsNative.Transfer.Inputs.WorkflowS3Tag>

Array that contains from 1 to 10 key/value pairs.

Name string

The name of the step, used as an identifier.

SourceFileLocation string

Specifies which file to use as input to the workflow step.

Tags []WorkflowS3Tag

Array that contains from 1 to 10 key/value pairs.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

tags ListS3Tag>

Array that contains from 1 to 10 key/value pairs.

name string

The name of the step, used as an identifier.

sourceFileLocation string

Specifies which file to use as input to the workflow step.

tags WorkflowS3Tag[]

Array that contains from 1 to 10 key/value pairs.

name str

The name of the step, used as an identifier.

source_file_location str

Specifies which file to use as input to the workflow step.

tags Sequence[WorkflowS3Tag]

Array that contains from 1 to 10 key/value pairs.

name String

The name of the step, used as an identifier.

sourceFileLocation String

Specifies which file to use as input to the workflow step.

tags List

Array that contains from 1 to 10 key/value pairs.

WorkflowStepType

Copy
COPY
Custom
CUSTOM
Delete
DELETE
Tag
TAG
WorkflowStepTypeCopy
COPY
WorkflowStepTypeCustom
CUSTOM
WorkflowStepTypeDelete
DELETE
WorkflowStepTypeTag
TAG
Copy
COPY
Custom
CUSTOM
Delete
DELETE
Tag
TAG
Copy
COPY
Custom
CUSTOM
Delete
DELETE
Tag
TAG
COPY
COPY
CUSTOM
CUSTOM
DELETE
DELETE
TAG
TAG
"COPY"
COPY
"CUSTOM"
CUSTOM
"DELETE"
DELETE
"TAG"
TAG

WorkflowTag

Key string

The name assigned to the tag that you create.

Value string

Contains one or more values that you assigned to the key name you create.

Key string

The name assigned to the tag that you create.

Value string

Contains one or more values that you assigned to the key name you create.

key String

The name assigned to the tag that you create.

value String

Contains one or more values that you assigned to the key name you create.

key string

The name assigned to the tag that you create.

value string

Contains one or more values that you assigned to the key name you create.

key str

The name assigned to the tag that you create.

value str

Contains one or more values that you assigned to the key name you create.

key String

The name assigned to the tag that you create.

value String

Contains one or more values that you assigned to the key name you create.

Package Details

Repository
https://github.com/pulumi/pulumi-aws-native
License
Apache-2.0