Struct aws_sdk_transfer::types::builders::CopyStepDetailsBuilder

#[non_exhaustive]
pub struct CopyStepDetailsBuilder { /* private fields */ }

A builder for CopyStepDetails.

Implementations

impl CopyStepDetailsBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name of the step, used as an identifier.

pub fn set_name(self, input: Option<String>) -> Self

The name of the step, used as an identifier.

pub fn get_name(&self) -> &Option<String>

The name of the step, used as an identifier.

pub fn destination_file_location(self, input: InputFileLocation) -> Self

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 set_destination_file_location( self, input: Option<InputFileLocation>, ) -> Self

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 get_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, input: OverwriteExisting) -> Self

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 set_overwrite_existing(self, input: Option<OverwriteExisting>) -> Self

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 get_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, input: impl Into<String>) -> Self

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}.

pub fn set_source_file_location(self, input: Option<String>) -> Self

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}.

pub fn get_source_file_location(&self) -> &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}.

pub fn build(self) -> CopyStepDetails

Consumes the builder and constructs a CopyStepDetails.

Trait Implementations

impl Clone for CopyStepDetailsBuilder

fn clone(&self) -> CopyStepDetailsBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CopyStepDetailsBuilder

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

Formats the value using the given formatter.

impl Default for CopyStepDetailsBuilder

fn default() -> CopyStepDetailsBuilder

Returns the “default value” for a type.

impl PartialEq for CopyStepDetailsBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CopyStepDetailsBuilder