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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/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 collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#descriptionString

A description of the stream.

Returns:

  • (String)


4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4815

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

#filesArray<Types::StreamFile>

The files to stream.

Returns:



4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4815

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

#role_arnString

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

Returns:

  • (String)


4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4815

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

#stream_idString

The stream ID.

Returns:

  • (String)


4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4815

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

#tagsArray<Types::Tag>

Metadata which can be used to manage streams.

Returns:



4815
4816
4817
4818
4819
4820
4821
4822
4823
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 4815

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