We recommend new projects start with resources from the AWS provider.
aws-native.transfer.Workflow
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Transfer::Workflow
Create Workflow Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Workflow(name: string, args: WorkflowArgs, opts?: CustomResourceOptions);@overload
def Workflow(resource_name: str,
             args: WorkflowArgs,
             opts: Optional[ResourceOptions] = None)
@overload
def Workflow(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             steps: Optional[Sequence[WorkflowStepArgs]] = None,
             description: Optional[str] = None,
             on_exception_steps: Optional[Sequence[WorkflowStepArgs]] = None,
             tags: Optional[Sequence[_root_inputs.TagArgs]] = 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.
Parameters
- 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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Workflow resource accepts the following input properties:
- Steps
List<Pulumi.Aws Native. Transfer. Inputs. Workflow Step> 
- Specifies the details for the steps that are in the specified workflow.
- Description string
- A textual description for the workflow.
- OnException List<Pulumi.Steps Aws Native. Transfer. Inputs. Workflow Step> 
- Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- 
List<Pulumi.Aws Native. Inputs. Tag> 
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- Steps
[]WorkflowStep Args 
- Specifies the details for the steps that are in the specified workflow.
- Description string
- A textual description for the workflow.
- OnException []WorkflowSteps Step Args 
- Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- 
TagArgs 
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
List<WorkflowStep> 
- Specifies the details for the steps that are in the specified workflow.
- description String
- A textual description for the workflow.
- onException List<WorkflowSteps Step> 
- Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- List<Tag>
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
WorkflowStep[] 
- Specifies the details for the steps that are in the specified workflow.
- description string
- A textual description for the workflow.
- onException WorkflowSteps Step[] 
- Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- Tag[]
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps
Sequence[WorkflowStep 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[TagArgs] 
- Key-value pairs that can be used to group and search for workflows. Tags are metadata attached to workflows for any purpose.
- steps List<Property Map>
- Specifies the details for the steps that are in the specified workflow.
- description String
- A textual description for the workflow.
- onException List<Property Map>Steps 
- Specifies the steps (actions) to take if any errors are encountered during execution of the workflow.
- List<Property Map>
- 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
Tag, TagArgs  
WorkflowEfsInputFileLocation, WorkflowEfsInputFileLocationArgs          
- FileSystem stringId 
- Specifies the EFS filesystem that contains the file.
- Path string
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
- FileSystem stringId 
- Specifies the EFS filesystem that contains the file.
- Path string
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
- fileSystem StringId 
- Specifies the EFS filesystem that contains the file.
- path String
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
- fileSystem stringId 
- Specifies the EFS filesystem that contains the file.
- path string
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
- file_system_ strid 
- Specifies the EFS filesystem that contains the file.
- path str
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
- fileSystem StringId 
- Specifies the EFS filesystem that contains the file.
- path String
- The name assigned to the file when it was created in EFS. You use the object path to retrieve the object.
WorkflowInputFileLocation, WorkflowInputFileLocationArgs        
WorkflowS3FileLocation, WorkflowS3FileLocationArgs      
- S3FileLocation Pulumi.Aws Native. Transfer. Inputs. Workflow S3Input File Location 
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
- S3FileLocation WorkflowS3Input File Location 
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
- s3FileLocation WorkflowS3Input File Location 
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
- s3FileLocation WorkflowS3Input File Location 
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
- s3_file_ Workflowlocation S3Input File Location 
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
- s3FileLocation Property Map
- Specifies the details for the file location for the file that's being used in the workflow. Only applicable if you are using Amazon S3 storage.
WorkflowS3InputFileLocation, WorkflowS3InputFileLocationArgs        
WorkflowS3Tag, WorkflowS3TagArgs    
WorkflowStep, WorkflowStepArgs    
- CopyStep Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Copy Step Details Properties 
- Details for a step that performs a file copy.
- CustomStep Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Custom Step Details Properties 
- Details for a step that invokes a lambda function.
- DecryptStep Pulumi.Details Aws Native. Transfer. Inputs. Workflow Step Decrypt Step Details Properties 
- Details for a step that performs a file decryption.
- DeleteStep 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 
- CopyStep WorkflowDetails Step Copy Step Details Properties 
- Details for a step that performs a file copy.
- CustomStep WorkflowDetails Step Custom Step Details Properties 
- Details for a step that invokes a lambda function.
- DecryptStep WorkflowDetails Step Decrypt Step Details Properties 
- Details for a step that performs a file decryption.
- DeleteStep WorkflowDetails Step Delete Step Details Properties 
- Details for a step that deletes the file.
- 
WorkflowStep Tag Step Details Properties 
- Details for a step that creates one or more tags.
- Type
WorkflowStep Type 
- copyStep WorkflowDetails Step Copy Step Details Properties 
- Details for a step that performs a file copy.
- customStep WorkflowDetails Step Custom Step Details Properties 
- Details for a step that invokes a lambda function.
- decryptStep WorkflowDetails Step Decrypt Step Details Properties 
- Details for a step that performs a file decryption.
- deleteStep WorkflowDetails Step Delete Step Details Properties 
- Details for a step that deletes the file.
- 
WorkflowStep Tag Step Details Properties 
- Details for a step that creates one or more tags.
- type
WorkflowStep Type 
- copyStep WorkflowDetails Step Copy Step Details Properties 
- Details for a step that performs a file copy.
- customStep WorkflowDetails Step Custom Step Details Properties 
- Details for a step that invokes a lambda function.
- decryptStep WorkflowDetails Step Decrypt Step Details Properties 
- Details for a step that performs a file decryption.
- deleteStep WorkflowDetails Step Delete Step Details Properties 
- Details for a step that deletes the file.
- 
WorkflowStep Tag Step Details Properties 
- Details for a step that creates one or more tags.
- type
WorkflowStep 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.
- decrypt_step_ Workflowdetails Step Decrypt Step Details Properties 
- Details for a step that performs a file decryption.
- 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
WorkflowStep Type 
- copyStep Property MapDetails 
- Details for a step that performs a file copy.
- customStep Property MapDetails 
- Details for a step that invokes a lambda function.
- decryptStep Property MapDetails 
- Details for a step that performs a file decryption.
- deleteStep 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" | "DECRYPT" | "DELETE" | "TAG"
WorkflowStepCopyStepDetailsProperties, WorkflowStepCopyStepDetailsPropertiesArgs            
- DestinationFile Pulumi.Location Aws Native. Transfer. Inputs. Workflow S3File Location 
- Name string
- The name of the step, used as an identifier.
- OverwriteExisting 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.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- DestinationFile WorkflowLocation S3File Location 
- Name string
- The name of the step, used as an identifier.
- OverwriteExisting 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.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- destinationFile WorkflowLocation S3File Location 
- name String
- The name of the step, used as an identifier.
- overwriteExisting 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.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
- destinationFile WorkflowLocation S3File Location 
- name string
- The name of the step, used as an identifier.
- overwriteExisting 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.
- sourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- destination_file_ Workflowlocation S3File 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.
- destinationFile Property MapLocation 
- 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.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
WorkflowStepCopyStepDetailsPropertiesOverwriteExisting, WorkflowStepCopyStepDetailsPropertiesOverwriteExistingArgs                
- True
- TRUE
- False
- FALSE
- WorkflowStep Copy Step Details Properties Overwrite Existing True 
- TRUE
- WorkflowStep 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, WorkflowStepCustomStepDetailsPropertiesArgs            
- Name string
- The name of the step, used as an identifier.
- SourceFile stringLocation 
- 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.
- SourceFile stringLocation 
- 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.
- sourceFile StringLocation 
- 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.
- sourceFile stringLocation 
- 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_ 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.
- sourceFile StringLocation 
- 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.
WorkflowStepDecryptStepDetailsProperties, WorkflowStepDecryptStepDetailsPropertiesArgs            
- DestinationFile Pulumi.Location Aws Native. Transfer. Inputs. Workflow Input File Location 
- Type
Pulumi.Aws Native. Transfer. Workflow Step Decrypt Step Details Properties Type 
- Specifies which encryption method to use.
- Name string
- The name of the step, used as an identifier.
- OverwriteExisting Pulumi.Aws Native. Transfer. Workflow Step Decrypt 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.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- DestinationFile WorkflowLocation Input File Location 
- Type
WorkflowStep Decrypt Step Details Properties Type 
- Specifies which encryption method to use.
- Name string
- The name of the step, used as an identifier.
- OverwriteExisting WorkflowStep Decrypt 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.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- destinationFile WorkflowLocation Input File Location 
- type
WorkflowStep Decrypt Step Details Properties Type 
- Specifies which encryption method to use.
- name String
- The name of the step, used as an identifier.
- overwriteExisting WorkflowStep Decrypt 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.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
- destinationFile WorkflowLocation Input File Location 
- type
WorkflowStep Decrypt Step Details Properties Type 
- Specifies which encryption method to use.
- name string
- The name of the step, used as an identifier.
- overwriteExisting WorkflowStep Decrypt 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.
- sourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- destination_file_ Workflowlocation Input File Location 
- type
WorkflowStep Decrypt Step Details Properties Type 
- Specifies which encryption method to use.
- name str
- The name of the step, used as an identifier.
- overwrite_existing WorkflowStep Decrypt 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.
- destinationFile Property MapLocation 
- type "PGP"
- Specifies which encryption method to use.
- 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.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
WorkflowStepDecryptStepDetailsPropertiesOverwriteExisting, WorkflowStepDecryptStepDetailsPropertiesOverwriteExistingArgs                
- True
- TRUE
- False
- FALSE
- WorkflowStep Decrypt Step Details Properties Overwrite Existing True 
- TRUE
- WorkflowStep Decrypt Step Details Properties Overwrite Existing False 
- FALSE
- True
- TRUE
- False
- FALSE
- True
- TRUE
- False
- FALSE
- TRUE
- TRUE
- FALSE
- FALSE
- "TRUE"
- TRUE
- "FALSE"
- FALSE
WorkflowStepDecryptStepDetailsPropertiesType, WorkflowStepDecryptStepDetailsPropertiesTypeArgs              
- Pgp
- PGP
- WorkflowStep Decrypt Step Details Properties Type Pgp 
- PGP
- Pgp
- PGP
- Pgp
- PGP
- PGP
- PGP
- "PGP"
- PGP
WorkflowStepDeleteStepDetailsProperties, WorkflowStepDeleteStepDetailsPropertiesArgs            
- Name string
- The name of the step, used as an identifier.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- Name string
- The name of the step, used as an identifier.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- name String
- The name of the step, used as an identifier.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
- name string
- The name of the step, used as an identifier.
- sourceFile 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.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
WorkflowStepTagStepDetailsProperties, WorkflowStepTagStepDetailsPropertiesArgs            
- Name string
- The name of the step, used as an identifier.
- SourceFile 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.
- SourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- 
[]WorkflowS3Tag 
- Array that contains from 1 to 10 key/value pairs.
- name String
- The name of the step, used as an identifier.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
- 
List<WorkflowS3Tag> 
- Array that contains from 1 to 10 key/value pairs.
- name string
- The name of the step, used as an identifier.
- sourceFile stringLocation 
- Specifies which file to use as input to the workflow step.
- 
WorkflowS3Tag[] 
- 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[WorkflowS3Tag] 
- Array that contains from 1 to 10 key/value pairs.
- name String
- The name of the step, used as an identifier.
- sourceFile StringLocation 
- Specifies which file to use as input to the workflow step.
- List<Property Map>
- Array that contains from 1 to 10 key/value pairs.
WorkflowStepType, WorkflowStepTypeArgs      
- Copy
- COPY
- Custom
- CUSTOM
- Decrypt
- DECRYPT
- Delete
- DELETE
- Tag
- TAG
- WorkflowStep Type Copy 
- COPY
- WorkflowStep Type Custom 
- CUSTOM
- WorkflowStep Type Decrypt 
- DECRYPT
- WorkflowStep Type Delete 
- DELETE
- WorkflowStep Type Tag 
- TAG
- Copy
- COPY
- Custom
- CUSTOM
- Decrypt
- DECRYPT
- Delete
- DELETE
- Tag
- TAG
- Copy
- COPY
- Custom
- CUSTOM
- Decrypt
- DECRYPT
- Delete
- DELETE
- Tag
- TAG
- COPY
- COPY
- CUSTOM
- CUSTOM
- DECRYPT
- DECRYPT
- DELETE
- DELETE
- TAG
- TAG
- "COPY"
- COPY
- "CUSTOM"
- CUSTOM
- "DECRYPT"
- DECRYPT
- "DELETE"
- DELETE
- "TAG"
- TAG
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.