Class: AWSCDK::Pinpoint::CfnEventStreamProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_event_stream_props.rb

Overview

Properties for defining a CfnEventStream.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, destination_stream_arn:, role_arn:) ⇒ CfnEventStreamProps

Returns a new instance of CfnEventStreamProps.

Parameters:

  • application_id (String) —

    The unique identifier for the Amazon Pinpoint application that you want to export data from.

  • destination_stream_arn (String) —

    The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want to publish event data to.

  • role_arn (String) —

    The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.



12
13
14
15
16
17
18
19
 
# File 'pinpoint/cfn_event_stream_props.rb', line 12

def initialize(application_id:, destination_stream_arn:, role_arn:)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "applicationId")
  @destination_stream_arn = destination_stream_arn
  Jsii::Type.check_type(@destination_stream_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "destinationStreamArn")
  @role_arn = role_arn
  Jsii::Type.check_type(@role_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
end

Instance Attribute Details

#application_id ⇒ String (readonly)

The unique identifier for the Amazon Pinpoint application that you want to export data from.

Returns:

  • (String)

See Also:



25
26
27
 
# File 'pinpoint/cfn_event_stream_props.rb', line 25

def application_id
  @application_id
end

#destination_stream_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want to publish event data to.

For a Kinesis Data Stream, the ARN format is: arn:aws:kinesis: region : account-id :stream/ stream_name

For a Firehose delivery stream, the ARN format is: arn:aws:firehose: region : account-id :deliverystream/ stream_name

Returns:

  • (String)

See Also:



34
35
36
 
# File 'pinpoint/cfn_event_stream_props.rb', line 34

def destination_stream_arn
  @destination_stream_arn
end

#role_arn ⇒ String (readonly)

The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Returns:

  • (String)

See Also:



39
40
41
 
# File 'pinpoint/cfn_event_stream_props.rb', line 39

def role_arn
  @role_arn
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
 
# File 'pinpoint/cfn_event_stream_props.rb', line 41

def self.jsii_properties
  {
    :application_id => "applicationId",
    :destination_stream_arn => "destinationStreamArn",
    :role_arn => "roleArn",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "destinationStreamArn" => @destination_stream_arn,
    "roleArn" => @role_arn,
  })
  result.compact
end