Class: AWSCDK::MediaConnect::CfnFlowOutput

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

Overview

The AWS::MediaConnect::FlowOutput resource defines the destination address, protocol, and port that AWS Elemental MediaConnect sends the ingested video to.

Each flow can have up to 50 outputs. An output can have the same protocol or a different protocol from the source. The following protocols are supported: RIST, RTP, RTP-FEC, SRT-listener, SRT-caller, Zixi pull, and Zixi push. CDI and ST 2110 JPEG XS protocols are not currently supported by AWS CloudFormation.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFlowOutput

Create a new AWS::MediaConnect::FlowOutput.

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::CfnFlowOutputProps)

    Resource properties.



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

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

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


195
196
197
# File 'media_connect/cfn_flow_output.rb', line 195

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

.is_cfn_flow_output(x) ⇒ Boolean

Checks whether the given object is a CfnFlowOutput.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


97
98
99
100
# File 'media_connect/cfn_flow_output.rb', line 97

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

.jsii_overridable_methodsObject



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
89
90
91
# File 'media_connect/cfn_flow_output.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_output_arn => { kind: :property, name: "attrOutputArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :flow_output_ref => { kind: :property, name: "flowOutputRef", is_optional: false },
    :flow_arn => { kind: :property, name: "flowArn", is_optional: false },
    :cidr_allow_list => { kind: :property, name: "cidrAllowList", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :destination => { kind: :property, name: "destination", is_optional: true },
    :encryption => { kind: :property, name: "encryption", is_optional: true },
    :max_latency => { kind: :property, name: "maxLatency", is_optional: true },
    :media_stream_output_configurations => { kind: :property, name: "mediaStreamOutputConfigurations", is_optional: true },
    :min_latency => { kind: :property, name: "minLatency", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :ndi_output_timecode_source => { kind: :property, name: "ndiOutputTimecodeSource", is_optional: true },
    :ndi_program_name => { kind: :property, name: "ndiProgramName", is_optional: true },
    :ndi_speed_hq_quality => { kind: :property, name: "ndiSpeedHqQuality", is_optional: true },
    :output_status => { kind: :property, name: "outputStatus", is_optional: true },
    :port => { kind: :property, name: "port", is_optional: true },
    :protocol => { kind: :property, name: "protocol", is_optional: true },
    :remote_id => { kind: :property, name: "remoteId", is_optional: true },
    :router_integration_state => { kind: :property, name: "routerIntegrationState", is_optional: true },
    :router_integration_transit_encryption => { kind: :property, name: "routerIntegrationTransitEncryption", is_optional: true },
    :smoothing_latency => { kind: :property, name: "smoothingLatency", is_optional: true },
    :stream_id => { kind: :property, name: "streamId", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :vpc_interface_attachment => { kind: :property, name: "vpcInterfaceAttachment", 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.



522
523
524
525
# File 'media_connect/cfn_flow_output.rb', line 522

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:



534
535
536
537
# File 'media_connect/cfn_flow_output.rb', line 534

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:



544
545
546
547
# File 'media_connect/cfn_flow_output.rb', line 544

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.



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

def (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.


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

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.



622
623
624
625
# File 'media_connect/cfn_flow_output.rb', line 622

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.



634
635
636
637
638
# File 'media_connect/cfn_flow_output.rb', line 634

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:



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

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:



669
670
671
672
673
674
# File 'media_connect/cfn_flow_output.rb', line 669

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_output_arnString

The ARN of the output.

Returns:

  • (String)


202
203
204
# File 'media_connect/cfn_flow_output.rb', line 202

def attr_output_arn()
  jsii_get_property("attrOutputArn")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



209
210
211
# File 'media_connect/cfn_flow_output.rb', line 209

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



148
149
150
# File 'media_connect/cfn_flow_output.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


153
154
155
# File 'media_connect/cfn_flow_output.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


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

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_namesHash{String => String}

Returns:

  • (Hash{String => String})


158
159
160
# File 'media_connect/cfn_flow_output.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


165
166
167
# File 'media_connect/cfn_flow_output.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cidr_allow_listArray<String>?

The range of IP addresses that should be allowed to initiate output requests to this flow.

Returns:

  • (Array<String>, nil)


235
236
237
# File 'media_connect/cfn_flow_output.rb', line 235

def cidr_allow_list()
  jsii_get_property("cidrAllowList")
end

#cidr_allow_list=(value) ⇒ Object



239
240
241
242
# File 'media_connect/cfn_flow_output.rb', line 239

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

#creation_stackArray<String>

Returns:

  • (Array<String>)


110
111
112
# File 'media_connect/cfn_flow_output.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

A description of the output.

Returns:

  • (String, nil)


247
248
249
# File 'media_connect/cfn_flow_output.rb', line 247

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



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

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

#destinationString?

The IP address where you want to send the output.

Returns:

  • (String, nil)


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

def destination()
  jsii_get_property("destination")
end

#destination=(value) ⇒ Object



263
264
265
266
# File 'media_connect/cfn_flow_output.rb', line 263

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

#encryptionAWSCDK::IResolvable, ...

The type of key used for the encryption.



271
272
273
# File 'media_connect/cfn_flow_output.rb', line 271

def encryption()
  jsii_get_property("encryption")
end

#encryption=(value) ⇒ Object



275
276
277
278
279
# File 'media_connect/cfn_flow_output.rb', line 275

def encryption=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlowOutput::EncryptionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvd091dHB1dC5FbmNyeXB0aW9uUHJvcGVydHkifV19fQ==")), "encryption") unless value.nil?
  jsii_set_property("encryption", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



170
171
172
# File 'media_connect/cfn_flow_output.rb', line 170

def env()
  jsii_get_property("env")
end

#flow_arnString

The Amazon Resource Name (ARN) of the flow this output is attached to.

Returns:

  • (String)


223
224
225
# File 'media_connect/cfn_flow_output.rb', line 223

def flow_arn()
  jsii_get_property("flowArn")
end

#flow_arn=(value) ⇒ Object



227
228
229
230
# File 'media_connect/cfn_flow_output.rb', line 227

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

#flow_output_refAWSCDK::Interfaces::AWSMediaconnect::FlowOutputReference

A reference to a FlowOutput resource.



216
217
218
# File 'media_connect/cfn_flow_output.rb', line 216

def flow_output_ref()
  jsii_get_property("flowOutputRef")
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:



691
692
693
694
695
# File 'media_connect/cfn_flow_output.rb', line 691

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.



702
703
704
705
# File 'media_connect/cfn_flow_output.rb', line 702

def (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:



772
773
774
775
# File 'media_connect/cfn_flow_output.rb', line 772

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

#logical_idString

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)


122
123
124
# File 'media_connect/cfn_flow_output.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#max_latencyNumeric?

The maximum latency in milliseconds.

Returns:

  • (Numeric, nil)


284
285
286
# File 'media_connect/cfn_flow_output.rb', line 284

def max_latency()
  jsii_get_property("maxLatency")
end

#max_latency=(value) ⇒ Object



288
289
290
291
# File 'media_connect/cfn_flow_output.rb', line 288

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

#media_stream_output_configurationsAWSCDK::IResolvable, ...

The media streams that are associated with the output, and the parameters for those associations.



296
297
298
# File 'media_connect/cfn_flow_output.rb', line 296

def media_stream_output_configurations()
  jsii_get_property("mediaStreamOutputConfigurations")
end

#media_stream_output_configurations=(value) ⇒ Object



300
301
302
303
# File 'media_connect/cfn_flow_output.rb', line 300

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

#min_latencyNumeric?

The minimum latency in milliseconds for SRT-based streams.

Returns:

  • (Numeric, nil)


308
309
310
# File 'media_connect/cfn_flow_output.rb', line 308

def min_latency()
  jsii_get_property("minLatency")
end

#min_latency=(value) ⇒ Object



312
313
314
315
# File 'media_connect/cfn_flow_output.rb', line 312

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

#nameString?

The name of the bridge's output.

Returns:

  • (String, nil)


320
321
322
# File 'media_connect/cfn_flow_output.rb', line 320

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



324
325
326
327
# File 'media_connect/cfn_flow_output.rb', line 324

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

#ndi_output_timecode_sourceString?

The timecode source for the NDI output.

Returns:

  • (String, nil)


332
333
334
# File 'media_connect/cfn_flow_output.rb', line 332

def ndi_output_timecode_source()
  jsii_get_property("ndiOutputTimecodeSource")
end

#ndi_output_timecode_source=(value) ⇒ Object



336
337
338
339
# File 'media_connect/cfn_flow_output.rb', line 336

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

#ndi_program_nameString?

A suffix for the names of the NDI sources that the flow creates.

Returns:

  • (String, nil)


344
345
346
# File 'media_connect/cfn_flow_output.rb', line 344

def ndi_program_name()
  jsii_get_property("ndiProgramName")
end

#ndi_program_name=(value) ⇒ Object



348
349
350
351
# File 'media_connect/cfn_flow_output.rb', line 348

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

#ndi_speed_hq_qualityNumeric?

A quality setting for the NDI Speed HQ encoder.

Returns:

  • (Numeric, nil)


356
357
358
# File 'media_connect/cfn_flow_output.rb', line 356

def ndi_speed_hq_quality()
  jsii_get_property("ndiSpeedHqQuality")
end

#ndi_speed_hq_quality=(value) ⇒ Object



360
361
362
363
# File 'media_connect/cfn_flow_output.rb', line 360

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

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


105
106
107
# File 'media_connect/cfn_flow_output.rb', line 105

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<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:



713
714
715
# File 'media_connect/cfn_flow_output.rb', line 713

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

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

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

Returns:



720
721
722
# File 'media_connect/cfn_flow_output.rb', line 720

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

#output_statusString?

An indication of whether the output should transmit data or not.

Returns:

  • (String, nil)


368
369
370
# File 'media_connect/cfn_flow_output.rb', line 368

def output_status()
  jsii_get_property("outputStatus")
end

#output_status=(value) ⇒ Object



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

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



513
514
515
516
# File 'media_connect/cfn_flow_output.rb', line 513

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

#portNumeric?

The port to use when content is distributed to this output.

Returns:

  • (Numeric, nil)


380
381
382
# File 'media_connect/cfn_flow_output.rb', line 380

def port()
  jsii_get_property("port")
end

#port=(value) ⇒ Object



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

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

#protocolString?

The protocol to use for the output.

Returns:

  • (String, nil)


392
393
394
# File 'media_connect/cfn_flow_output.rb', line 392

def protocol()
  jsii_get_property("protocol")
end

#protocol=(value) ⇒ Object



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

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

#refString

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)


141
142
143
# File 'media_connect/cfn_flow_output.rb', line 141

def ref()
  jsii_get_property("ref")
end

#remote_idString?

The remote ID for the Zixi-pull stream.

Returns:

  • (String, nil)


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

def remote_id()
  jsii_get_property("remoteId")
end

#remote_id=(value) ⇒ Object



408
409
410
411
# File 'media_connect/cfn_flow_output.rb', line 408

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



731
732
733
734
# File 'media_connect/cfn_flow_output.rb', line 731

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


738
739
740
741
# File 'media_connect/cfn_flow_output.rb', line 738

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:



748
749
750
751
752
# File 'media_connect/cfn_flow_output.rb', line 748

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_integration_stateString?

Returns:

  • (String, nil)


414
415
416
# File 'media_connect/cfn_flow_output.rb', line 414

def router_integration_state()
  jsii_get_property("routerIntegrationState")
end

#router_integration_state=(value) ⇒ Object



418
419
420
421
# File 'media_connect/cfn_flow_output.rb', line 418

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

#router_integration_transit_encryptionAWSCDK::IResolvable, ...

Encryption information.



426
427
428
# File 'media_connect/cfn_flow_output.rb', line 426

def router_integration_transit_encryption()
  jsii_get_property("routerIntegrationTransitEncryption")
end

#router_integration_transit_encryption=(value) ⇒ Object



430
431
432
433
434
# File 'media_connect/cfn_flow_output.rb', line 430

def router_integration_transit_encryption=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlowOutput::FlowTransitEncryptionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvd091dHB1dC5GbG93VHJhbnNpdEVuY3J5cHRpb25Qcm9wZXJ0eSJ9XX19")), "routerIntegrationTransitEncryption") unless value.nil?
  jsii_set_property("routerIntegrationTransitEncryption", value)
end

#should_synthesizeBoolean

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.



757
758
759
# File 'media_connect/cfn_flow_output.rb', line 757

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

#smoothing_latencyNumeric?

The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams.

Returns:

  • (Numeric, nil)


439
440
441
# File 'media_connect/cfn_flow_output.rb', line 439

def smoothing_latency()
  jsii_get_property("smoothingLatency")
end

#smoothing_latency=(value) ⇒ Object



443
444
445
446
# File 'media_connect/cfn_flow_output.rb', line 443

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

#stackAWSCDK::Stack

The stack in which this element is defined.

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

Returns:



131
132
133
# File 'media_connect/cfn_flow_output.rb', line 131

def stack()
  jsii_get_property("stack")
end

#stream_idString?

The stream ID that you want to use for this transport.

Returns:

  • (String, nil)


451
452
453
# File 'media_connect/cfn_flow_output.rb', line 451

def stream_id()
  jsii_get_property("streamId")
end

#stream_id=(value) ⇒ Object



455
456
457
458
# File 'media_connect/cfn_flow_output.rb', line 455

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

#tagsArray<AWSCDK::CfnTag>?

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

Returns:



463
464
465
# File 'media_connect/cfn_flow_output.rb', line 463

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



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

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_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



489
490
491
# File 'media_connect/cfn_flow_output.rb', line 489

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

#updated_properitesHash{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})


178
179
180
# File 'media_connect/cfn_flow_output.rb', line 178

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{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})


188
189
190
# File 'media_connect/cfn_flow_output.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


763
764
765
766
# File 'media_connect/cfn_flow_output.rb', line 763

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

#vpc_interface_attachmentAWSCDK::IResolvable, ...

The name of the VPC interface attachment to use for this output.



476
477
478
# File 'media_connect/cfn_flow_output.rb', line 476

def vpc_interface_attachment()
  jsii_get_property("vpcInterfaceAttachment")
end

#vpc_interface_attachment=(value) ⇒ Object



480
481
482
483
484
# File 'media_connect/cfn_flow_output.rb', line 480

def vpc_interface_attachment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlowOutput::VPCInterfaceAttachmentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvd091dHB1dC5WcGNJbnRlcmZhY2VBdHRhY2htZW50UHJvcGVydHkifV19fQ==")), "vpcInterfaceAttachment") unless value.nil?
  jsii_set_property("vpcInterfaceAttachment", 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)


502
503
504
505
506
507
# File 'media_connect/cfn_flow_output.rb', line 502

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