Class: AWSCDK::IoTAnalytics::CfnChannel::CustomerManagedS3Property

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_analytics/cfn_channel.rb

Overview

Used to store channel data in an S3 bucket that you manage.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bucket:, role_arn:, key_prefix: nil) ⇒ CustomerManagedS3Property

Returns a new instance of CustomerManagedS3Property.

Parameters:

  • bucket (String) —

    The name of the S3 bucket in which channel data is stored.

  • role_arn (String) —

    The ARN of the role that grants ITA permission to interact with your Amazon S3 resources.

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

    (Optional) The prefix used to create the keys of the channel data objects.



622
623
624
625
626
627
628
629
 
# File 'io_t_analytics/cfn_channel.rb', line 622

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

Instance Attribute Details

#bucket ⇒ String (readonly)

The name of the S3 bucket in which channel data is stored.

Returns:

  • (String)

See Also:



635
636
637
 
# File 'io_t_analytics/cfn_channel.rb', line 635

def bucket
  @bucket
end

#key_prefix ⇒ String? (readonly)

(Optional) The prefix used to create the keys of the channel data objects.

Each object in an S3 bucket has a key that is its unique identifier within the bucket (each object in a bucket has exactly one key). The prefix must end with a forward slash (/).

Returns:

  • (String, nil)

See Also:



647
648
649
 
# File 'io_t_analytics/cfn_channel.rb', line 647

def key_prefix
  @key_prefix
end

#role_arn ⇒ String (readonly)

The ARN of the role that grants ITA permission to interact with your Amazon S3 resources.

Returns:

  • (String)

See Also:



640
641
642
 
# File 'io_t_analytics/cfn_channel.rb', line 640

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



649
650
651
652
653
654
655
 
# File 'io_t_analytics/cfn_channel.rb', line 649

def self.jsii_properties
  {
    :bucket => "bucket",
    :role_arn => "roleArn",
    :key_prefix => "keyPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



657
658
659
660
661
662
663
664
665
 
# File 'io_t_analytics/cfn_channel.rb', line 657

def to_jsii
  result = {}
  result.merge!({
    "bucket" => @bucket,
    "roleArn" => @role_arn,
    "keyPrefix" => @key_prefix,
  })
  result.compact
end