Class: AWSCDK::Transfer::CfnWorkflow::S3InputFileLocationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Transfer::CfnWorkflow::S3InputFileLocationProperty

Defined in:

transfer/cfn_workflow.rb

Overview

Specifies the details for the Amazon S3 location for an input file to a workflow.

See Also:

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

Instance Attribute Summary

• #bucket ⇒ String^? readonly

  Specifies the S3 bucket for the customer input file.

• #key ⇒ String^? readonly

  The name assigned to the file when it was created in Amazon S3.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(bucket: nil, key: nil) ⇒ S3InputFileLocationProperty constructor

  A new instance of S3InputFileLocationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(bucket: nil, key: nil) ⇒ S3InputFileLocationProperty

Returns a new instance of S3InputFileLocationProperty.

Parameters:

• bucket (String, nil) (defaults to: nil) —

  Specifies the S3 bucket for the customer input file.

• key (String, nil) (defaults to: nil) —

  The name assigned to the file when it was created in Amazon S3.

# File 'transfer/cfn_workflow.rb', line 1010

def initialize(bucket: nil, key: nil)
  @bucket = bucket
  Jsii::Type.check_type(@bucket, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucket") unless @bucket.nil?
  @key = key
  Jsii::Type.check_type(@key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key") unless @key.nil?
end

Instance Attribute Details

#bucket ⇒ String^? (readonly)

Specifies the S3 bucket for the customer input file.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html#cfn-transfer-workflow-s3inputfilelocation-bucket

# File 'transfer/cfn_workflow.rb', line 1021

def bucket
  @bucket
end

#key ⇒ String^? (readonly)

The name assigned to the file when it was created in Amazon S3.

You use the object key to retrieve the object.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-transfer-workflow-s3inputfilelocation.html#cfn-transfer-workflow-s3inputfilelocation-key

# File 'transfer/cfn_workflow.rb', line 1028

def key
  @key
end

Class Method Details

.jsii_properties ⇒ Object

# File 'transfer/cfn_workflow.rb', line 1030

def self.jsii_properties
  {
    :bucket => "bucket",
    :key => "key",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'transfer/cfn_workflow.rb', line 1037

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "key" => @key,
  })
  result.compact
end