Class: AWSCDK::MediaConnect::CfnRouterInput

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSMediaconnect::IRouterInputRef
Defined in:
media_connect/cfn_router_input.rb

Overview

Represents a router input in AWS Elemental MediaConnect that is used to ingest content to be transmitted to router outputs.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRouterInput

Create a new AWS::MediaConnect::RouterInput.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::MediaConnect::CfnRouterInputProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'media_connect/cfn_router_input.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnRouterInputProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfbWVkaWFjb25uZWN0LkNmblJvdXRlcklucHV0UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_router_input(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'media_connect/cfn_router_input.rb', line 89

def self.arn_for_router_input(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWNvbm5lY3QuSVJvdXRlcklucHV0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconnect.CfnRouterInput", "arnForRouterInput", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


196
197
198
 
# File 'media_connect/cfn_router_input.rb', line 196

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

.is_cfn_router_input(x) ⇒ Boolean

Checks whether the given object is a CfnRouterInput.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


98
99
100
101
 
# File 'media_connect/cfn_router_input.rb', line 98

def self.is_cfn_router_input(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconnect.CfnRouterInput", "isCfnRouterInput", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
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
 
# File 'media_connect/cfn_router_input.rb', line 26

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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_input_type => { kind: :property, name: "attrInputType", is_optional: false },
    :attr_ip_address => { kind: :property, name: "attrIpAddress", is_optional: false },
    :attr_maintenance_type => { kind: :property, name: "attrMaintenanceType", is_optional: false },
    :attr_routed_outputs => { kind: :property, name: "attrRoutedOutputs", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :router_input_ref => { kind: :property, name: "routerInputRef", is_optional: false },
    :configuration => { kind: :property, name: "configuration", is_optional: false },
    :maximum_bitrate => { kind: :property, name: "maximumBitrate", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :routing_scope => { kind: :property, name: "routingScope", is_optional: false },
    :tier => { kind: :property, name: "tier", is_optional: false },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :maintenance_configuration => { kind: :property, name: "maintenanceConfiguration", is_optional: true },
    :region_name => { kind: :property, name: "regionName", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :transit_encryption => { kind: :property, name: "transitEncryption", 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.



437
438
439
440
 
# File 'media_connect/cfn_router_input.rb', line 437

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:



449
450
451
452
 
# File 'media_connect/cfn_router_input.rb', line 449

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:



459
460
461
462
 
# File 'media_connect/cfn_router_input.rb', line 459

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:



470
471
472
473
474
 
# File 'media_connect/cfn_router_input.rb', line 470

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.


527
528
529
530
531
 
# File 'media_connect/cfn_router_input.rb', line 527

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.



537
538
539
540
 
# File 'media_connect/cfn_router_input.rb', line 537

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.



549
550
551
552
553
 
# File 'media_connect/cfn_router_input.rb', line 549

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:



562
563
564
565
 
# File 'media_connect/cfn_router_input.rb', line 562

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:



584
585
586
587
588
589
 
# File 'media_connect/cfn_router_input.rb', line 584

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 Amazon Resource Name (ARN) of the router input.

Returns:

  • (String) 


203
204
205
 
# File 'media_connect/cfn_router_input.rb', line 203

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The timestamp when the router input was created.

Returns:

  • (String) 


210
211
212
 
# File 'media_connect/cfn_router_input.rb', line 210

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_id ⇒ String

The unique identifier of the router input.

Returns:

  • (String) 


217
218
219
 
# File 'media_connect/cfn_router_input.rb', line 217

def attr_id()
  jsii_get_property("attrId")
end

#attr_input_type ⇒ String

The type of the router input.

Returns:

  • (String) 


224
225
226
 
# File 'media_connect/cfn_router_input.rb', line 224

def attr_input_type()
  jsii_get_property("attrInputType")
end

#attr_ip_address ⇒ String

The IP address of the router input.

Returns:

  • (String) 


231
232
233
 
# File 'media_connect/cfn_router_input.rb', line 231

def attr_ip_address()
  jsii_get_property("attrIpAddress")
end

#attr_maintenance_type ⇒ String

The type of maintenance configuration applied to this router input.

Returns:

  • (String) 


238
239
240
 
# File 'media_connect/cfn_router_input.rb', line 238

def attr_maintenance_type()
  jsii_get_property("attrMaintenanceType")
end

#attr_routed_outputs ⇒ Numeric

The number of router outputs associated with the router input.

Returns:

  • (Numeric) 


245
246
247
 
# File 'media_connect/cfn_router_input.rb', line 245

def attr_routed_outputs()
  jsii_get_property("attrRoutedOutputs")
end

#attr_state ⇒ String

The current state of the router input.

Returns:

  • (String) 


252
253
254
 
# File 'media_connect/cfn_router_input.rb', line 252

def attr_state()
  jsii_get_property("attrState")
end

#attr_updated_at ⇒ String

The timestamp when the router input was last updated.

Returns:

  • (String) 


259
260
261
 
# File 'media_connect/cfn_router_input.rb', line 259

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#availability_zone ⇒ String?

The Availability Zone of the router input.

Returns:

  • (String, nil) 


341
342
343
 
# File 'media_connect/cfn_router_input.rb', line 341

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



345
346
347
348
 
# File 'media_connect/cfn_router_input.rb', line 345

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



266
267
268
 
# File 'media_connect/cfn_router_input.rb', line 266

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



149
150
151
 
# File 'media_connect/cfn_router_input.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


154
155
156
 
# File 'media_connect/cfn_router_input.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


593
594
595
596
 
# File 'media_connect/cfn_router_input.rb', line 593

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}) 


159
160
161
 
# File 'media_connect/cfn_router_input.rb', line 159

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


166
167
168
 
# File 'media_connect/cfn_router_input.rb', line 166

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#configuration ⇒ AWSCDK::IResolvable, AWSCDK::MediaConnect::CfnRouterInput::RouterInputConfigurationProperty

The configuration settings for a router input.

Returns:



280
281
282
 
# File 'media_connect/cfn_router_input.rb', line 280

def configuration()
  jsii_get_property("configuration")
end

#configuration=(value) ⇒ Object 



284
285
286
287
288
 
# File 'media_connect/cfn_router_input.rb', line 284

def configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnRouterInput::RouterInputConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuUm91dGVySW5wdXQuUm91dGVySW5wdXRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "configuration")
  jsii_set_property("configuration", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


111
112
113
 
# File 'media_connect/cfn_router_input.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



171
172
173
 
# File 'media_connect/cfn_router_input.rb', line 171

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:



606
607
608
609
610
 
# File 'media_connect/cfn_router_input.rb', line 606

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:



617
618
619
620
 
# File 'media_connect/cfn_router_input.rb', line 617

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



687
688
689
690
 
# File 'media_connect/cfn_router_input.rb', line 687

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) 


123
124
125
 
# File 'media_connect/cfn_router_input.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance_configuration ⇒ AWSCDK::IResolvable, ...

The maintenance configuration settings applied to this router input.

Returns:



353
354
355
 
# File 'media_connect/cfn_router_input.rb', line 353

def maintenance_configuration()
  jsii_get_property("maintenanceConfiguration")
end

#maintenance_configuration=(value) ⇒ Object 



357
358
359
360
361
 
# File 'media_connect/cfn_router_input.rb', line 357

def maintenance_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnRouterInput::MaintenanceConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuUm91dGVySW5wdXQuTWFpbnRlbmFuY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "maintenanceConfiguration") unless value.nil?
  jsii_set_property("maintenanceConfiguration", value)
end

#maximum_bitrate ⇒ Numeric

The maximum bitrate for the router input.

Returns:

  • (Numeric) 


293
294
295
 
# File 'media_connect/cfn_router_input.rb', line 293

def maximum_bitrate()
  jsii_get_property("maximumBitrate")
end

#maximum_bitrate=(value) ⇒ Object 



297
298
299
300
 
# File 'media_connect/cfn_router_input.rb', line 297

def maximum_bitrate=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maximumBitrate")
  jsii_set_property("maximumBitrate", value)
end

#name ⇒ String

The name of the router input.

Returns:

  • (String) 


305
306
307
 
# File 'media_connect/cfn_router_input.rb', line 305

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



309
310
311
312
 
# File 'media_connect/cfn_router_input.rb', line 309

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


106
107
108
 
# File 'media_connect/cfn_router_input.rb', line 106

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:



628
629
630
 
# File 'media_connect/cfn_router_input.rb', line 628

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:



635
636
637
 
# File 'media_connect/cfn_router_input.rb', line 635

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.



428
429
430
431
 
# File 'media_connect/cfn_router_input.rb', line 428

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) 


142
143
144
 
# File 'media_connect/cfn_router_input.rb', line 142

def ref()
  jsii_get_property("ref")
end

#region_name ⇒ String?

The AWS Region where the router input is located.

Returns:

  • (String, nil) 


366
367
368
 
# File 'media_connect/cfn_router_input.rb', line 366

def region_name()
  jsii_get_property("regionName")
end

#region_name=(value) ⇒ Object 



370
371
372
373
 
# File 'media_connect/cfn_router_input.rb', line 370

def region_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "regionName") unless value.nil?
  jsii_set_property("regionName", value)
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:



646
647
648
649
 
# File 'media_connect/cfn_router_input.rb', line 646

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}) 


653
654
655
656
 
# File 'media_connect/cfn_router_input.rb', line 653

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:



663
664
665
666
667
 
# File 'media_connect/cfn_router_input.rb', line 663

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

#router_input_ref ⇒ AWSCDK::Interfaces::AWSMediaconnect::RouterInputReference

A reference to a RouterInput resource.

Returns:



273
274
275
 
# File 'media_connect/cfn_router_input.rb', line 273

def router_input_ref()
  jsii_get_property("routerInputRef")
end

#routing_scope ⇒ String

Indicates whether the router input is configured for Regional or global routing.

Returns:

  • (String) 


317
318
319
 
# File 'media_connect/cfn_router_input.rb', line 317

def routing_scope()
  jsii_get_property("routingScope")
end

#routing_scope=(value) ⇒ Object 



321
322
323
324
 
# File 'media_connect/cfn_router_input.rb', line 321

def routing_scope=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "routingScope")
  jsii_set_property("routingScope", 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.



672
673
674
 
# File 'media_connect/cfn_router_input.rb', line 672

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



132
133
134
 
# File 'media_connect/cfn_router_input.rb', line 132

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs that can be used to tag and organize this router input.

Returns:



378
379
380
 
# File 'media_connect/cfn_router_input.rb', line 378

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



382
383
384
385
386
 
# File 'media_connect/cfn_router_input.rb', line 382

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#tier ⇒ String

The tier level of the router input.

Returns:

  • (String) 


329
330
331
 
# File 'media_connect/cfn_router_input.rb', line 329

def tier()
  jsii_get_property("tier")
end

#tier=(value) ⇒ Object 



333
334
335
336
 
# File 'media_connect/cfn_router_input.rb', line 333

def tier=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "tier")
  jsii_set_property("tier", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



404
405
406
 
# File 'media_connect/cfn_router_input.rb', line 404

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

#transit_encryption ⇒ AWSCDK::IResolvable, ...

Encryption information.

Returns:



391
392
393
 
# File 'media_connect/cfn_router_input.rb', line 391

def transit_encryption()
  jsii_get_property("transitEncryption")
end

#transit_encryption=(value) ⇒ Object 



395
396
397
398
399
 
# File 'media_connect/cfn_router_input.rb', line 395

def transit_encryption=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnRouterInput::RouterInputTransitEncryptionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuUm91dGVySW5wdXQuUm91dGVySW5wdXRUcmFuc2l0RW5jcnlwdGlvblByb3BlcnR5In1dfX0=")), "transitEncryption") unless value.nil?
  jsii_set_property("transitEncryption", 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}) 


179
180
181
 
# File 'media_connect/cfn_router_input.rb', line 179

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}) 


189
190
191
 
# File 'media_connect/cfn_router_input.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


678
679
680
681
 
# File 'media_connect/cfn_router_input.rb', line 678

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


417
418
419
420
421
422
 
# File 'media_connect/cfn_router_input.rb', line 417

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