Class: AWSCDK::SSM::CfnResourceDataSync::S3DestinationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ssm/cfn_resource_data_sync.rb

Overview

Information about the target S3 bucket for the resource data sync.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket_name:, bucket_region:, sync_format:, bucket_prefix: nil, kms_key_arn: nil) ⇒ S3DestinationProperty

Returns a new instance of S3DestinationProperty.

Parameters:

  • bucket_name (String) —

    The name of the S3 bucket where the aggregated data is stored.

  • bucket_region (String) —

    The AWS Region with the S3 bucket targeted by the resource data sync.

  • sync_format (String) —

    A supported sync format.

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

    An Amazon S3 prefix for the bucket.

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

    The ARN of an encryption key for a destination in Amazon S3.



689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'ssm/cfn_resource_data_sync.rb', line 689

def initialize(bucket_name:, bucket_region:, sync_format:, bucket_prefix: nil, kms_key_arn: nil)
  @bucket_name = bucket_name
  Jsii::Type.check_type(@bucket_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketName")
  @bucket_region = bucket_region
  Jsii::Type.check_type(@bucket_region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketRegion")
  @sync_format = sync_format
  Jsii::Type.check_type(@sync_format, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "syncFormat")
  @bucket_prefix = bucket_prefix
  Jsii::Type.check_type(@bucket_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "bucketPrefix") unless @bucket_prefix.nil?
  @kms_key_arn = kms_key_arn
  Jsii::Type.check_type(@kms_key_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kmsKeyArn") unless @kms_key_arn.nil?
end

Instance Attribute Details

#bucket_name ⇒ String (readonly)

The name of the S3 bucket where the aggregated data is stored.

Returns:

  • (String)

See Also:



706
707
708
 
# File 'ssm/cfn_resource_data_sync.rb', line 706

def bucket_name
  @bucket_name
end

#bucket_prefix ⇒ String? (readonly)

An Amazon S3 prefix for the bucket.

Returns:

  • (String, nil)

See Also:



723
724
725
 
# File 'ssm/cfn_resource_data_sync.rb', line 723

def bucket_prefix
  @bucket_prefix
end

#bucket_region ⇒ String (readonly)

The AWS Region with the S3 bucket targeted by the resource data sync.

Returns:

  • (String)

See Also:



711
712
713
 
# File 'ssm/cfn_resource_data_sync.rb', line 711

def bucket_region
  @bucket_region
end

#kms_key_arn ⇒ String? (readonly)

The ARN of an encryption key for a destination in Amazon S3.

Must belong to the same Region as the destination S3 bucket.

Returns:

  • (String, nil)

See Also:



730
731
732
 
# File 'ssm/cfn_resource_data_sync.rb', line 730

def kms_key_arn
  @kms_key_arn
end

#sync_format ⇒ String (readonly)

A supported sync format.

The following format is currently supported: JsonSerDe

Returns:

  • (String)

See Also:



718
719
720
 
# File 'ssm/cfn_resource_data_sync.rb', line 718

def sync_format
  @sync_format
end

Class Method Details

.jsii_properties ⇒ Object 



732
733
734
735
736
737
738
739
740
 
# File 'ssm/cfn_resource_data_sync.rb', line 732

def self.jsii_properties
  {
    :bucket_name => "bucketName",
    :bucket_region => "bucketRegion",
    :sync_format => "syncFormat",
    :bucket_prefix => "bucketPrefix",
    :kms_key_arn => "kmsKeyArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



742
743
744
745
746
747
748
749
750
751
752
 
# File 'ssm/cfn_resource_data_sync.rb', line 742

def to_jsii
  result = {}
  result.merge!({
    "bucketName" => @bucket_name,
    "bucketRegion" => @bucket_region,
    "syncFormat" => @sync_format,
    "bucketPrefix" => @bucket_prefix,
    "kmsKeyArn" => @kms_key_arn,
  })
  result.compact
end