Class: AWSCDK::MediaConnect::CfnFlow

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

Overview

The AWS::MediaConnect::Flow resource defines a connection between one or more video sources and one or more outputs.

For each flow, you specify the transport protocol to use, encryption information, and details for any outputs or entitlements that you want. AWS Elemental MediaConnect returns an ingest endpoint where you can send your live video as a single unicast stream. The service replicates and distributes the video to every output that you specify, whether inside or outside the AWS Cloud. You can also set up entitlements on a flow to allow other AWS accounts to access your content.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFlow

Create a new AWS::MediaConnect::Flow.

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::CfnFlowProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'media_connect/cfn_flow.rb', line 20

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

Class Method Details

.arn_for_flow(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'media_connect/cfn_flow.rb', line 91

def self.arn_for_flow(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19tZWRpYWNvbm5lY3QuSUZsb3dSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconnect.CfnFlow", "arnForFlow", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


198
199
200
 
# File 'media_connect/cfn_flow.rb', line 198

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

.is_cfn_flow(x) ⇒ Boolean

Checks whether the given object is a CfnFlow.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


100
101
102
103
 
# File 'media_connect/cfn_flow.rb', line 100

def self.is_cfn_flow(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_mediaconnect.CfnFlow", "isCfnFlow", [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
 
# File 'media_connect/cfn_flow.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_egress_ip => { kind: :property, name: "attrEgressIp", is_optional: false },
    :attr_flow_arn => { kind: :property, name: "attrFlowArn", is_optional: false },
    :attr_flow_availability_zone => { kind: :property, name: "attrFlowAvailabilityZone", is_optional: false },
    :attr_flow_ndi_machine_name => { kind: :property, name: "attrFlowNdiMachineName", is_optional: false },
    :attr_source_ingest_ip => { kind: :property, name: "attrSourceIngestIp", is_optional: false },
    :attr_source_source_arn => { kind: :property, name: "attrSourceSourceArn", is_optional: false },
    :attr_source_source_ingest_port => { kind: :property, name: "attrSourceSourceIngestPort", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :flow_ref => { kind: :property, name: "flowRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :source => { kind: :property, name: "source", is_optional: false },
    :availability_zone => { kind: :property, name: "availabilityZone", is_optional: true },
    :encoding_config => { kind: :property, name: "encodingConfig", is_optional: true },
    :flow_size => { kind: :property, name: "flowSize", is_optional: true },
    :maintenance => { kind: :property, name: "maintenance", is_optional: true },
    :media_streams => { kind: :property, name: "mediaStreams", is_optional: true },
    :ndi_config => { kind: :property, name: "ndiConfig", is_optional: true },
    :source_failover_config => { kind: :property, name: "sourceFailoverConfig", is_optional: true },
    :source_monitoring_config => { kind: :property, name: "sourceMonitoringConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :vpc_interfaces => { kind: :property, name: "vpcInterfaces", 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.



456
457
458
459
 
# File 'media_connect/cfn_flow.rb', line 456

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:



468
469
470
471
 
# File 'media_connect/cfn_flow.rb', line 468

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:



478
479
480
481
 
# File 'media_connect/cfn_flow.rb', line 478

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:



489
490
491
492
493
 
# File 'media_connect/cfn_flow.rb', line 489

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.


546
547
548
549
550
 
# File 'media_connect/cfn_flow.rb', line 546

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.



556
557
558
559
 
# File 'media_connect/cfn_flow.rb', line 556

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.



568
569
570
571
572
 
# File 'media_connect/cfn_flow.rb', line 568

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:



581
582
583
584
 
# File 'media_connect/cfn_flow.rb', line 581

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:



603
604
605
606
607
608
 
# File 'media_connect/cfn_flow.rb', line 603

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_egress_ip ⇒ String

The IP address from which video will be sent to output destinations.

Returns:

  • (String) 


205
206
207
 
# File 'media_connect/cfn_flow.rb', line 205

def attr_egress_ip()
  jsii_get_property("attrEgressIp")
end

#attr_flow_arn ⇒ String

The Amazon Resource Name (ARN) of the flow.

Returns:

  • (String) 


212
213
214
 
# File 'media_connect/cfn_flow.rb', line 212

def attr_flow_arn()
  jsii_get_property("attrFlowArn")
end

#attr_flow_availability_zone ⇒ String

The Availability Zone that the flow was created in.

These options are limited to the Availability Zones within the current AWS Region.

Returns:

  • (String) 


221
222
223
 
# File 'media_connect/cfn_flow.rb', line 221

def attr_flow_availability_zone()
  jsii_get_property("attrFlowAvailabilityZone")
end

#attr_flow_ndi_machine_name ⇒ String

This read-only value represents the automatically-generated NDI machine name that MediaConnect generated for this flow.

These NDI machine names are only generated when you don't specify your own custom name.

Returns:

  • (String) 


230
231
232
 
# File 'media_connect/cfn_flow.rb', line 230

def attr_flow_ndi_machine_name()
  jsii_get_property("attrFlowNdiMachineName")
end

#attr_source_ingest_ip ⇒ String

The IP address that the flow listens on for incoming content.

Returns:

  • (String) 


237
238
239
 
# File 'media_connect/cfn_flow.rb', line 237

def attr_source_ingest_ip()
  jsii_get_property("attrSourceIngestIp")
end

#attr_source_source_arn ⇒ String

The ARN of the source.

Returns:

  • (String) 


244
245
246
 
# File 'media_connect/cfn_flow.rb', line 244

def attr_source_source_arn()
  jsii_get_property("attrSourceSourceArn")
end

#attr_source_source_ingest_port ⇒ String

The port that the flow listens on for incoming content.

If the protocol of the source is Zixi, the port must be set to 2088.

Returns:

  • (String) 


253
254
255
 
# File 'media_connect/cfn_flow.rb', line 253

def attr_source_source_ingest_port()
  jsii_get_property("attrSourceSourceIngestPort")
end

#availability_zone ⇒ String?

The Availability Zone that you want to create the flow in.

Returns:

  • (String, nil) 


299
300
301
 
# File 'media_connect/cfn_flow.rb', line 299

def availability_zone()
  jsii_get_property("availabilityZone")
end

#availability_zone=(value) ⇒ Object 



303
304
305
306
 
# File 'media_connect/cfn_flow.rb', line 303

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:



260
261
262
 
# File 'media_connect/cfn_flow.rb', line 260

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



151
152
153
 
# File 'media_connect/cfn_flow.rb', line 151

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


156
157
158
 
# File 'media_connect/cfn_flow.rb', line 156

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


612
613
614
615
 
# File 'media_connect/cfn_flow.rb', line 612

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


161
162
163
 
# File 'media_connect/cfn_flow.rb', line 161

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


168
169
170
 
# File 'media_connect/cfn_flow.rb', line 168

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


113
114
115
 
# File 'media_connect/cfn_flow.rb', line 113

def creation_stack()
  jsii_get_property("creationStack")
end

#encoding_config ⇒ AWSCDK::IResolvable, ...

Returns:



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

def encoding_config()
  jsii_get_property("encodingConfig")
end

#encoding_config=(value) ⇒ Object 



313
314
315
316
317
 
# File 'media_connect/cfn_flow.rb', line 313

def encoding_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::EncodingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5FbmNvZGluZ0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "encodingConfig") unless value.nil?
  jsii_set_property("encodingConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



173
174
175
 
# File 'media_connect/cfn_flow.rb', line 173

def env()
  jsii_get_property("env")
end

#flow_ref ⇒ AWSCDK::Interfaces::AWSMediaconnect::FlowReference

A reference to a Flow resource.

Returns:



267
268
269
 
# File 'media_connect/cfn_flow.rb', line 267

def flow_ref()
  jsii_get_property("flowRef")
end

#flow_size ⇒ String?

Determines the processing capacity and feature set of the flow.

Returns:

  • (String, nil) 


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

def flow_size()
  jsii_get_property("flowSize")
end

#flow_size=(value) ⇒ Object 



326
327
328
329
 
# File 'media_connect/cfn_flow.rb', line 326

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



625
626
627
628
629
 
# File 'media_connect/cfn_flow.rb', line 625

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:



636
637
638
639
 
# File 'media_connect/cfn_flow.rb', line 636

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:



706
707
708
709
 
# File 'media_connect/cfn_flow.rb', line 706

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) 


125
126
127
 
# File 'media_connect/cfn_flow.rb', line 125

def logical_id()
  jsii_get_property("logicalId")
end

#maintenance ⇒ AWSCDK::IResolvable, ...

The maintenance settings you want to use for the flow.

Returns:



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

def maintenance()
  jsii_get_property("maintenance")
end

#maintenance=(value) ⇒ Object 



338
339
340
341
342
 
# File 'media_connect/cfn_flow.rb', line 338

def maintenance=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::MaintenanceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5NYWludGVuYW5jZVByb3BlcnR5In1dfX0=")), "maintenance") unless value.nil?
  jsii_set_property("maintenance", value)
end

#media_streams ⇒ AWSCDK::IResolvable, ...

The media streams that are associated with the flow.

Returns:



347
348
349
 
# File 'media_connect/cfn_flow.rb', line 347

def media_streams()
  jsii_get_property("mediaStreams")
end

#media_streams=(value) ⇒ Object 



351
352
353
354
 
# File 'media_connect/cfn_flow.rb', line 351

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

#name ⇒ String

The name of the flow.

Returns:

  • (String) 


274
275
276
 
# File 'media_connect/cfn_flow.rb', line 274

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



278
279
280
281
 
# File 'media_connect/cfn_flow.rb', line 278

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

#ndi_config ⇒ AWSCDK::IResolvable, ...

Specifies the configuration settings for NDI outputs.

Returns:



359
360
361
 
# File 'media_connect/cfn_flow.rb', line 359

def ndi_config()
  jsii_get_property("ndiConfig")
end

#ndi_config=(value) ⇒ Object 



363
364
365
366
367
 
# File 'media_connect/cfn_flow.rb', line 363

def ndi_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::NdiConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5OZGlDb25maWdQcm9wZXJ0eSJ9XX19")), "ndiConfig") unless value.nil?
  jsii_set_property("ndiConfig", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


108
109
110
 
# File 'media_connect/cfn_flow.rb', line 108

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:



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

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:



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

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.



447
448
449
450
 
# File 'media_connect/cfn_flow.rb', line 447

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) 


144
145
146
 
# File 'media_connect/cfn_flow.rb', line 144

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:



665
666
667
668
 
# File 'media_connect/cfn_flow.rb', line 665

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


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

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:



682
683
684
685
686
 
# File 'media_connect/cfn_flow.rb', line 682

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

#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.



691
692
693
 
# File 'media_connect/cfn_flow.rb', line 691

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

#source ⇒ AWSCDK::IResolvable, AWSCDK::MediaConnect::CfnFlow::SourceProperty

The settings for the source that you want to use for the new flow.

Returns:



286
287
288
 
# File 'media_connect/cfn_flow.rb', line 286

def source()
  jsii_get_property("source")
end

#source=(value) ⇒ Object 



290
291
292
293
294
 
# File 'media_connect/cfn_flow.rb', line 290

def source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::SourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5Tb3VyY2VQcm9wZXJ0eSJ9XX19")), "source")
  jsii_set_property("source", value)
end

#source_failover_config ⇒ AWSCDK::IResolvable, ...

The settings for source failover.

Returns:



372
373
374
 
# File 'media_connect/cfn_flow.rb', line 372

def source_failover_config()
  jsii_get_property("sourceFailoverConfig")
end

#source_failover_config=(value) ⇒ Object 



376
377
378
379
380
 
# File 'media_connect/cfn_flow.rb', line 376

def source_failover_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::FailoverConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5GYWlsb3ZlckNvbmZpZ1Byb3BlcnR5In1dfX0=")), "sourceFailoverConfig") unless value.nil?
  jsii_set_property("sourceFailoverConfig", value)
end

#source_monitoring_config ⇒ AWSCDK::IResolvable, ...

The settings for source monitoring.

Returns:



385
386
387
 
# File 'media_connect/cfn_flow.rb', line 385

def source_monitoring_config()
  jsii_get_property("sourceMonitoringConfig")
end

#source_monitoring_config=(value) ⇒ Object 



389
390
391
392
393
 
# File 'media_connect/cfn_flow.rb', line 389

def source_monitoring_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlow::SourceMonitoringConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvdy5Tb3VyY2VNb25pdG9yaW5nQ29uZmlnUHJvcGVydHkifV19fQ==")), "sourceMonitoringConfig") unless value.nil?
  jsii_set_property("sourceMonitoringConfig", 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:



134
135
136
 
# File 'media_connect/cfn_flow.rb', line 134

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Key-value pairs that can be used to tag this flow.

Returns:



398
399
400
 
# File 'media_connect/cfn_flow.rb', line 398

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



402
403
404
405
406
 
# File 'media_connect/cfn_flow.rb', line 402

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



423
424
425
 
# File 'media_connect/cfn_flow.rb', line 423

def to_string()
  jsii_call_method("toString", [])
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}) 


181
182
183
 
# File 'media_connect/cfn_flow.rb', line 181

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


191
192
193
 
# File 'media_connect/cfn_flow.rb', line 191

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


697
698
699
700
 
# File 'media_connect/cfn_flow.rb', line 697

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

#vpc_interfaces ⇒ AWSCDK::IResolvable, ...

The VPC Interfaces for this flow.

Returns:



411
412
413
 
# File 'media_connect/cfn_flow.rb', line 411

def vpc_interfaces()
  jsii_get_property("vpcInterfaces")
end

#vpc_interfaces=(value) ⇒ Object 



415
416
417
418
 
# File 'media_connect/cfn_flow.rb', line 415

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


436
437
438
439
440
441
 
# File 'media_connect/cfn_flow.rb', line 436

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