StreamArgs class
The set of arguments for Stream. The set of arguments for Stream.
Constructors
-
StreamArgs({Input<
String?> ? arn, Input<String?> ? encryptionType, Input<bool?> ? enforceConsumerDeletion, Input<String?> ? kmsKeyId, Input<int?> ? maxRecordSizeInKib, Input<String?> ? name, Input<String?> ? region, Input<int?> ? retentionPeriod, Input<int?> ? shardCount, Input<List< ? shardLevelMetrics, Input<String> ?>StreamStreamModeDetails?> ? streamModeDetails, Input<Map< ? tags, Input<String, String> ?>int?> ? warmThroughputMibPs}) -
Creates a new StreamArgs.
arnARN specifying the stream (same asid).encryptionTypeThe encryption type to use. The only acceptable values areNONEorKMS. The default value isNONE.enforceConsumerDeletionA boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value isfalse.kmsKeyIdThe identifier for the customer-managed KMS key to use for encryption. This can be a Key ID (UUID), a Key ARN, an Alias Name (prefixed withalias/), or an Alias ARN. You can also use a master key owned by Kinesis Data Streams by specifying the aliasaws/kinesis.maxRecordSizeInKibThe maximum size for a single data record in KiB. The minimum value is 1024. The maximum value is 10240.nameA name to identify the stream. This is unique to the AWS account and region the Stream is created in.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.retentionPeriodLength of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.shardCountThe number of shards that the stream will use. If thestreamModeisPROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.shardLevelMetricsA list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.streamModeDetailsIndicates the capacity mode of the data stream. Detailed below.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.warmThroughputMibPsTarget warm throughput in MB/s that the stream should be scaled to handle.const -
StreamArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
arn
→ Input<
String?> ? -
ARN specifying the stream (same as
id).final -
encryptionType
→ Input<
String?> ? -
The encryption type to use. The only acceptable values are
NONEorKMS. The default value isNONE.final -
enforceConsumerDeletion
→ Input<
bool?> ? -
A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is
false.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
kmsKeyId
→ Input<
String?> ? -
The identifier for the customer-managed KMS key to use for encryption. This can be a Key ID (UUID), a Key ARN, an Alias Name (prefixed with
alias/), or an Alias ARN. You can also use a master key owned by Kinesis Data Streams by specifying the aliasaws/kinesis.final -
maxRecordSizeInKib
→ Input<
int?> ? -
The maximum size for a single data record in KiB. The minimum value is 1024. The maximum value is 10240.
final
-
name
→ Input<
String?> ? -
A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
final
-
region
→ Input<
String?> ? -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
-
retentionPeriod
→ Input<
int?> ? -
Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
The number of shards that the stream will use. If the
streamModeisPROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.final -
A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
final
-
streamModeDetails
→ Input<
StreamStreamModeDetails?> ? -
Indicates the capacity mode of the data stream. Detailed below.
final
-
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
warmThroughputMibPs
→ Input<
int?> ? -
Target warm throughput in MB/s that the stream should be scaled to handle.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited