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.

CreateStreamInput

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

type CreateStreamInput struct { DataRetentionInHours *int64 `type:"integer"` DeviceName *string `min:"1" type:"string"` KmsKeyId *string `min:"1" type:"string"` MediaType *string `min:"1" type:"string"` StreamName *string `min:"1" type:"string" required:"true"` Tags map[string]*string `min:"1" type:"map"` }

DataRetentionInHours

Type: *int64

The number of hours that you want to retain the data in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.

The default value is 0, indicating that the stream does not persist data.

When the DataRetentionInHours value is 0, consumers can still consume the fragments that remain in the service host buffer, which has a retention time limit of 5 minutes and a retention memory limit of 200 MB. Fragments are removed from the buffer when either limit is reached.

DeviceName

Type: *string

The name of the device that is writing to the stream.

In the current implementation, Kinesis Video Streams does not use this name.

KmsKeyId

Type: *string

The ID of the AWS Key Management Service (AWS KMS) key that you want Kinesis Video Streams to use to encrypt stream data.

If no key ID is specified, the default, Kinesis Video-managed key (aws/kinesisvideo) is used.

For more information, see DescribeKey (https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html#API_DescribeKey_RequestParameters).

MediaType

Type: *string

The media type of the stream. Consumers of the stream can use this information when processing the stream. For more information about media types, see Media Types (http://www.iana.org/assignments/media-types/media-types.xhtml). If you choose to specify the MediaType, see Naming Requirements (https://tools.ietf.org/html/rfc6838#section-4.2) for guidelines.

This parameter is optional; the default value is null (or empty in JSON).

StreamName

Type: *string

A name for the stream that you are creating.

The stream name is an identifier for the stream, and must be unique for each account and region.

StreamName is a required field

Tags

Type: map[string]*string

A list of tags to associate with the specified stream. Each tag is a key-value pair (the value is optional).

Method

GoString

func (s CreateStreamInput) GoString() string

GoString returns the string representation

SetDataRetentionInHours

func (s *CreateStreamInput) SetDataRetentionInHours(v int64) *CreateStreamInput

SetDataRetentionInHours sets the DataRetentionInHours field's value.

SetDeviceName

func (s *CreateStreamInput) SetDeviceName(v string) *CreateStreamInput

SetDeviceName sets the DeviceName field's value.

SetKmsKeyId

func (s *CreateStreamInput) SetKmsKeyId(v string) *CreateStreamInput

SetKmsKeyId sets the KmsKeyId field's value.

SetMediaType

func (s *CreateStreamInput) SetMediaType(v string) *CreateStreamInput

SetMediaType sets the MediaType field's value.

SetStreamName

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

SetStreamName sets the StreamName field's value.

SetTags

func (s *CreateStreamInput) SetTags(v map[string]*string) *CreateStreamInput

SetTags sets the Tags field's value.

String

func (s CreateStreamInput) String() string

String returns the string representation

Validate

func (s *CreateStreamInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: