AWS Native
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.
Aws Native. Transfer. Inputs. Workflow Step Args> Specifies the details for the steps that are in the specified workflow.
- Description string
A textual description for the workflow.
- On
Exception List<Pulumi.Steps Aws Native. Transfer. Inputs. Workflow Step Args> Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- List<Pulumi.
Aws Native. Transfer. Inputs. Workflow Tag Args> Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- Steps
[]Workflow
Step Args Specifies the details for the steps that are in the specified workflow.
- Description string
A textual description for the workflow.
- On
Exception []WorkflowSteps Step Args Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- []Workflow
Tag Args Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
List
Step Args> Specifies the details for the steps that are in the specified workflow.
- description String
A textual description for the workflow.
- on
Exception ListSteps Step Args> Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- List
Tag Args> Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
Workflow
Step Args[] Specifies the details for the steps that are in the specified workflow.
- description string
A textual description for the workflow.
- on
Exception WorkflowSteps Step Args[] Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- Workflow
Tag Args[] Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
Sequence[Workflow
Step Args] Specifies the details for the steps that are in the specified workflow.
- description str
A textual description for the workflow.
- on_
exception_ Sequence[Workflowsteps Step Args] Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- Sequence[Workflow
Tag Args] 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.
- on
Exception ListSteps Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- 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.
- Workflow
Id 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.
- Workflow
Id 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.
- workflow
Id 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.
- workflow
Id 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.
- workflow
Id String A unique identifier for the workflow.
Supporting Types
WorkflowInputFileLocation
WorkflowS3InputFileLocation
WorkflowS3Tag
WorkflowStep
- Copy
Step Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Copy Step Details Properties Details for a step that performs a file copy.
- Custom
Step Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Custom Step Details Properties Details for a step that invokes a lambda function.
- Delete
Step Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Delete Step Details Properties Details for a step that deletes the file.
- Pulumi.
Aws Native. Transfer. Inputs. Workflow Step Tag Step Details Properties Details for a step that creates one or more tags.
- Type
Pulumi.
Aws Native. Transfer. Workflow Step Type
- Copy
Step WorkflowDetails Step Copy Step Details Properties Details for a step that performs a file copy.
- Custom
Step WorkflowDetails Step Custom Step Details Properties Details for a step that invokes a lambda function.
- Delete
Step WorkflowDetails Step Delete Step Details Properties Details for a step that deletes the file.
- Workflow
Step Tag Step Details Properties Details for a step that creates one or more tags.
- Type
Workflow
Step Type
- copy
Step WorkflowDetails Step Copy Step Details Properties Details for a step that performs a file copy.
- custom
Step WorkflowDetails Step Custom Step Details Properties Details for a step that invokes a lambda function.
- delete
Step WorkflowDetails Step Delete Step Details Properties Details for a step that deletes the file.
- Workflow
Step Tag Step Details Properties Details for a step that creates one or more tags.
- type
Workflow
Step Type
- copy
Step WorkflowDetails Step Copy Step Details Properties Details for a step that performs a file copy.
- custom
Step WorkflowDetails Step Custom Step Details Properties Details for a step that invokes a lambda function.
- delete
Step WorkflowDetails Step Delete Step Details Properties Details for a step that deletes the file.
- Workflow
Step Tag Step Details Properties Details for a step that creates one or more tags.
- type
Workflow
Step Type
- copy_
step_ Workflowdetails Step Copy Step Details Properties Details for a step that performs a file copy.
- custom_
step_ Workflowdetails Step Custom Step Details Properties Details for a step that invokes a lambda function.
- delete_
step_ Workflowdetails Step Delete Step Details Properties Details for a step that deletes the file.
- tag_
step_ Workflowdetails Step Tag Step Details Properties Details for a step that creates one or more tags.
- type
Workflow
Step Type
- copy
Step Property MapDetails Details for a step that performs a file copy.
- custom
Step Property MapDetails Details for a step that invokes a lambda function.
- delete
Step Property MapDetails Details for a step that deletes the file.
- Property Map
Details for a step that creates one or more tags.
- type "COPY" | "CUSTOM" | "DELETE" | "TAG"
WorkflowStepCopyStepDetailsProperties
- Destination
File Pulumi.Location Aws Native. Transfer. Inputs. Workflow Input File Location - Name string
The name of the step, used as an identifier.
- Overwrite
Existing Pulumi.Aws Native. Transfer. Workflow Step Copy Step Details Properties Overwrite Existing A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- Destination
File WorkflowLocation Input File Location - Name string
The name of the step, used as an identifier.
- Overwrite
Existing WorkflowStep Copy Step Details Properties Overwrite Existing A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- destination
File WorkflowLocation Input File Location - name String
The name of the step, used as an identifier.
- overwrite
Existing WorkflowStep Copy Step Details Properties Overwrite Existing A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- destination
File WorkflowLocation Input File Location - name string
The name of the step, used as an identifier.
- overwrite
Existing WorkflowStep Copy Step Details Properties Overwrite Existing A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- source
File stringLocation Specifies which file to use as input to the workflow step.
- destination_
file_ Workflowlocation Input File Location - name str
The name of the step, used as an identifier.
- overwrite_
existing WorkflowStep Copy Step Details Properties Overwrite Existing A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- source_
file_ strlocation Specifies which file to use as input to the workflow step.
- destination
File Property MapLocation - name String
The name of the step, used as an identifier.
- overwrite
Existing "TRUE" | "FALSE" A flag that indicates whether or not to overwrite an existing file of the same name. The default is FALSE.
- source
File StringLocation Specifies which file to use as input to the workflow step.
WorkflowStepCopyStepDetailsPropertiesOverwriteExisting
- True
- TRUE
- False
- FALSE
- Workflow
Step Copy Step Details Properties Overwrite Existing True - TRUE
- Workflow
Step Copy Step Details Properties Overwrite Existing False - 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.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- Target string
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.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- Target string
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.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- target String
The ARN for the lambda function that is being called.
- timeout
Seconds Integer Timeout, in seconds, for the step.
- name string
The name of the step, used as an identifier.
- source
File stringLocation Specifies which file to use as input to the workflow step.
- target string
The ARN for the lambda function that is being called.
- timeout
Seconds number Timeout, in seconds, for the step.
- name str
The name of the step, used as an identifier.
- source_
file_ strlocation 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.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- target String
The ARN for the lambda function that is being called.
- timeout
Seconds Number Timeout, in seconds, for the step.
WorkflowStepDeleteStepDetailsProperties
- Name string
The name of the step, used as an identifier.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- Name string
The name of the step, used as an identifier.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- name String
The name of the step, used as an identifier.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- name string
The name of the step, used as an identifier.
- source
File stringLocation Specifies which file to use as input to the workflow step.
- name str
The name of the step, used as an identifier.
- source_
file_ strlocation Specifies which file to use as input to the workflow step.
- name String
The name of the step, used as an identifier.
- source
File StringLocation Specifies which file to use as input to the workflow step.
WorkflowStepTagStepDetailsProperties
- Name string
The name of the step, used as an identifier.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- List<Pulumi.
Aws Native. Transfer. Inputs. Workflow S3Tag> Array that contains from 1 to 10 key/value pairs.
- Name string
The name of the step, used as an identifier.
- Source
File stringLocation Specifies which file to use as input to the workflow step.
- []Workflow
S3Tag Array that contains from 1 to 10 key/value pairs.
- name String
The name of the step, used as an identifier.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- List
S3Tag> Array that contains from 1 to 10 key/value pairs.
- name string
The name of the step, used as an identifier.
- source
File stringLocation Specifies which file to use as input to the workflow step.
- Workflow
S3Tag[] Array that contains from 1 to 10 key/value pairs.
- name str
The name of the step, used as an identifier.
- source_
file_ strlocation Specifies which file to use as input to the workflow step.
- Sequence[Workflow
S3Tag] Array that contains from 1 to 10 key/value pairs.
- name String
The name of the step, used as an identifier.
- source
File StringLocation Specifies which file to use as input to the workflow step.
- List
Array that contains from 1 to 10 key/value pairs.
WorkflowStepType
- Copy
- COPY
- Custom
- CUSTOM
- Delete
- DELETE
- Tag
- TAG
- Workflow
Step Type Copy - COPY
- Workflow
Step Type Custom - CUSTOM
- Workflow
Step Type Delete - DELETE
- Workflow
Step Type 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
- "COPY"
- COPY
- "CUSTOM"
- CUSTOM
- "DELETE"
- DELETE
- "TAG"
- TAG
WorkflowTag
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws-native
- License
- Apache-2.0