Class: AWSCDK::MediaConnect::CfnFlowSource

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

Overview

The AWS::MediaConnect::FlowSource resource is usedt to add additional sources to an existing flow.

Adding an additional source requires Failover to be enabled. When you enable Failover, the additional source must use the same protocol as the existing source. A source is the external video content that includes configuration information (encryption and source type) and a network address. Each flow has at least one source. A standard source comes from a source other than another AWS Elemental MediaConnect flow, such as an on-premises encoder.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFlowSource

Create a new AWS::MediaConnect::FlowSource.

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

    Resource properties.



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

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


194
195
196
 
# File 'media_connect/cfn_flow_source.rb', line 194

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

.is_cfn_flow_source(x) ⇒ Boolean

Checks whether the given object is a CfnFlowSource.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'media_connect/cfn_flow_source.rb', line 96

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

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'media_connect/cfn_flow_source.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_ingest_ip => { kind: :property, name: "attrIngestIp", is_optional: false },
    :attr_source_arn => { kind: :property, name: "attrSourceArn", is_optional: false },
    :attr_source_ingest_port => { kind: :property, name: "attrSourceIngestPort", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :flow_source_ref => { kind: :property, name: "flowSourceRef", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :flow_arn => { kind: :property, name: "flowArn", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :decryption => { kind: :property, name: "decryption", is_optional: true },
    :entitlement_arn => { kind: :property, name: "entitlementArn", is_optional: true },
    :gateway_bridge_source => { kind: :property, name: "gatewayBridgeSource", is_optional: true },
    :ingest_port => { kind: :property, name: "ingestPort", is_optional: true },
    :max_bitrate => { kind: :property, name: "maxBitrate", is_optional: true },
    :max_latency => { kind: :property, name: "maxLatency", is_optional: true },
    :min_latency => { kind: :property, name: "minLatency", is_optional: true },
    :protocol => { kind: :property, name: "protocol", is_optional: true },
    :sender_control_port => { kind: :property, name: "senderControlPort", is_optional: true },
    :sender_ip_address => { kind: :property, name: "senderIpAddress", is_optional: true },
    :source_listener_address => { kind: :property, name: "sourceListenerAddress", is_optional: true },
    :source_listener_port => { kind: :property, name: "sourceListenerPort", is_optional: true },
    :stream_id => { kind: :property, name: "streamId", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :vpc_interface_name => { kind: :property, name: "vpcInterfaceName", is_optional: true },
    :whitelist_cidr => { kind: :property, name: "whitelistCidr", 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.



505
506
507
508
 
# File 'media_connect/cfn_flow_source.rb', line 505

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:



517
518
519
520
 
# File 'media_connect/cfn_flow_source.rb', line 517

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:



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

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:



538
539
540
541
542
 
# File 'media_connect/cfn_flow_source.rb', line 538

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.


595
596
597
598
599
 
# File 'media_connect/cfn_flow_source.rb', line 595

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.



605
606
607
608
 
# File 'media_connect/cfn_flow_source.rb', line 605

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.



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

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:



630
631
632
633
 
# File 'media_connect/cfn_flow_source.rb', line 630

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:



652
653
654
655
656
657
 
# File 'media_connect/cfn_flow_source.rb', line 652

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

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

Returns:

  • (String) 


201
202
203
 
# File 'media_connect/cfn_flow_source.rb', line 201

def attr_ingest_ip()
  jsii_get_property("attrIngestIp")
end

#attr_source_arn ⇒ String

The ARN of the source.

Returns:

  • (String) 


208
209
210
 
# File 'media_connect/cfn_flow_source.rb', line 208

def attr_source_arn()
  jsii_get_property("attrSourceArn")
end

#attr_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) 


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

def attr_source_ingest_port()
  jsii_get_property("attrSourceIngestPort")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



147
148
149
 
# File 'media_connect/cfn_flow_source.rb', line 147

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


152
153
154
 
# File 'media_connect/cfn_flow_source.rb', line 152

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


661
662
663
664
 
# File 'media_connect/cfn_flow_source.rb', line 661

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


157
158
159
 
# File 'media_connect/cfn_flow_source.rb', line 157

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


164
165
166
 
# File 'media_connect/cfn_flow_source.rb', line 164

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


109
110
111
 
# File 'media_connect/cfn_flow_source.rb', line 109

def creation_stack()
  jsii_get_property("creationStack")
end

#decryption ⇒ AWSCDK::IResolvable, ...

The type of encryption that is used on the content ingested from this source.

Returns:



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

def decryption()
  jsii_get_property("decryption")
end

#decryption=(value) ⇒ Object 



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

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

#description ⇒ String

A description for the source.

Returns:

  • (String) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



242
243
244
245
 
# File 'media_connect/cfn_flow_source.rb', line 242

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

#entitlement_arn ⇒ String?

Deprecated.

this property has been deprecated

The ARN of the entitlement that allows you to subscribe to this flow.

Returns:

  • (String, nil) 


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

def entitlement_arn()
  jsii_get_property("entitlementArn")
end

#entitlement_arn=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



169
170
171
 
# File 'media_connect/cfn_flow_source.rb', line 169

def env()
  jsii_get_property("env")
end

#flow_arn ⇒ String

The Amazon Resource Name (ARN) of the flow this source is connected to.

Returns:

  • (String) 


250
251
252
 
# File 'media_connect/cfn_flow_source.rb', line 250

def flow_arn()
  jsii_get_property("flowArn")
end

#flow_arn=(value) ⇒ Object 



254
255
256
257
 
# File 'media_connect/cfn_flow_source.rb', line 254

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

#flow_source_ref ⇒ AWSCDK::Interfaces::AWSMediaconnect::FlowSourceReference

A reference to a FlowSource resource.

Returns:



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

def flow_source_ref()
  jsii_get_property("flowSourceRef")
end

#gateway_bridge_source ⇒ AWSCDK::IResolvable, ...

The bridge's source.

Returns:



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

def gateway_bridge_source()
  jsii_get_property("gatewayBridgeSource")
end

#gateway_bridge_source=(value) ⇒ Object 



304
305
306
307
308
 
# File 'media_connect/cfn_flow_source.rb', line 304

def gateway_bridge_source=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::MediaConnect::CfnFlowSource::GatewayBridgeSourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWNvbm5lY3QuQ2ZuRmxvd1NvdXJjZS5HYXRld2F5QnJpZGdlU291cmNlUHJvcGVydHkifV19fQ==")), "gatewayBridgeSource") unless value.nil?
  jsii_set_property("gatewayBridgeSource", 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:



674
675
676
677
678
 
# File 'media_connect/cfn_flow_source.rb', line 674

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:



685
686
687
688
 
# File 'media_connect/cfn_flow_source.rb', line 685

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

#ingest_port ⇒ Numeric?

The port that the flow listens on for incoming content.

Returns:

  • (Numeric, nil) 


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

def ingest_port()
  jsii_get_property("ingestPort")
end

#ingest_port=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



755
756
757
758
 
# File 'media_connect/cfn_flow_source.rb', line 755

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) 


121
122
123
 
# File 'media_connect/cfn_flow_source.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#max_bitrate ⇒ Numeric?

The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams.

Returns:

  • (Numeric, nil) 


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

def max_bitrate()
  jsii_get_property("maxBitrate")
end

#max_bitrate=(value) ⇒ Object 



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

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

#max_latency ⇒ Numeric?

The maximum latency in milliseconds.

Returns:

  • (Numeric, nil) 


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

def max_latency()
  jsii_get_property("maxLatency")
end

#max_latency=(value) ⇒ Object 



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

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

#min_latency ⇒ Numeric?

The minimum latency in milliseconds for SRT-based streams.

Returns:

  • (Numeric, nil) 


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

def min_latency()
  jsii_get_property("minLatency")
end

#min_latency=(value) ⇒ Object 



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

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

#name ⇒ String

The name of the source.

Returns:

  • (String) 


262
263
264
 
# File 'media_connect/cfn_flow_source.rb', line 262

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


104
105
106
 
# File 'media_connect/cfn_flow_source.rb', line 104

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:



696
697
698
 
# File 'media_connect/cfn_flow_source.rb', line 696

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:



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

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.



496
497
498
499
 
# File 'media_connect/cfn_flow_source.rb', line 496

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

#protocol ⇒ String?

The protocol that the source uses to deliver the content to MediaConnect.

Returns:

  • (String, nil) 


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

def protocol()
  jsii_get_property("protocol")
end

#protocol=(value) ⇒ Object 



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

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


140
141
142
 
# File 'media_connect/cfn_flow_source.rb', line 140

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:



714
715
716
717
 
# File 'media_connect/cfn_flow_source.rb', line 714

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


721
722
723
724
 
# File 'media_connect/cfn_flow_source.rb', line 721

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:



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

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

#sender_control_port ⇒ Numeric?

Deprecated.

this property has been deprecated

The port that the flow uses to send outbound requests to initiate connection with the sender.

Returns:

  • (Numeric, nil) 


374
375
376
 
# File 'media_connect/cfn_flow_source.rb', line 374

def sender_control_port()
  jsii_get_property("senderControlPort")
end

#sender_control_port=(value) ⇒ Object 



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

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

#sender_ip_address ⇒ String?

Deprecated.

this property has been deprecated

The IP address that the flow communicates with to initiate connection with the sender.

Returns:

  • (String, nil) 


387
388
389
 
# File 'media_connect/cfn_flow_source.rb', line 387

def sender_ip_address()
  jsii_get_property("senderIpAddress")
end

#sender_ip_address=(value) ⇒ Object 



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

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



740
741
742
 
# File 'media_connect/cfn_flow_source.rb', line 740

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

#source_listener_address ⇒ String?

Source IP or domain name for SRT-caller protocol.

Returns:

  • (String, nil) 


399
400
401
 
# File 'media_connect/cfn_flow_source.rb', line 399

def source_listener_address()
  jsii_get_property("sourceListenerAddress")
end

#source_listener_address=(value) ⇒ Object 



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

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

#source_listener_port ⇒ Numeric?

Source port for SRT-caller protocol.

Returns:

  • (Numeric, nil) 


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

def source_listener_port()
  jsii_get_property("sourceListenerPort")
end

#source_listener_port=(value) ⇒ Object 



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

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



130
131
132
 
# File 'media_connect/cfn_flow_source.rb', line 130

def stack()
  jsii_get_property("stack")
end

#stream_id ⇒ String?

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

Returns:

  • (String, nil) 


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

def stream_id()
  jsii_get_property("streamId")
end

#stream_id=(value) ⇒ Object 



427
428
429
430
 
# File 'media_connect/cfn_flow_source.rb', line 427

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

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



435
436
437
 
# File 'media_connect/cfn_flow_source.rb', line 435

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



439
440
441
442
443
 
# File 'media_connect/cfn_flow_source.rb', line 439

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



472
473
474
 
# File 'media_connect/cfn_flow_source.rb', line 472

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


177
178
179
 
# File 'media_connect/cfn_flow_source.rb', line 177

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


187
188
189
 
# File 'media_connect/cfn_flow_source.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


746
747
748
749
 
# File 'media_connect/cfn_flow_source.rb', line 746

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

#vpc_interface_name ⇒ String?

The name of the VPC interface to use for this source.

Returns:

  • (String, nil) 


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

def vpc_interface_name()
  jsii_get_property("vpcInterfaceName")
end

#vpc_interface_name=(value) ⇒ Object 



452
453
454
455
 
# File 'media_connect/cfn_flow_source.rb', line 452

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

#whitelist_cidr ⇒ String?

The range of IP addresses that should be allowed to contribute content to your source.

Returns:

  • (String, nil) 


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

def whitelist_cidr()
  jsii_get_property("whitelistCidr")
end

#whitelist_cidr=(value) ⇒ Object 



464
465
466
467
 
# File 'media_connect/cfn_flow_source.rb', line 464

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


485
486
487
488
489
490
 
# File 'media_connect/cfn_flow_source.rb', line 485

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