Class: Aws::IoT::Types::CreateStreamRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::CreateStreamRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass CreateStreamRequest data as a hash:

{
  stream_id: "StreamId", # required
  description: "StreamDescription",
  files: [ # required
    {
      file_id: 1,
      s3_location: {
        bucket: "S3Bucket",
        key: "S3Key",
        version: "S3Version",
      },
    },
  ],
  role_arn: "RoleArn", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue",
    },
  ],
}

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #description ⇒ String

  A description of the stream.

• #files ⇒ Array<Types::StreamFile>

  The files to stream.

• #role_arn ⇒ String

  An IAM role that allows the IoT service principal to access your S3 files.

• #stream_id ⇒ String

  The stream ID.

• #tags ⇒ Array<Types::Tag>

  Metadata which can be used to manage streams.

Instance Attribute Details

#description ⇒ String

A description of the stream.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4834

class CreateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#files ⇒ Array<Types::StreamFile>

The files to stream.

Returns:

• (Array<Types::StreamFile>)

# File 'lib/aws-sdk-iot/types.rb', line 4834

class CreateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

An IAM role that allows the IoT service principal to access your S3 files.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4834

class CreateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stream_id ⇒ String

The stream ID.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 4834

class CreateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Array<Types::Tag>

Metadata which can be used to manage streams.

Returns:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-iot/types.rb', line 4834

class CreateStreamRequest < Struct.new(
  :stream_id,
  :description,
  :files,
  :role_arn,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end