Package software.amazon.awscdk.services.pinpoint

Interface CfnEventStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:20.570Z")
@Stability(Stable)
public interface CfnEventStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnEventStream.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 CfnEventStreamProps cfnEventStreamProps = CfnEventStreamProps.builder()
         .applicationId("applicationId")
         .destinationStreamArn("destinationStreamArn")
         .roleArn("roleArn")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventStreamProps.Builder	A builder for CfnEventStreamProps
static final class	CfnEventStreamProps.Jsii$Proxy	An implementation for CfnEventStreamProps

Method Summary

Modifier and Type	Method	Description
static CfnEventStreamProps.Builder	builder()
String	getApplicationId()	The unique identifier for the Amazon Pinpoint application that you want to export data from.
String	getDestinationStreamArn()	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.
String	getRoleArn()	The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApplicationId

@Stability(Stable)
@NotNull
String getApplicationId()

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

See Also:

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

getDestinationStreamArn

@Stability(Stable)
@NotNull
String getDestinationStreamArn()

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

See Also:

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

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

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

See Also:

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

builder

@Stability(Stable)
static CfnEventStreamProps.Builder builder()

Returns:

a CfnEventStreamProps.Builder of CfnEventStreamProps