Class: Aws::Transfer::Types::S3InputFileLocation

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb

Overview

Note:

When making an API call, you may pass S3InputFileLocation data as a hash:

{
  bucket: "S3Bucket",
  key: "S3Key",
}

Specifies the customer input S3 file location. If it is used inside copyStepDetails.DestinationFileLocation, it should be the S3 copy destination.

You need to provide the bucket and key. The key can represent either a path or a file. This is determined by whether or not you end the key value with the forward slash (/) character. If the final character is "/", then your file is copied to the folder, and its name does not change. If, rather, the final character is alphanumeric, your uploaded file is renamed to the path value. In this case, if a file with that name already exists, it is overwritten.

For example, if your path is shared-files/bob/, your uploaded files are copied to the shared-files/bob/, folder. If your path is shared-files/today, each uploaded file is copied to the shared-files folder and named today: each upload overwrites the previous version of the bob file.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bucketString

Specifies the S3 bucket for the customer input file.

Returns:

  • (String)


4641
4642
4643
4644
4645
4646
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4641

class S3InputFileLocation < Struct.new(
  :bucket,
  :key)
  SENSITIVE = []
  include Aws::Structure
end

#keyString

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

Returns:

  • (String)


4641
4642
4643
4644
4645
4646
# File 'gems/aws-sdk-transfer/lib/aws-sdk-transfer/types.rb', line 4641

class S3InputFileLocation < Struct.new(
  :bucket,
  :key)
  SENSITIVE = []
  include Aws::Structure
end