Class: AWSCDK::S3::CfnBucket::DestinationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
s3/cfn_bucket.rb

Overview

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_arn:, format:, bucket_account_id: nil, prefix: nil) ⇒ DestinationProperty

Returns a new instance of DestinationProperty.

Parameters:

  • bucket_arn (String) —

    The Amazon Resource Name (ARN) of the bucket to which data is exported.

  • format (String) —

    Specifies the file format used when exporting data to Amazon S3.

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

    The account ID that owns the destination S3 bucket.

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

    The prefix to use when exporting data.



1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
 
# File 's3/cfn_bucket.rb', line 1590

def initialize(bucket_arn:, format:, bucket_account_id: nil, prefix: nil)
  @bucket_arn = bucket_arn
  Jsii::Type.check_type(@bucket_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketArn")
  @format = format
  Jsii::Type.check_type(@format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "format")
  @bucket_account_id = 
  Jsii::Type.check_type(@bucket_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketAccountId") unless @bucket_account_id.nil?
  @prefix = prefix
  Jsii::Type.check_type(@prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix") unless @prefix.nil?
end

Instance Attribute Details

#bucket_account_id ⇒ String? (readonly)

The account ID that owns the destination S3 bucket.

If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

Returns:

  • (String, nil)

See Also:



1621
1622
1623
 
# File 's3/cfn_bucket.rb', line 1621

def 
  @bucket_account_id
end

#bucket_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the bucket to which data is exported.

Returns:

  • (String)

See Also:



1605
1606
1607
 
# File 's3/cfn_bucket.rb', line 1605

def bucket_arn
  @bucket_arn
end

#format ⇒ String (readonly)

Specifies the file format used when exporting data to Amazon S3.

Allowed values : CSV | ORC | Parquet

Returns:

  • (String)

See Also:



1612
1613
1614
 
# File 's3/cfn_bucket.rb', line 1612

def format
  @format
end

#prefix ⇒ String? (readonly)

The prefix to use when exporting data.

The prefix is prepended to all results.

Returns:

  • (String, nil)

See Also:



1628
1629
1630
 
# File 's3/cfn_bucket.rb', line 1628

def prefix
  @prefix
end

Class Method Details

.jsii_properties ⇒ Object 



1630
1631
1632
1633
1634
1635
1636
1637
 
# File 's3/cfn_bucket.rb', line 1630

def self.jsii_properties
  {
    :bucket_arn => "bucketArn",
    :format => "format",
    :bucket_account_id => "bucketAccountId",
    :prefix => "prefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
 
# File 's3/cfn_bucket.rb', line 1639

def to_jsii
  result = {}
  result.merge!({
    "bucketArn" => @bucket_arn,
    "format" => @format,
    "bucketAccountId" => @bucket_account_id,
    "prefix" => @prefix,
  })
  result.compact
end