Class: Aws::IVSRealTime::Types::CreateIngestConfigurationRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributes ⇒ Hash<String,String>

Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

  • (Hash<String,String>) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#ingest_protocol ⇒ String

Type of ingest protocol that the user employs to broadcast. If this is set to RTMP, insecureIngest must be set to true.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#insecure_ingest ⇒ Boolean

Whether the stage allows insecure RTMP ingest. This must be set to true, if ingestProtocol is set to RTMP. Default: false.

Returns:

  • (Boolean) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

Optional name that can be specified for the IngestConfiguration being created.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the stage with which the IngestConfiguration is associated.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.

Returns:

  • (Hash<String,String>) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#user_id ⇒ String

Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text. This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.

Returns:

  • (String) 


294
295
296
297
298
299
300
301
302
303
304
 
# File 'gems/aws-sdk-ivsrealtime/lib/aws-sdk-ivsrealtime/types.rb', line 294

class CreateIngestConfigurationRequest < Struct.new(
  :name,
  :stage_arn,
  :user_id,
  :attributes,
  :ingest_protocol,
  :insecure_ingest,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end