software.amazon.awscdk.services.kinesis

Class CfnStream

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.kinesis.CfnStream

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-29T04:32:20.852Z")
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 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
	CfnStream(Construct scope, java.lang.String id) Create a new `AWS::Kinesis::Stream`.
	CfnStream(Construct scope, java.lang.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
java.lang.String	getAttrArn() The Amazon resource name (ARN) of the Kinesis stream, such as `arn:aws:kinesis:us-east-2:123456789012:stream/mystream` .
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getName() The name of the Kinesis stream.
java.lang.Number	getRetentionPeriodHours() The number of hours for the data records that are stored in shards to remain accessible.
java.lang.Number	getShardCount() The number of shards that the stream uses.
java.lang.Object	getStreamEncryption() When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setName(java.lang.String value) The name of the Kinesis stream.
void	setRetentionPeriodHours(java.lang.Number value) The number of hours for the data records that are stored in shards to remain accessible.
void	setShardCount(java.lang.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.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

CfnStream

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

CfnStream

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

CfnStream

public CfnStream(Construct scope,
                 java.lang.String id,
                 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

public CfnStream(Construct scope,
                 java.lang.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

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.

getAttrArn

public java.lang.String getAttrArn()

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

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

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

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

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

public java.lang.Number getShardCount()

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

setShardCount

public void setShardCount(java.lang.Number value)

The number of shards that the stream uses.

For greater provisioned throughput, increase the number of shards.

getStreamEncryption

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

public void setStreamEncryption(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

public void setStreamEncryption(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

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

public void setStreamModeDetails(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.

setStreamModeDetails

public void setStreamModeDetails(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.