Class: AWSCDK::IVS::CfnIngestConfigurationProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ivs/cfn_ingest_configuration_props.rb

Overview

Properties for defining a CfnIngestConfiguration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ingest_protocol: nil, insecure_ingest: nil, name: nil, stage_arn: nil, tags: nil, user_id: nil) ⇒ CfnIngestConfigurationProps

Returns a new instance of CfnIngestConfigurationProps.

Parameters:

  • ingest_protocol (String, nil) (defaults to: nil) —

    Type of ingest protocol that the user employs for broadcasting.

  • insecure_ingest (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

    Whether the channel allows insecure RTMP ingest.

  • name (String, nil) (defaults to: nil) —

    Ingest name.

  • stage_arn (String, nil) (defaults to: nil) —

    ARN of the stage with which the IngestConfiguration is associated.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    An array of key-value pairs to apply to this resource.

  • user_id (String, nil) (defaults to: nil) —

    Customer-assigned name to help identify the participant using the IngestConfiguration;



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 15

def initialize(ingest_protocol: nil, insecure_ingest: nil, name: nil, stage_arn: nil, tags: nil, user_id: nil)
  @ingest_protocol = ingest_protocol
  Jsii::Type.check_type(@ingest_protocol, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ingestProtocol") unless @ingest_protocol.nil?
  @insecure_ingest = insecure_ingest
  Jsii::Type.check_type(@insecure_ingest, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "insecureIngest") unless @insecure_ingest.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @stage_arn = stage_arn
  Jsii::Type.check_type(@stage_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stageArn") unless @stage_arn.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @user_id = user_id
  Jsii::Type.check_type(@user_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "userId") unless @user_id.nil?
end

Instance Attribute Details

#ingest_protocol ⇒ String? (readonly)

Note:

Default: - "RTMPS"

Type of ingest protocol that the user employs for broadcasting.

Returns:

  • (String, nil)

See Also:



35
36
37
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 35

def ingest_protocol
  @ingest_protocol
end

#insecure_ingest ⇒ Boolean, ... (readonly)

Note:

Default: - false

Whether the channel allows insecure RTMP ingest.

Default: false .

Returns:

See Also:



43
44
45
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 43

def insecure_ingest
  @insecure_ingest
end

#name ⇒ String? (readonly)

Note:

Default: - "-"

Ingest name.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 49

def name
  @name
end

#stage_arn ⇒ String? (readonly)

Note:

Default: - ""

ARN of the stage with which the IngestConfiguration is associated.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 55

def stage_arn
  @stage_arn
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

An array of key-value pairs to apply to this resource.

Returns:

See Also:



60
61
62
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 60

def tags
  @tags
end

#user_id ⇒ String? (readonly)

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, nil)

See Also:



67
68
69
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 67

def user_id
  @user_id
end

Class Method Details

.jsii_properties ⇒ Object 



69
70
71
72
73
74
75
76
77
78
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 69

def self.jsii_properties
  {
    :ingest_protocol => "ingestProtocol",
    :insecure_ingest => "insecureIngest",
    :name => "name",
    :stage_arn => "stageArn",
    :tags => "tags",
    :user_id => "userId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'ivs/cfn_ingest_configuration_props.rb', line 80

def to_jsii
  result = {}
  result.merge!({
    "ingestProtocol" => @ingest_protocol,
    "insecureIngest" => @insecure_ingest,
    "name" => @name,
    "stageArn" => @stage_arn,
    "tags" => @tags,
    "userId" => @user_id,
  })
  result.compact
end