Package software.amazon.awscdk.services.pinpoint

Class CfnEventStream

java.lang.Object
software.amazon.jsii.JsiiObject
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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:00.827Z") @Stability(Stable) 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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEventStream

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

    • CfnEventStream

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

    • CfnEventStream

      @Stability(Stable) public CfnEventStream(@NotNull Construct scope, @NotNull String id, @NotNull 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 Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull 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

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier for the Amazon Pinpoint application that you want to export data from.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application that you want to export data from.

    • getDestinationStreamArn

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setDestinationStreamArn(@NotNull 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

      @Stability(Stable) @NotNull public 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

      @Stability(Stable) public void setRoleArn(@NotNull 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.