software.amazon.awscdk.services.pinpoint

Class CfnEventStream

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.pinpoint.CfnEventStream

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.217Z")
public class CfnEventStream
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::EventStream`.

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

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.*;
 CfnEventStream cfnEventStream = CfnEventStream.Builder.create(this, "MyCfnEventStream")
         .applicationId("applicationId")
         .destinationStreamArn("destinationStreamArn")
         .roleArn("roleArn")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEventStream.Builder A fluent builder for CfnEventStream.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventStream(Construct scope, java.lang.String id, CfnEventStreamProps props) Create a new `AWS::Pinpoint::EventStream`.
protected	CfnEventStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getApplicationId() The unique identifier for the Amazon Pinpoint application that you want to export data from.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDestinationStreamArn() 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.
java.lang.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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setApplicationId(java.lang.String value) The unique identifier for the Amazon Pinpoint application that you want to export data from.
void	setDestinationStreamArn(java.lang.String value) 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.
void	setRoleArn(java.lang.String value) 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 class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventStream

protected CfnEventStream(software.amazon.jsii.JsiiObjectRef objRef)

CfnEventStream

protected CfnEventStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEventStream

public CfnEventStream(Construct scope,
                      java.lang.String id,
                      CfnEventStreamProps props)

Create a new `AWS::Pinpoint::EventStream`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getApplicationId

public java.lang.String getApplicationId()

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

setApplicationId

public void setApplicationId(java.lang.String value)

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

getDestinationStreamArn

public java.lang.String getDestinationStreamArn()

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

setDestinationStreamArn

public void setDestinationStreamArn(java.lang.String value)

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

getRoleArn

public java.lang.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.

setRoleArn

public void setRoleArn(java.lang.String value)

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