interface WarmThroughputObjectProperty

Language	Type name
.NET	Amazon.CDK.CfnPropertyMixins.AWS.Kinesis.CfnStreamPropsMixin.WarmThroughputObjectProperty
Go	github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awskinesis#CfnStreamPropsMixin_WarmThroughputObjectProperty
Java	software.amazon.awscdk.cfnpropertymixins.services.kinesis.CfnStreamPropsMixin.WarmThroughputObjectProperty
Python	aws_cdk.cfn_property_mixins.aws_kinesis.CfnStreamPropsMixin.WarmThroughputObjectProperty
TypeScript	@aws-cdk/cfn-property-mixins » aws_kinesis » CfnStreamPropsMixin » WarmThroughputObjectProperty

Represents the warm throughput configuration on the stream.

This is only present for On-Demand Kinesis Data Streams in accounts that have MinimumThroughputBillingCommitment enabled.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_kinesis as kinesis } from '@aws-cdk/cfn-property-mixins';
const warmThroughputObjectProperty: kinesis.CfnStreamPropsMixin.WarmThroughputObjectProperty = {
  currentMiBps: 123,
  targetMiBps: 123,
};

Properties

Name	Type	Description
currentMiBps?	number	The current warm throughput value on the stream.
targetMiBps?	number	The target warm throughput value on the stream.

---

currentMiBps?

Type: number (optional)

The current warm throughput value on the stream.

This is the write throughput in MiBps that the stream is currently scaled to handle.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html#cfn-kinesis-stream-warmthroughputobject-currentmibps

---

targetMiBps?

Type: number (optional)

The target warm throughput value on the stream.

This indicates that the stream is currently scaling towards this target value.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesis-stream-warmthroughputobject.html#cfn-kinesis-stream-warmthroughputobject-targetmibps