Class GetStreamResult


  • public final class GetStreamResult
    extends java.lang.Object
    • Method Detail

      • arn

        public java.lang.String arn()
        Returns:
        ARN of the Kinesis Stream (same as `id`).
      • closedShards

        public java.util.List<java.lang.String> closedShards()
        Returns:
        List of shard IDs in the CLOSED state. See [Shard State](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing) for more.
      • creationTimestamp

        public java.lang.Integer creationTimestamp()
        Returns:
        Approximate UNIX timestamp that the stream was created.
      • encryptionType

        public java.lang.String encryptionType()
        Returns:
        Encryption type used.
      • id

        public java.lang.String id()
        Returns:
        The provider-assigned unique ID for this managed resource.
      • kmsKeyId

        public java.lang.String kmsKeyId()
        Returns:
        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.
      • maxRecordSizeInKib

        public java.lang.Integer maxRecordSizeInKib()
        Returns:
        Maximum size for a single data record in KiB.
      • name

        public java.lang.String name()
        Returns:
        Name of the Kinesis Stream.
      • openShards

        public java.util.List<java.lang.String> openShards()
        Returns:
        List of shard IDs in the OPEN state. See [Shard State](https://docs.aws.amazon.com/streams/latest/dev/kinesis-using-sdk-java-after-resharding.html#kinesis-using-sdk-java-resharding-data-routing) for more.
      • region

        public java.lang.String region()
      • retentionPeriod

        public java.lang.Integer retentionPeriod()
        Returns:
        Length of time (in hours) data records are accessible after they are added to the stream.
      • shardLevelMetrics

        public java.util.List<java.lang.String> shardLevelMetrics()
        Returns:
        List of shard-level CloudWatch metrics which are enabled for the stream. See [Monitoring with CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) for more.
      • status

        public java.lang.String status()
        Returns:
        Current status of the stream. The stream status is one of CREATING, DELETING, ACTIVE, or UPDATING.
      • streamModeDetails

        public java.util.List<GetStreamStreamModeDetail> streamModeDetails()
        Returns:
        [Capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
      • tags

        public java.util.Map<java.lang.String,​java.lang.String> tags()
        Returns:
        Map of tags to assigned to the stream.
      • warmThroughputs

        public java.util.List<GetStreamWarmThroughput> warmThroughputs()
        Returns:
        Warm throughput in MB/s for the stream. Detailed below.