Package software.amazon.awscdk.services.kinesis

Interface CfnStream.WarmThroughputObjectProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnStream.WarmThroughputObjectProperty.Jsii$Proxy

Enclosing class:

CfnStream

@Stability(Stable)
public static interface CfnStream.WarmThroughputObjectProperty
extends software.amazon.jsii.JsiiSerializable

Represents the warm throughput configuration on the stream.

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

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.*;
 WarmThroughputObjectProperty warmThroughputObjectProperty = WarmThroughputObjectProperty.builder()
         .currentMiBps(123)
         .targetMiBps(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnStream.WarmThroughputObjectProperty.Builder	A builder for CfnStream.WarmThroughputObjectProperty
static final class	CfnStream.WarmThroughputObjectProperty.Jsii$Proxy	An implementation for CfnStream.WarmThroughputObjectProperty

Method Summary

Modifier and Type	Method	Description
static CfnStream.WarmThroughputObjectProperty.Builder	builder()
default Number	getCurrentMiBps()	The current warm throughput value on the stream.
default Number	getTargetMiBps()	The target warm throughput value on the stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCurrentMiBps

@Stability(Stable)
@Nullable
default Number getCurrentMiBps()

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

getTargetMiBps

@Stability(Stable)
@Nullable
default Number getTargetMiBps()

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

builder

@Stability(Stable)
static CfnStream.WarmThroughputObjectProperty.Builder builder()

Returns:

a CfnStream.WarmThroughputObjectProperty.Builder of CfnStream.WarmThroughputObjectProperty