Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. transfer
  5. Workflow

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.transfer.Workflow

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a AWS Transfer Workflow resource.

    Example Usage

    Basic single step example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Transfer.Workflow("example", new()
    {
        Steps = new[]
        {
            new Aws.Transfer.Inputs.WorkflowStepArgs
            {
                DeleteStepDetails = new Aws.Transfer.Inputs.WorkflowStepDeleteStepDetailsArgs
                {
                    Name = "example",
                    SourceFileLocation = "${original.file}",
                },
                Type = "DELETE",
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transfer.NewWorkflow(ctx, "example", &transfer.WorkflowArgs{
			Steps: transfer.WorkflowStepArray{
				&transfer.WorkflowStepArgs{
					DeleteStepDetails: &transfer.WorkflowStepDeleteStepDetailsArgs{
						Name:               pulumi.String("example"),
						SourceFileLocation: pulumi.String("${original.file}"),
					},
					Type: pulumi.String("DELETE"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Workflow;
import com.pulumi.aws.transfer.WorkflowArgs;
import com.pulumi.aws.transfer.inputs.WorkflowStepArgs;
import com.pulumi.aws.transfer.inputs.WorkflowStepDeleteStepDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Workflow("example", WorkflowArgs.builder()        
            .steps(WorkflowStepArgs.builder()
                .deleteStepDetails(WorkflowStepDeleteStepDetailsArgs.builder()
                    .name("example")
                    .sourceFileLocation("${original.file}")
                    .build())
                .type("DELETE")
                .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.transfer.Workflow("example", steps=[aws.transfer.WorkflowStepArgs(
    delete_step_details=aws.transfer.WorkflowStepDeleteStepDetailsArgs(
        name="example",
        source_file_location="${original.file}",
    ),
    type="DELETE",
)])

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.transfer.Workflow("example", {steps: [{
    deleteStepDetails: {
        name: "example",
        sourceFileLocation: "${original.file}",
    },
    type: "DELETE",
}]});

    resources:
  example:
    type: aws:transfer:Workflow
    properties:
      steps:
        - deleteStepDetails:
            name: example
            sourceFileLocation: ${original.file}
          type: DELETE

    Multistep example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Transfer.Workflow("example", new()
    {
        Steps = new[]
        {
            new Aws.Transfer.Inputs.WorkflowStepArgs
            {
                CustomStepDetails = new Aws.Transfer.Inputs.WorkflowStepCustomStepDetailsArgs
                {
                    Name = "example",
                    SourceFileLocation = "${original.file}",
                    Target = aws_lambda_function.Example.Arn,
                    TimeoutSeconds = 60,
                },
                Type = "CUSTOM",
            },
            new Aws.Transfer.Inputs.WorkflowStepArgs
            {
                TagStepDetails = new Aws.Transfer.Inputs.WorkflowStepTagStepDetailsArgs
                {
                    Name = "example",
                    SourceFileLocation = "${original.file}",
                    Tags = new[]
                    {
                        new Aws.Transfer.Inputs.WorkflowStepTagStepDetailsTagArgs
                        {
                            Key = "Name",
                            Value = "Hello World",
                        },
                    },
                },
                Type = "TAG",
            },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/transfer"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := transfer.NewWorkflow(ctx, "example", &transfer.WorkflowArgs{
			Steps: transfer.WorkflowStepArray{
				&transfer.WorkflowStepArgs{
					CustomStepDetails: &transfer.WorkflowStepCustomStepDetailsArgs{
						Name:               pulumi.String("example"),
						SourceFileLocation: pulumi.String("${original.file}"),
						Target:             pulumi.Any(aws_lambda_function.Example.Arn),
						TimeoutSeconds:     pulumi.Int(60),
					},
					Type: pulumi.String("CUSTOM"),
				},
				&transfer.WorkflowStepArgs{
					TagStepDetails: &transfer.WorkflowStepTagStepDetailsArgs{
						Name:               pulumi.String("example"),
						SourceFileLocation: pulumi.String("${original.file}"),
						Tags: transfer.WorkflowStepTagStepDetailsTagArray{
							&transfer.WorkflowStepTagStepDetailsTagArgs{
								Key:   pulumi.String("Name"),
								Value: pulumi.String("Hello World"),
							},
						},
					},
					Type: pulumi.String("TAG"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.transfer.Workflow;
import com.pulumi.aws.transfer.WorkflowArgs;
import com.pulumi.aws.transfer.inputs.WorkflowStepArgs;
import com.pulumi.aws.transfer.inputs.WorkflowStepCustomStepDetailsArgs;
import com.pulumi.aws.transfer.inputs.WorkflowStepTagStepDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Workflow("example", WorkflowArgs.builder()        
            .steps(            
                WorkflowStepArgs.builder()
                    .customStepDetails(WorkflowStepCustomStepDetailsArgs.builder()
                        .name("example")
                        .sourceFileLocation("${original.file}")
                        .target(aws_lambda_function.example().arn())
                        .timeoutSeconds(60)
                        .build())
                    .type("CUSTOM")
                    .build(),
                WorkflowStepArgs.builder()
                    .tagStepDetails(WorkflowStepTagStepDetailsArgs.builder()
                        .name("example")
                        .sourceFileLocation("${original.file}")
                        .tags(WorkflowStepTagStepDetailsTagArgs.builder()
                            .key("Name")
                            .value("Hello World")
                            .build())
                        .build())
                    .type("TAG")
                    .build())
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

example = aws.transfer.Workflow("example", steps=[
    aws.transfer.WorkflowStepArgs(
        custom_step_details=aws.transfer.WorkflowStepCustomStepDetailsArgs(
            name="example",
            source_file_location="${original.file}",
            target=aws_lambda_function["example"]["arn"],
            timeout_seconds=60,
        ),
        type="CUSTOM",
    ),
    aws.transfer.WorkflowStepArgs(
        tag_step_details=aws.transfer.WorkflowStepTagStepDetailsArgs(
            name="example",
            source_file_location="${original.file}",
            tags=[aws.transfer.WorkflowStepTagStepDetailsTagArgs(
                key="Name",
                value="Hello World",
            )],
        ),
        type="TAG",
    ),
])

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.transfer.Workflow("example", {steps: [
    {
        customStepDetails: {
            name: "example",
            sourceFileLocation: "${original.file}",
            target: aws_lambda_function.example.arn,
            timeoutSeconds: 60,
        },
        type: "CUSTOM",
    },
    {
        tagStepDetails: {
            name: "example",
            sourceFileLocation: "${original.file}",
            tags: [{
                key: "Name",
                value: "Hello World",
            }],
        },
        type: "TAG",
    },
]});

    resources:
  example:
    type: aws:transfer:Workflow
    properties:
      steps:
        - customStepDetails:
            name: example
            sourceFileLocation: ${original.file}
            target: ${aws_lambda_function.example.arn}
            timeoutSeconds: 60
          type: CUSTOM
        - tagStepDetails:
            name: example
            sourceFileLocation: ${original.file}
            tags:
              - key: Name
                value: Hello World
          type: TAG

    Create 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[WorkflowOnExceptionStepArgs]] = None,
             steps: Optional[Sequence[WorkflowStepArgs]] = None,
             tags: Optional[Mapping[str, str]] = 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: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<WorkflowStepArgs>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    Description string

    A textual description for the workflow.

    OnExceptionSteps List<WorkflowOnExceptionStepArgs>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Steps []WorkflowStepArgs

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    Description string

    A textual description for the workflow.

    OnExceptionSteps []WorkflowOnExceptionStepArgs

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    steps List<WorkflowStepArgs>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    description String

    A textual description for the workflow.

    onExceptionSteps List<WorkflowOnExceptionStepArgs>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    steps WorkflowStepArgs[]

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    description string

    A textual description for the workflow.

    onExceptionSteps WorkflowOnExceptionStepArgs[]

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    steps Sequence[WorkflowStepArgs]

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    description str

    A textual description for the workflow.

    on_exception_steps Sequence[WorkflowOnExceptionStepArgs]

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    steps List<Property Map>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    description String

    A textual description for the workflow.

    onExceptionSteps List<Property Map>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

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

    Arn string

    The Workflow ARN.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

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

    Arn string

    The Workflow ARN.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

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

    arn String

    The Workflow ARN.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

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

    arn string

    The Workflow ARN.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

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

    arn str

    The Workflow ARN.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

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

    arn String

    The Workflow ARN.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

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

    Look up Existing Workflow Resource

    Get an existing Workflow resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkflowState, opts?: CustomResourceOptions): Workflow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        on_exception_steps: Optional[Sequence[WorkflowOnExceptionStepArgs]] = None,
        steps: Optional[Sequence[WorkflowStepArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Workflow
    func GetWorkflow(ctx *Context, name string, id IDInput, state *WorkflowState, opts ...ResourceOption) (*Workflow, error)
    public static Workflow Get(string name, Input<string> id, WorkflowState? state, CustomResourceOptions? opts = null)
    public static Workflow get(String name, Output<String> id, WorkflowState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The Workflow ARN.

    Description string

    A textual description for the workflow.

    OnExceptionSteps List<WorkflowOnExceptionStepArgs>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    Steps List<WorkflowStepArgs>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

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

    Arn string

    The Workflow ARN.

    Description string

    A textual description for the workflow.

    OnExceptionSteps []WorkflowOnExceptionStepArgs

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    Steps []WorkflowStepArgs

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

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

    arn String

    The Workflow ARN.

    description String

    A textual description for the workflow.

    onExceptionSteps List<WorkflowOnExceptionStepArgs>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    steps List<WorkflowStepArgs>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

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

    arn string

    The Workflow ARN.

    description string

    A textual description for the workflow.

    onExceptionSteps WorkflowOnExceptionStepArgs[]

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    steps WorkflowStepArgs[]

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

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

    arn str

    The Workflow ARN.

    description str

    A textual description for the workflow.

    on_exception_steps Sequence[WorkflowOnExceptionStepArgs]

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    steps Sequence[WorkflowStepArgs]

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

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

    arn String

    The Workflow ARN.

    description String

    A textual description for the workflow.

    onExceptionSteps List<Property Map>

    Specifies the steps (actions) to take if errors are encountered during execution of the workflow. See Workflow Steps below.

    steps List<Property Map>

    Specifies the details for the steps that are in the specified workflow. See Workflow Steps below.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

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

    Supporting Types

    WorkflowOnExceptionStep

    Type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    CopyStepDetails WorkflowOnExceptionStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    CustomStepDetails WorkflowOnExceptionStepCustomStepDetails

    Details for a step that invokes a lambda function.

    DecryptStepDetails WorkflowOnExceptionStepDecryptStepDetails

    Details for a step that decrypts the file.

    DeleteStepDetails WorkflowOnExceptionStepDeleteStepDetails

    Details for a step that deletes the file.

    TagStepDetails WorkflowOnExceptionStepTagStepDetails

    Details for a step that creates one or more tags.

    Type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    CopyStepDetails WorkflowOnExceptionStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    CustomStepDetails WorkflowOnExceptionStepCustomStepDetails

    Details for a step that invokes a lambda function.

    DecryptStepDetails WorkflowOnExceptionStepDecryptStepDetails

    Details for a step that decrypts the file.

    DeleteStepDetails WorkflowOnExceptionStepDeleteStepDetails

    Details for a step that deletes the file.

    TagStepDetails WorkflowOnExceptionStepTagStepDetails

    Details for a step that creates one or more tags.

    type String

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails WorkflowOnExceptionStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails WorkflowOnExceptionStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decryptStepDetails WorkflowOnExceptionStepDecryptStepDetails

    Details for a step that decrypts the file.

    deleteStepDetails WorkflowOnExceptionStepDeleteStepDetails

    Details for a step that deletes the file.

    tagStepDetails WorkflowOnExceptionStepTagStepDetails

    Details for a step that creates one or more tags.

    type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails WorkflowOnExceptionStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails WorkflowOnExceptionStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decryptStepDetails WorkflowOnExceptionStepDecryptStepDetails

    Details for a step that decrypts the file.

    deleteStepDetails WorkflowOnExceptionStepDeleteStepDetails

    Details for a step that deletes the file.

    tagStepDetails WorkflowOnExceptionStepTagStepDetails

    Details for a step that creates one or more tags.

    type str

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copy_step_details WorkflowOnExceptionStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    custom_step_details WorkflowOnExceptionStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decrypt_step_details WorkflowOnExceptionStepDecryptStepDetails

    Details for a step that decrypts the file.

    delete_step_details WorkflowOnExceptionStepDeleteStepDetails

    Details for a step that deletes the file.

    tag_step_details WorkflowOnExceptionStepTagStepDetails

    Details for a step that creates one or more tags.

    type String

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails Property Map

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails Property Map

    Details for a step that invokes a lambda function.

    decryptStepDetails Property Map

    Details for a step that decrypts the file.

    deleteStepDetails Property Map

    Details for a step that deletes the file.

    tagStepDetails Property Map

    Details for a step that creates one or more tags.

    WorkflowOnExceptionStepCopyStepDetails

    DestinationFileLocation WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    DestinationFileLocation WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name string

    The name of the step, used as an identifier.

    overwriteExisting string

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

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destination_file_location WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name str

    The name of the step, used as an identifier.

    overwrite_existing str

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

    source_file_location str

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation Property Map

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocation

    efsFileLocation Property Map

    Specifies the details for the EFS file being copied.

    s3FileLocation Property Map

    Specifies the details for the S3 file being copied.

    WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocationEfsFileLocation

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    fileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    path string

    The pathname for the folder being used by a workflow.

    file_system_id str

    The ID of the file system, assigned by Amazon EFS.

    path str

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    WorkflowOnExceptionStepCopyStepDetailsDestinationFileLocationS3FileLocation

    Bucket string

    Specifies the S3 bucket for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    key String

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

    WorkflowOnExceptionStepCustomStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    target String

    The ARN for the lambda function that is being called.

    timeoutSeconds Number

    Timeout, in seconds, for the step.

    WorkflowOnExceptionStepDecryptStepDetails

    Type string

    The type of encryption used. Currently, this value must be "PGP".

    DestinationFileLocation WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Type string

    The type of encryption used. Currently, this value must be "PGP".

    DestinationFileLocation WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type String

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type string

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name string

    The name of the step, used as an identifier.

    overwriteExisting string

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

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type str

    The type of encryption used. Currently, this value must be "PGP".

    destination_file_location WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name str

    The name of the step, used as an identifier.

    overwrite_existing str

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

    source_file_location str

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type String

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation Property Map

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocation

    efsFileLocation Property Map

    Specifies the details for the EFS file being copied.

    s3FileLocation Property Map

    Specifies the details for the S3 file being copied.

    WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocationEfsFileLocation

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    fileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    path string

    The pathname for the folder being used by a workflow.

    file_system_id str

    The ID of the file system, assigned by Amazon EFS.

    path str

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    WorkflowOnExceptionStepDecryptStepDetailsDestinationFileLocationS3FileLocation

    Bucket string

    Specifies the S3 bucket for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    key String

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

    WorkflowOnExceptionStepDeleteStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowOnExceptionStepTagStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Tags List<WorkflowOnExceptionStepTagStepDetailsTag>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Tags []WorkflowOnExceptionStepTagStepDetailsTag

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name String

    The name of the step, used as an identifier.

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags List<WorkflowOnExceptionStepTagStepDetailsTag>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name string

    The name of the step, used as an identifier.

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags WorkflowOnExceptionStepTagStepDetailsTag[]

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags Sequence[WorkflowOnExceptionStepTagStepDetailsTag]

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name String

    The name of the step, used as an identifier.

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags List<Property Map>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    WorkflowOnExceptionStepTagStepDetailsTag

    Key string

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

    Value string

    The value that corresponds to the key.

    Key string

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

    Value string

    The value that corresponds to the key.

    key String

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

    value String

    The value that corresponds to the key.

    key string

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

    value string

    The value that corresponds to the key.

    key str

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

    value str

    The value that corresponds to the key.

    key String

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

    value String

    The value that corresponds to the key.

    WorkflowStep

    Type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    CopyStepDetails WorkflowStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    CustomStepDetails WorkflowStepCustomStepDetails

    Details for a step that invokes a lambda function.

    DecryptStepDetails WorkflowStepDecryptStepDetails

    Details for a step that decrypts the file.

    DeleteStepDetails WorkflowStepDeleteStepDetails

    Details for a step that deletes the file.

    TagStepDetails WorkflowStepTagStepDetails

    Details for a step that creates one or more tags.

    Type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    CopyStepDetails WorkflowStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    CustomStepDetails WorkflowStepCustomStepDetails

    Details for a step that invokes a lambda function.

    DecryptStepDetails WorkflowStepDecryptStepDetails

    Details for a step that decrypts the file.

    DeleteStepDetails WorkflowStepDeleteStepDetails

    Details for a step that deletes the file.

    TagStepDetails WorkflowStepTagStepDetails

    Details for a step that creates one or more tags.

    type String

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails WorkflowStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails WorkflowStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decryptStepDetails WorkflowStepDecryptStepDetails

    Details for a step that decrypts the file.

    deleteStepDetails WorkflowStepDeleteStepDetails

    Details for a step that deletes the file.

    tagStepDetails WorkflowStepTagStepDetails

    Details for a step that creates one or more tags.

    type string

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails WorkflowStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails WorkflowStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decryptStepDetails WorkflowStepDecryptStepDetails

    Details for a step that decrypts the file.

    deleteStepDetails WorkflowStepDeleteStepDetails

    Details for a step that deletes the file.

    tagStepDetails WorkflowStepTagStepDetails

    Details for a step that creates one or more tags.

    type str

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copy_step_details WorkflowStepCopyStepDetails

    Details for a step that performs a file copy. See Copy Step Details below.

    custom_step_details WorkflowStepCustomStepDetails

    Details for a step that invokes a lambda function.

    decrypt_step_details WorkflowStepDecryptStepDetails

    Details for a step that decrypts the file.

    delete_step_details WorkflowStepDeleteStepDetails

    Details for a step that deletes the file.

    tag_step_details WorkflowStepTagStepDetails

    Details for a step that creates one or more tags.

    type String

    One of the following step types are supported. COPY, CUSTOM, DECRYPT, DELETE, and TAG.

    copyStepDetails Property Map

    Details for a step that performs a file copy. See Copy Step Details below.

    customStepDetails Property Map

    Details for a step that invokes a lambda function.

    decryptStepDetails Property Map

    Details for a step that decrypts the file.

    deleteStepDetails Property Map

    Details for a step that deletes the file.

    tagStepDetails Property Map

    Details for a step that creates one or more tags.

    WorkflowStepCopyStepDetails

    DestinationFileLocation WorkflowStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    DestinationFileLocation WorkflowStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation WorkflowStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation WorkflowStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name string

    The name of the step, used as an identifier.

    overwriteExisting string

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

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destination_file_location WorkflowStepCopyStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name str

    The name of the step, used as an identifier.

    overwrite_existing str

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

    source_file_location str

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    destinationFileLocation Property Map

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowStepCopyStepDetailsDestinationFileLocation

    efsFileLocation Property Map

    Specifies the details for the EFS file being copied.

    s3FileLocation Property Map

    Specifies the details for the S3 file being copied.

    WorkflowStepCopyStepDetailsDestinationFileLocationEfsFileLocation

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    fileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    path string

    The pathname for the folder being used by a workflow.

    file_system_id str

    The ID of the file system, assigned by Amazon EFS.

    path str

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    WorkflowStepCopyStepDetailsDestinationFileLocationS3FileLocation

    Bucket string

    Specifies the S3 bucket for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    key String

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

    WorkflowStepCustomStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    target String

    The ARN for the lambda function that is being called.

    timeoutSeconds Number

    Timeout, in seconds, for the step.

    WorkflowStepDecryptStepDetails

    Type string

    The type of encryption used. Currently, this value must be "PGP".

    DestinationFileLocation WorkflowStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Type string

    The type of encryption used. Currently, this value must be "PGP".

    DestinationFileLocation WorkflowStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    Name string

    The name of the step, used as an identifier.

    OverwriteExisting string

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

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type String

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation WorkflowStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type string

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation WorkflowStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name string

    The name of the step, used as an identifier.

    overwriteExisting string

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

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type str

    The type of encryption used. Currently, this value must be "PGP".

    destination_file_location WorkflowStepDecryptStepDetailsDestinationFileLocation

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name str

    The name of the step, used as an identifier.

    overwrite_existing str

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

    source_file_location str

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    type String

    The type of encryption used. Currently, this value must be "PGP".

    destinationFileLocation Property Map

    Specifies the location for the file being copied. Use ${Transfer:username} in this field to parametrize the destination prefix by username.

    name String

    The name of the step, used as an identifier.

    overwriteExisting String

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

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowStepDecryptStepDetailsDestinationFileLocation

    efsFileLocation Property Map

    Specifies the details for the EFS file being copied.

    s3FileLocation Property Map

    Specifies the details for the S3 file being copied.

    WorkflowStepDecryptStepDetailsDestinationFileLocationEfsFileLocation

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    FileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    Path string

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    fileSystemId string

    The ID of the file system, assigned by Amazon EFS.

    path string

    The pathname for the folder being used by a workflow.

    file_system_id str

    The ID of the file system, assigned by Amazon EFS.

    path str

    The pathname for the folder being used by a workflow.

    fileSystemId String

    The ID of the file system, assigned by Amazon EFS.

    path String

    The pathname for the folder being used by a workflow.

    WorkflowStepDecryptStepDetailsDestinationFileLocationS3FileLocation

    Bucket string

    Specifies the S3 bucket for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    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 for the customer input file.

    key String

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

    WorkflowStepDeleteStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this 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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    WorkflowStepTagStepDetails

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Tags List<WorkflowStepTagStepDetailsTag>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    Name string

    The name of the step, used as an identifier.

    SourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    Tags []WorkflowStepTagStepDetailsTag

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name String

    The name of the step, used as an identifier.

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags List<WorkflowStepTagStepDetailsTag>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name string

    The name of the step, used as an identifier.

    sourceFileLocation string

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags WorkflowStepTagStepDetailsTag[]

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    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: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags Sequence[WorkflowStepTagStepDetailsTag]

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    name String

    The name of the step, used as an identifier.

    sourceFileLocation String

    Specifies which file to use as input to the workflow step: either the output from the previous step, or the originally uploaded file for the workflow. Enter ${previous.file} to use the previous file as the input. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value. Enter ${original.file} to use the originally-uploaded file location as input for this step.

    tags List<Property Map>

    Array that contains from 1 to 10 key/value pairs. See S3 Tags below.

    WorkflowStepTagStepDetailsTag

    Key string

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

    Value string

    The value that corresponds to the key.

    Key string

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

    Value string

    The value that corresponds to the key.

    key String

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

    value String

    The value that corresponds to the key.

    key string

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

    value string

    The value that corresponds to the key.

    key str

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

    value str

    The value that corresponds to the key.

    key String

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

    value String

    The value that corresponds to the key.

    Import

    Transfer Workflows can be imported using the worflow_id.

     $ pulumi import aws:transfer/workflow:Workflow example example

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws