software.amazon.awscdk.services.kinesis

Class CfnStream

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.kinesis.CfnStream

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.186Z")
 @Stability(value=Stable)
public class CfnStream
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Kinesis::Stream`.

Creates a Kinesis stream that captures and transports data records that are emitted from data sources. For information about creating streams, see CreateStream in the Amazon Kinesis API Reference.

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.kinesis.*;
 CfnStream cfnStream = CfnStream.Builder.create(this, "MyCfnStream")
         .name("name")
         .retentionPeriodHours(123)
         .shardCount(123)
         .streamEncryption(StreamEncryptionProperty.builder()
                 .encryptionType("encryptionType")
                 .keyId("keyId")
                 .build())
         .streamModeDetails(StreamModeDetailsProperty.builder()
                 .streamMode("streamMode")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStream.Builder A fluent builder for CfnStream.
static interface	CfnStream.StreamEncryptionProperty Enables or updates server-side encryption using an AWS KMS key for a specified stream.
static interface	CfnStream.StreamModeDetailsProperty Specifies the capacity mode to which you want to set your data stream.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStream(software.constructs.Construct scope, String id) Create a new `AWS::Kinesis::Stream`.
	CfnStream(software.constructs.Construct scope, String id, CfnStreamProps props) Create a new `AWS::Kinesis::Stream`.
protected	CfnStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStream(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon resource name (ARN) of the Kinesis stream, such as `arn:aws:kinesis:us-east-2:123456789012:stream/mystream` .
protected Map<String,Object>	getCfnProperties()
String	getName() The name of the Kinesis stream.
Number	getRetentionPeriodHours() The number of hours for the data records that are stored in shards to remain accessible.
Number	getShardCount() The number of shards that the stream uses.
Object	getStreamEncryption() When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
Object	getStreamModeDetails() Specifies the capacity mode to which you want to set your data stream.
TagManager	getTags() An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setName(String value) The name of the Kinesis stream.
void	setRetentionPeriodHours(Number value) The number of hours for the data records that are stored in shards to remain accessible.
void	setShardCount(Number value) The number of shards that the stream uses.
void	setStreamEncryption(CfnStream.StreamEncryptionProperty value) When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
void	setStreamEncryption(IResolvable value) When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
void	setStreamModeDetails(CfnStream.StreamModeDetailsProperty value) Specifies the capacity mode to which you want to set your data stream.
void	setStreamModeDetails(IResolvable value) Specifies the capacity mode to which you want to set your data stream.

Methods inherited from class software.amazon.awscdk.CfnResource

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

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStream

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

CfnStream

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

CfnStream

@Stability(value=Stable)
public CfnStream(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id,
                                          @Nullable
                                          CfnStreamProps props)

Create a new `AWS::Kinesis::Stream`.

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.

CfnStream

@Stability(value=Stable)
public CfnStream(@NotNull
                                          software.constructs.Construct scope,
                                          @NotNull
                                          String id)

Create a new `AWS::Kinesis::Stream`.

Parameters:

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

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

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon resource name (ARN) of the Kinesis stream, such as `arn:aws:kinesis:us-east-2:123456789012:stream/mystream` .

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.

For information about constraints for this property, see Tag Restrictions in the Amazon Kinesis Developer Guide .

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name of the Kinesis stream.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name of the Kinesis stream.

If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the stream name. For more information, see Name Type .

If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

getRetentionPeriodHours

@Stability(value=Stable)
 @Nullable
public Number getRetentionPeriodHours()

The number of hours for the data records that are stored in shards to remain accessible.

The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period in the Amazon Kinesis Developer Guide.

setRetentionPeriodHours

@Stability(value=Stable)
public void setRetentionPeriodHours(@Nullable
                                                             Number value)

The number of hours for the data records that are stored in shards to remain accessible.

The default value is 24. For more information about the stream retention period, see Changing the Data Retention Period in the Amazon Kinesis Developer Guide.

getShardCount

@Stability(value=Stable)
 @Nullable
public Number getShardCount()

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

setShardCount

@Stability(value=Stable)
public void setShardCount(@Nullable
                                                   Number value)

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

getStreamEncryption

@Stability(value=Stable)
 @Nullable
public Object getStreamEncryption()

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

setStreamEncryption

@Stability(value=Stable)
public void setStreamEncryption(@Nullable
                                                         CfnStream.StreamEncryptionProperty value)

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

setStreamEncryption

@Stability(value=Stable)
public void setStreamEncryption(@Nullable
                                                         IResolvable value)

When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.

Removing this property from your stack template and updating your stack disables encryption.

getStreamModeDetails

@Stability(value=Stable)
 @Nullable
public Object getStreamModeDetails()

Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

setStreamModeDetails

@Stability(value=Stable)
public void setStreamModeDetails(@Nullable
                                                          CfnStream.StreamModeDetailsProperty value)

Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.

setStreamModeDetails

@Stability(value=Stable)
public void setStreamModeDetails(@Nullable
                                                          IResolvable value)

Specifies the capacity mode to which you want to set your data stream.

Currently, in Kinesis Data Streams, you can choose between an on-demand capacity mode and a provisioned capacity mode for your data streams.