Show / Hide Table of Contents

Interface CfnWorkflow.ICopyStepDetailsProperty

Details for a step that performs a file copy.

Namespace: Amazon.CDK.AWS.Transfer
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnWorkflow.ICopyStepDetailsProperty
Syntax (vb)
Public Interface CfnWorkflow.ICopyStepDetailsProperty
Remarks

Consists of the following values:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
                 // The values are placeholders you should change.
                 using Amazon.CDK.AWS.Transfer;
    
                 var copyStepDetailsProperty = new CopyStepDetailsProperty {
                     DestinationFileLocation = new S3FileLocationProperty {
                         S3FileLocation = new S3InputFileLocationProperty {
                             Bucket = "bucket",
                             Key = "key"
                         }
                     },
                     Name = "name",
                     OverwriteExisting = "overwriteExisting",
                     SourceFileLocation = "sourceFileLocation"
                 };

    Synopsis

    Properties

    DestinationFileLocation

    Specifies the location for the file being copied.

    Name

    The name of the step, used as an identifier.

    OverwriteExisting

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

    SourceFileLocation

    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.

    Properties

    DestinationFileLocation

    Specifies the location for the file being copied.

    object? DestinationFileLocation { get; }
    Property Value

    object

    Remarks

    Use \({Transfer:UserName}</code> or <code>\){Transfer:UploadDate} in this field to parametrize the destination prefix by username or uploaded date.

      The system resolves <code>UploadDate</code> to a date format of <em>YYYY-MM-DD</em> , based on the date the file is uploaded in UTC.
      

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-destinationfilelocation

      Type union: either IResolvable or CfnWorkflow.IS3FileLocationProperty

      Name

      The name of the step, used as an identifier.

      string? Name { get; }
      Property Value

      string

      Remarks

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-name

      OverwriteExisting

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

      string? OverwriteExisting { get; }
      Property Value

      string

      Remarks

      If the workflow is processing a file that has the same name as an existing file, the behavior is as follows:

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-overwriteexisting

        SourceFileLocation

        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.

        string? SourceFileLocation { get; }
        Property Value

        string

        Remarks

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-copystepdetails.html#cfn-transfer-workflow-copystepdetails-sourcefilelocation

          Back to top Generated by DocFX