Class: AWSCDK::MediaLive::CfnInput

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSMedialive::IInputRef
Defined in:
media_live/cfn_input.rb

Overview

The AWS::MediaLive::Input resource is a MediaLive resource type that creates an input.

A MediaLive input holds information that describes how the MediaLive channel is connected to the upstream system that is providing the source content that is to be transcoded.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnInput

Create a new AWS::MediaLive::Input.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::MediaLive::CfnInputProps, nil) (defaults to: nil) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'media_live/cfn_input.rb', line 20

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInputProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbklucHV0UHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_input(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'media_live/cfn_input.rb', line 92

def self.arn_for_input(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWxpdmUuSUlucHV0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnInput", "arnForInput", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


225
226
227
 
# File 'media_live/cfn_input.rb', line 225

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_medialive.CfnInput", "CFN_RESOURCE_TYPE_NAME")
end

.from_input_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSMedialive::IInputRef

Creates a new IInputRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



103
104
105
106
107
108
 
# File 'media_live/cfn_input.rb', line 103

def self.from_input_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnInput", "fromInputArn", [scope, id, arn])
end

.from_input_id(scope, id, input_id) ⇒ AWSCDK::Interfaces::AWSMedialive::IInputRef

Creates a new IInputRef from a inputId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • input_id (String)

Returns:



116
117
118
119
120
121
 
# File 'media_live/cfn_input.rb', line 116

def self.from_input_id(scope, id, input_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(input_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnInput", "fromInputId", [scope, id, input_id])
end

.is_cfn_input(x) ⇒ Boolean

Checks whether the given object is a CfnInput.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


127
128
129
130
 
# File 'media_live/cfn_input.rb', line 127

def self.is_cfn_input(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_medialive.CfnInput", "isCfnInput", [x])
end

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'media_live/cfn_input.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_destinations => { kind: :property, name: "attrDestinations", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_sources => { kind: :property, name: "attrSources", is_optional: false },
    :input_ref => { kind: :property, name: "inputRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: false },
    :destinations => { kind: :property, name: "destinations", is_optional: true },
    :input_devices => { kind: :property, name: "inputDevices", is_optional: true },
    :input_network_location => { kind: :property, name: "inputNetworkLocation", is_optional: true },
    :input_security_groups => { kind: :property, name: "inputSecurityGroups", is_optional: true },
    :media_connect_flows => { kind: :property, name: "mediaConnectFlows", is_optional: true },
    :multicast_settings => { kind: :property, name: "multicastSettings", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :role_arn => { kind: :property, name: "roleArn", is_optional: true },
    :router_settings => { kind: :property, name: "routerSettings", is_optional: true },
    :sdi_sources => { kind: :property, name: "sdiSources", is_optional: true },
    :smpte2110_receiver_group_settings => { kind: :property, name: "smpte2110ReceiverGroupSettings", is_optional: true },
    :sources => { kind: :property, name: "sources", is_optional: true },
    :srt_settings => { kind: :property, name: "srtSettings", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :vpc => { kind: :property, name: "vpc", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



498
499
500
501
 
# File 'media_live/cfn_input.rb', line 498

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



510
511
512
513
 
# File 'media_live/cfn_input.rb', line 510

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



520
521
522
523
 
# File 'media_live/cfn_input.rb', line 520

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



531
532
533
534
535
 
# File 'media_live/cfn_input.rb', line 531

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


588
589
590
591
592
 
# File 'media_live/cfn_input.rb', line 588

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



598
599
600
601
 
# File 'media_live/cfn_input.rb', line 598

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



610
611
612
613
614
 
# File 'media_live/cfn_input.rb', line 610

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



623
624
625
626
 
# File 'media_live/cfn_input.rb', line 623

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



645
646
647
648
649
650
 
# File 'media_live/cfn_input.rb', line 645

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the MediaLive input.

For example: arn:aws:medialive:us-west-1:111122223333:medialive:input:1234567. MediaLive creates this ARN when it creates the input.

Returns:

  • (String) 


234
235
236
 
# File 'media_live/cfn_input.rb', line 234

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_destinations ⇒ Array<String>

For a push input, the the destination or destinations for the input.

The destinations are the URLs of locations on MediaLive where the upstream system pushes the content to, for this input. MediaLive creates these addresses when it creates the input.

Returns:

  • (Array<String>) 


243
244
245
 
# File 'media_live/cfn_input.rb', line 243

def attr_destinations()
  jsii_get_property("attrDestinations")
end

#attr_id ⇒ String

The unique ID for the device.

Returns:

  • (String) 


250
251
252
 
# File 'media_live/cfn_input.rb', line 250

def attr_id()
  jsii_get_property("attrId")
end

#attr_sources ⇒ Array<String>

For a pull input, the source or sources for the input.

The sources are the URLs of locations on the upstream system where MediaLive pulls the content from, for this input. You included these URLs in the create request.

Returns:

  • (Array<String>) 


259
260
261
 
# File 'media_live/cfn_input.rb', line 259

def attr_sources()
  jsii_get_property("attrSources")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



178
179
180
 
# File 'media_live/cfn_input.rb', line 178

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


183
184
185
 
# File 'media_live/cfn_input.rb', line 183

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


654
655
656
657
 
# File 'media_live/cfn_input.rb', line 654

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


188
189
190
 
# File 'media_live/cfn_input.rb', line 188

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


195
196
197
 
# File 'media_live/cfn_input.rb', line 195

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


140
141
142
 
# File 'media_live/cfn_input.rb', line 140

def creation_stack()
  jsii_get_property("creationStack")
end

#destinations ⇒ AWSCDK::IResolvable, ...

Settings that apply only if the input is a push type of input.

Returns:



292
293
294
 
# File 'media_live/cfn_input.rb', line 292

def destinations()
  jsii_get_property("destinations")
end

#destinations=(value) ⇒ Object 



296
297
298
299
 
# File 'media_live/cfn_input.rb', line 296

def destinations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbklucHV0LklucHV0RGVzdGluYXRpb25SZXF1ZXN0UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "destinations") unless value.nil?
  jsii_set_property("destinations", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



200
201
202
 
# File 'media_live/cfn_input.rb', line 200

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



667
668
669
670
671
 
# File 'media_live/cfn_input.rb', line 667

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



678
679
680
681
 
# File 'media_live/cfn_input.rb', line 678

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#input_devices ⇒ AWSCDK::IResolvable, ...

Settings that apply only if the input is an Elemental Link input.

Returns:



304
305
306
 
# File 'media_live/cfn_input.rb', line 304

def input_devices()
  jsii_get_property("inputDevices")
end

#input_devices=(value) ⇒ Object 



308
309
310
311
 
# File 'media_live/cfn_input.rb', line 308

def input_devices=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbklucHV0LklucHV0RGV2aWNlU2V0dGluZ3NQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "inputDevices") unless value.nil?
  jsii_set_property("inputDevices", value)
end

#input_network_location ⇒ String?

Returns:

  • (String, nil) 


314
315
316
 
# File 'media_live/cfn_input.rb', line 314

def input_network_location()
  jsii_get_property("inputNetworkLocation")
end

#input_network_location=(value) ⇒ Object 



318
319
320
321
 
# File 'media_live/cfn_input.rb', line 318

def input_network_location=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputNetworkLocation") unless value.nil?
  jsii_set_property("inputNetworkLocation", value)
end

#input_ref ⇒ AWSCDK::Interfaces::AWSMedialive::InputReference

A reference to a Input resource.

Returns:



266
267
268
 
# File 'media_live/cfn_input.rb', line 266

def input_ref()
  jsii_get_property("inputRef")
end

#input_security_groups ⇒ Array<String>?

The list of input security groups (referenced by IDs) to attach to the input if the input is a push type.

Returns:

  • (Array<String>, nil) 


326
327
328
 
# File 'media_live/cfn_input.rb', line 326

def input_security_groups()
  jsii_get_property("inputSecurityGroups")
end

#input_security_groups=(value) ⇒ Object 



330
331
332
333
 
# File 'media_live/cfn_input.rb', line 330

def input_security_groups=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "inputSecurityGroups") unless value.nil?
  jsii_set_property("inputSecurityGroups", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



748
749
750
751
 
# File 'media_live/cfn_input.rb', line 748

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


152
153
154
 
# File 'media_live/cfn_input.rb', line 152

def logical_id()
  jsii_get_property("logicalId")
end

#media_connect_flows ⇒ AWSCDK::IResolvable, ...

Settings that apply only if the input is a MediaConnect input.

Returns:



338
339
340
 
# File 'media_live/cfn_input.rb', line 338

def media_connect_flows()
  jsii_get_property("mediaConnectFlows")
end

#media_connect_flows=(value) ⇒ Object 



342
343
344
345
 
# File 'media_live/cfn_input.rb', line 342

def media_connect_flows=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbklucHV0Lk1lZGlhQ29ubmVjdEZsb3dSZXF1ZXN0UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "mediaConnectFlows") unless value.nil?
  jsii_set_property("mediaConnectFlows", value)
end

#multicast_settings ⇒ AWSCDK::IResolvable, ...

Returns:



348
349
350
 
# File 'media_live/cfn_input.rb', line 348

def multicast_settings()
  jsii_get_property("multicastSettings")
end

#multicast_settings=(value) ⇒ Object 



352
353
354
355
356
 
# File 'media_live/cfn_input.rb', line 352

def multicast_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInput::MulticastSettingsCreateRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuSW5wdXQuTXVsdGljYXN0U2V0dGluZ3NDcmVhdGVSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "multicastSettings") unless value.nil?
  jsii_set_property("multicastSettings", value)
end

#name ⇒ String?

A name for the input.

Returns:

  • (String, nil) 


361
362
363
 
# File 'media_live/cfn_input.rb', line 361

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



365
366
367
368
 
# File 'media_live/cfn_input.rb', line 365

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


135
136
137
 
# File 'media_live/cfn_input.rb', line 135

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



689
690
691
 
# File 'media_live/cfn_input.rb', line 689

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



696
697
698
 
# File 'media_live/cfn_input.rb', line 696

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



489
490
491
492
 
# File 'media_live/cfn_input.rb', line 489

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


171
172
173
 
# File 'media_live/cfn_input.rb', line 171

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



707
708
709
710
 
# File 'media_live/cfn_input.rb', line 707

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


714
715
716
717
 
# File 'media_live/cfn_input.rb', line 714

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



724
725
726
727
728
 
# File 'media_live/cfn_input.rb', line 724

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#role_arn ⇒ String?

The IAM role for MediaLive to assume when creating a MediaConnect input or Amazon VPC input.

Returns:

  • (String, nil) 


373
374
375
 
# File 'media_live/cfn_input.rb', line 373

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



377
378
379
380
 
# File 'media_live/cfn_input.rb', line 377

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn") unless value.nil?
  jsii_set_property("roleArn", value)
end

#router_settings ⇒ AWSCDK::IResolvable, ...

Returns:



383
384
385
 
# File 'media_live/cfn_input.rb', line 383

def router_settings()
  jsii_get_property("routerSettings")
end

#router_settings=(value) ⇒ Object 



387
388
389
390
391
 
# File 'media_live/cfn_input.rb', line 387

def router_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInput::RouterSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuSW5wdXQuUm91dGVyU2V0dGluZ3NQcm9wZXJ0eSJ9XX19")), "routerSettings") unless value.nil?
  jsii_set_property("routerSettings", value)
end

#sdi_sources ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


394
395
396
 
# File 'media_live/cfn_input.rb', line 394

def sdi_sources()
  jsii_get_property("sdiSources")
end

#sdi_sources=(value) ⇒ Object 



398
399
400
401
 
# File 'media_live/cfn_input.rb', line 398

def sdi_sources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "sdiSources") unless value.nil?
  jsii_set_property("sdiSources", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



733
734
735
 
# File 'media_live/cfn_input.rb', line 733

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#smpte2110_receiver_group_settings ⇒ AWSCDK::IResolvable, ...

Returns:



404
405
406
 
# File 'media_live/cfn_input.rb', line 404

def smpte2110_receiver_group_settings()
  jsii_get_property("smpte2110ReceiverGroupSettings")
end

#smpte2110_receiver_group_settings=(value) ⇒ Object 



408
409
410
411
412
 
# File 'media_live/cfn_input.rb', line 408

def smpte2110_receiver_group_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInput::Smpte2110ReceiverGroupSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuSW5wdXQuU21wdGUyMTEwUmVjZWl2ZXJHcm91cFNldHRpbmdzUHJvcGVydHkifV19fQ==")), "smpte2110ReceiverGroupSettings") unless value.nil?
  jsii_set_property("smpte2110ReceiverGroupSettings", value)
end

#sources ⇒ AWSCDK::IResolvable, ...

Settings that apply only if the input is a pull type of input.

Returns:



417
418
419
 
# File 'media_live/cfn_input.rb', line 417

def sources()
  jsii_get_property("sources")
end

#sources=(value) ⇒ Object 



421
422
423
424
 
# File 'media_live/cfn_input.rb', line 421

def sources=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFsaXZlLkNmbklucHV0LklucHV0U291cmNlUmVxdWVzdFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "sources") unless value.nil?
  jsii_set_property("sources", value)
end

#srt_settings ⇒ AWSCDK::IResolvable, ...

Returns:



427
428
429
 
# File 'media_live/cfn_input.rb', line 427

def srt_settings()
  jsii_get_property("srtSettings")
end

#srt_settings=(value) ⇒ Object 



431
432
433
434
435
 
# File 'media_live/cfn_input.rb', line 431

def srt_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInput::SrtSettingsRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuSW5wdXQuU3J0U2V0dGluZ3NSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "srtSettings") unless value.nil?
  jsii_set_property("srtSettings", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



161
162
163
 
# File 'media_live/cfn_input.rb', line 161

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



273
274
275
 
# File 'media_live/cfn_input.rb', line 273

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Object

A collection of tags for this input.

Returns:

  • (Object) 


280
281
282
 
# File 'media_live/cfn_input.rb', line 280

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



284
285
286
287
 
# File 'media_live/cfn_input.rb', line 284

def tags_raw=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "tagsRaw")
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



465
466
467
 
# File 'media_live/cfn_input.rb', line 465

def to_string()
  jsii_call_method("toString", [])
end

#type ⇒ String?

The type for this input.

Returns:

  • (String, nil) 


440
441
442
 
# File 'media_live/cfn_input.rb', line 440

def type()
  jsii_get_property("type")
end

#type=(value) ⇒ Object 



444
445
446
447
 
# File 'media_live/cfn_input.rb', line 444

def type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless value.nil?
  jsii_set_property("type", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


208
209
210
 
# File 'media_live/cfn_input.rb', line 208

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


218
219
220
 
# File 'media_live/cfn_input.rb', line 218

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


739
740
741
742
 
# File 'media_live/cfn_input.rb', line 739

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc ⇒ AWSCDK::IResolvable, ...

Settings that apply only if the input is an push input where the source is on Amazon VPC.

Returns:



452
453
454
 
# File 'media_live/cfn_input.rb', line 452

def vpc()
  jsii_get_property("vpc")
end

#vpc=(value) ⇒ Object 



456
457
458
459
460
 
# File 'media_live/cfn_input.rb', line 456

def vpc=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnInput::InputVPCRequestProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuSW5wdXQuSW5wdXRWcGNSZXF1ZXN0UHJvcGVydHkifV19fQ==")), "vpc") unless value.nil?
  jsii_set_property("vpc", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


478
479
480
481
482
483
 
# File 'media_live/cfn_input.rb', line 478

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end