GetStreamResult class
Result data returned by getStream.
Constructors
-
GetStreamResult({String? arn, List<
String> ? closedShards, int? creationTimestamp, String? encryptionType, String? id, String? kmsKeyId, int? maxRecordSizeInKib, String? name, List<String> ? openShards, String? region, int? retentionPeriod, List<String> ? shardLevelMetrics, String? status, List<GetStreamStreamModeDetail> ? streamModeDetails, Map<String, String> ? tags, List<GetStreamWarmThroughput> ? warmThroughputs}) -
Creates a new GetStreamResult.
arnARN of the Kinesis Stream (same asid).closedShardsList of shard ids in the CLOSED state. See Shard State for more.creationTimestampApproximate UNIX timestamp that the stream was created.encryptionTypeEncryption type used.idThe provider-assigned unique ID for this managed resource.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.maxRecordSizeInKibThe maximum size for a single data record in KiB.nameName of the Kinesis Stream.openShardsList of shard ids in the OPEN state. See Shard State for more.regionOptional.retentionPeriodLength of time (in hours) data records are accessible after they are added to the stream.shardLevelMetricsList of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.statusCurrent status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING. streamModeDetails Capacity mode of the data stream. Detailed below.tagsMap of tags to assigned to the stream.warmThroughputsWarm throughput in MB/s for the stream. Detailed below.const -
GetStreamResult.fromMap(Map<
String, dynamic> map) -
factory
Properties
- arn → String?
-
ARN of the Kinesis Stream (same as
id).final -
closedShards
→ List<
String> ? -
List of shard ids in the CLOSED state. See Shard State for more.
final
- creationTimestamp → int?
-
Approximate UNIX timestamp that the stream was created.
final
- encryptionType → String?
-
Encryption type used.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → String?
-
The provider-assigned unique ID for this managed resource.
final
- kmsKeyId → 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.final - maxRecordSizeInKib → int?
-
The maximum size for a single data record in KiB.
final
- name → String?
-
Name of the Kinesis Stream.
final
-
openShards
→ List<
String> ? -
List of shard ids in the OPEN state. See Shard State for more.
final
- region → String?
-
final
- retentionPeriod → int?
-
Length of time (in hours) data records are accessible after they are added to the stream.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
List of shard-level CloudWatch metrics which are enabled for the stream. See Monitoring with CloudWatch for more.
final
- status → String?
-
Current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
final
-
streamModeDetails
→ List<
GetStreamStreamModeDetail> ? -
Capacity mode of the data stream. Detailed below.
final
-
Map of tags to assigned to the stream.
final
-
warmThroughputs
→ List<
GetStreamWarmThroughput> ? -
Warm throughput in MB/s for the stream. Detailed below.
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