Class: AWSCDK::KinesisFirehose::DeliveryStreamAttributes

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
kinesis_firehose/delivery_stream_attributes.rb

Overview

A full specification of a delivery stream that can be used to import it fluently into the CDK application.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(delivery_stream_arn: nil, delivery_stream_name: nil, role: nil) ⇒ DeliveryStreamAttributes

Returns a new instance of DeliveryStreamAttributes.

Parameters:

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

    The ARN of the delivery stream.

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

    The name of the delivery stream.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    The IAM role associated with this delivery stream.



10
11
12
13
14
15
16
17
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 10

def initialize(delivery_stream_arn: nil, delivery_stream_name: nil, role: nil)
  @delivery_stream_arn = delivery_stream_arn
  Jsii::Type.check_type(@delivery_stream_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamArn") unless @delivery_stream_arn.nil?
  @delivery_stream_name = delivery_stream_name
  Jsii::Type.check_type(@delivery_stream_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deliveryStreamName") unless @delivery_stream_name.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
end

Instance Attribute Details

#delivery_stream_arn ⇒ String? (readonly)

Note:

Default: - derived from deliveryStreamName.

The ARN of the delivery stream.

At least one of deliveryStreamArn and deliveryStreamName must be provided.

Returns:

  • (String, nil) 


25
26
27
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 25

def delivery_stream_arn
  @delivery_stream_arn
end

#delivery_stream_name ⇒ String? (readonly)

Note:

Default: - derived from deliveryStreamArn.

The name of the delivery stream.

At least one of deliveryStreamName and deliveryStreamArn must be provided.

Returns:

  • (String, nil) 


32
33
34
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 32

def delivery_stream_name
  @delivery_stream_name
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - the imported stream cannot be granted access to other resources as an iam.IGrantable.

The IAM role associated with this delivery stream.

Assumed by Amazon Data Firehose to read from sources and encrypt data server-side.

Returns:



39
40
41
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 39

def role
  @role
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 41

def self.jsii_properties
  {
    :delivery_stream_arn => "deliveryStreamArn",
    :delivery_stream_name => "deliveryStreamName",
    :role => "role",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'kinesis_firehose/delivery_stream_attributes.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "deliveryStreamArn" => @delivery_stream_arn,
    "deliveryStreamName" => @delivery_stream_name,
    "role" => @role,
  })
  result.compact
end