AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

StreamDescription

import "github.com/aws/aws-sdk-go/service/kinesis"

type StreamDescription struct { EncryptionType *string `type:"string" enum:"EncryptionType"` EnhancedMonitoring []*EnhancedMetrics `type:"list" required:"true"` HasMoreShards *bool `type:"boolean" required:"true"` KeyId *string `min:"1" type:"string"` RetentionPeriodHours *int64 `min:"1" type:"integer" required:"true"` Shards []*Shard `type:"list" required:"true"` StreamARN *string `min:"1" type:"string" required:"true"` StreamCreationTimestamp *time.Time `type:"timestamp" required:"true"` StreamName *string `min:"1" type:"string" required:"true"` StreamStatus *string `type:"string" required:"true" enum:"StreamStatus"` }

Represents the output for DescribeStream.

EncryptionType

Type: *string

The server-side encryption type used on the stream. This parameter can be one of the following values:

  • NONE: Do not encrypt the records in the stream.

  • KMS: Use server-side encryption on the records in the stream using a customer-managed AWS KMS key.

EnhancedMonitoring

Represents enhanced metrics types.

HasMoreShards

Type: *bool

If set to true, more shards in the stream are available to describe.

HasMoreShards is a required field

KeyId

Type: *string

The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified ARN to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.

  • Key ARN example: arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012

  • Alias ARN example: arn:aws:kms:us-east-1:123456789012:alias/MyAliasName

  • Globally unique key ID example: 12345678-1234-1234-1234-123456789012

  • Alias name example: alias/MyAliasName

  • Master key owned by Kinesis Data Streams: alias/aws/kinesis

RetentionPeriodHours

Type: *int64

The current retention period, in hours.

RetentionPeriodHours is a required field

Shards

A uniquely identified group of data records in a Kinesis data stream.

StreamARN

Type: *string

The Amazon Resource Name (ARN) for the stream being described.

StreamARN is a required field

StreamCreationTimestamp

Type: *time.Time

The approximate time that the stream was created.

StreamCreationTimestamp is a required field

StreamName

Type: *string

The name of the stream being described.

StreamName is a required field

StreamStatus

Type: *string

The current status of the stream being described. The stream status is one of the following states:

  • CREATING - The stream is being created. Kinesis Data Streams immediately returns and sets StreamStatus to CREATING.

  • DELETING - The stream is being deleted. The specified stream is in the DELETING state until Kinesis Data Streams completes the deletion.

  • ACTIVE - The stream exists and is ready for read and write operations or deletion. You should perform read and write operations only on an ACTIVE stream.

  • UPDATING - Shards in the stream are being merged or split. Read and write operations continue to work while the stream is in the UPDATING state.

StreamStatus is a required field

Method

GoString

func (s StreamDescription) GoString() string

GoString returns the string representation

SetEncryptionType

func (s *StreamDescription) SetEncryptionType(v string) *StreamDescription

SetEncryptionType sets the EncryptionType field's value.

SetEnhancedMonitoring

func (s *StreamDescription) SetEnhancedMonitoring(v []*EnhancedMetrics) *StreamDescription

SetEnhancedMonitoring sets the EnhancedMonitoring field's value.

SetHasMoreShards

func (s *StreamDescription) SetHasMoreShards(v bool) *StreamDescription

SetHasMoreShards sets the HasMoreShards field's value.

SetKeyId

func (s *StreamDescription) SetKeyId(v string) *StreamDescription

SetKeyId sets the KeyId field's value.

SetRetentionPeriodHours

func (s *StreamDescription) SetRetentionPeriodHours(v int64) *StreamDescription

SetRetentionPeriodHours sets the RetentionPeriodHours field's value.

SetShards

func (s *StreamDescription) SetShards(v []*Shard) *StreamDescription

SetShards sets the Shards field's value.

SetStreamARN

func (s *StreamDescription) SetStreamARN(v string) *StreamDescription

SetStreamARN sets the StreamARN field's value.

SetStreamCreationTimestamp

func (s *StreamDescription) SetStreamCreationTimestamp(v time.Time) *StreamDescription

SetStreamCreationTimestamp sets the StreamCreationTimestamp field's value.

SetStreamName

func (s *StreamDescription) SetStreamName(v string) *StreamDescription

SetStreamName sets the StreamName field's value.

SetStreamStatus

func (s *StreamDescription) SetStreamStatus(v string) *StreamDescription

SetStreamStatus sets the StreamStatus field's value.

String

func (s StreamDescription) String() string

String returns the string representation

On this page: