CfnEventStreamProps

class aws_cdk.aws_pinpoint.CfnEventStreamProps(*, application_id, destination_stream_arn, role_arn)

Bases: object

Properties for defining a CfnEventStream.

Parameters
  • application_id (str) – The unique identifier for the Amazon Pinpoint application that you want to export data from.

  • destination_stream_arn (str) – The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis 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 Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose: region : account-id :deliverystream/ stream_name

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_pinpoint as pinpoint

cfn_event_stream_props = pinpoint.CfnEventStreamProps(
    application_id="applicationId",
    destination_stream_arn="destinationStreamArn",
    role_arn="roleArn"
)

Attributes

application_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-applicationid

Return type

str

destination_stream_arn

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis 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 Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose: region : account-id :deliverystream/ stream_name

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-destinationstreamarn

Return type

str

role_arn

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-rolearn

Return type

str