/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::KinesisVideo::CreateStream

NAME

Paws::KinesisVideo::CreateStream - Arguments for method CreateStream on Paws::KinesisVideo

DESCRIPTION

This class represents the parameters used for calling the method CreateStream on the Amazon Kinesis Video Streams service. Use the attributes of this class as arguments to method CreateStream.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateStream.

SYNOPSIS

my $kinesisvideo = Paws->service('KinesisVideo');
my $CreateStreamOutput = $kinesisvideo->CreateStream(
  StreamName           => 'MyStreamName',
  DataRetentionInHours => 1,                 # OPTIONAL
  DeviceName           => 'MyDeviceName',    # OPTIONAL
  KmsKeyId             => 'MyKmsKeyId',      # OPTIONAL
  MediaType            => 'MyMediaType',     # OPTIONAL
  Tags                 => {
    'MyTagKey' => 'MyTagValue',    # key: min: 1, max: 128, value: max: 256
  },    # OPTIONAL
);

# Results:
my $StreamARN = $CreateStreamOutput->StreamARN;

# Returns a L<Paws::KinesisVideo::CreateStreamOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/kinesisvideo/CreateStream

ATTRIBUTES

DataRetentionInHours => Int

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 => Str

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

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

KmsKeyId => Str

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 => Str

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.

Example valid values include "video/h264" and "video/h264,audio/aac".

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

REQUIRED StreamName => Str

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.

Tags => Paws::KinesisVideo::ResourceTags

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

SEE ALSO

This class forms part of Paws, documenting arguments for method CreateStream in Paws::KinesisVideo

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues