Struct aws_sdk_transfer::types::CopyStepDetails

#[non_exhaustive]
pub struct CopyStepDetails {
    pub name: Option<String>,
    pub destination_file_location: Option<InputFileLocation>,
    pub overwrite_existing: Option<OverwriteExisting>,
    pub source_file_location: Option<String>,
}

Each step type has its own StepDetails structure.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the step, used as an identifier.

destination_file_location: Option<InputFileLocation>

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

• Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

• Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

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

overwrite_existing: Option<OverwriteExisting>

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

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

• If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

• If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

source_file_location: Option<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.

• To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• To use the originally uploaded file location as input for this step, enter ${original.file}.

Implementations

impl CopyStepDetails

pub fn name(&self) -> Option<&str>

The name of the step, used as an identifier.

pub fn destination_file_location(&self) -> Option<&InputFileLocation>

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

• Set the value of DestinationFileLocation to ${Transfer:UserName} to copy uploaded files to an Amazon S3 bucket that is prefixed with the name of the Transfer Family user that uploaded the file.

• Set the value of DestinationFileLocation to ${Transfer:UploadDate} to copy uploaded files to an Amazon S3 bucket that is prefixed with the date of the upload.

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

pub fn overwrite_existing(&self) -> Option<&OverwriteExisting>

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

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

• If OverwriteExisting is TRUE, the existing file is replaced with the file being processed.

• If OverwriteExisting is FALSE, nothing happens, and the workflow processing stops.

pub fn source_file_location(&self) -> Option<&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.

• To use the previous file as the input, enter ${previous.file}. In this case, this workflow step uses the output file from the previous workflow step as input. This is the default value.

• To use the originally uploaded file location as input for this step, enter ${original.file}.

impl CopyStepDetails

pub fn builder() -> CopyStepDetailsBuilder

Creates a new builder-style object to manufacture CopyStepDetails.

Trait Implementations

impl Clone for CopyStepDetails

fn clone(&self) -> CopyStepDetails

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CopyStepDetails

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CopyStepDetails

fn eq(&self, other: &CopyStepDetails) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CopyStepDetails