Class: AWSCDK::EC2::CfnTransitGatewayMulticastGroupSource

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSEC2::ITransitGatewayMulticastGroupSourceRef
Defined in:
ec2/cfn_transit_gateway_multicast_group_source.rb

Overview

Registers sources (network interfaces) with the specified transit gateway multicast domain.

A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnTransitGatewayMulticastGroupSource

Create a new AWS::EC2::TransitGatewayMulticastGroupSource.

Parameters:



19
20
21
22
23
24
25
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTransitGatewayMulticastGroupSourceProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYW5zaXRHYXRld2F5TXVsdGljYXN0R3JvdXBTb3VyY2VQcm9wcyJ9")), "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) 


181
182
183
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 181

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

.is_cfn_transit_gateway_multicast_group_source(x) ⇒ Boolean

Checks whether the given object is a CfnTransitGatewayMulticastGroupSource.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


83
84
85
86
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 83

def self.is_cfn_transit_gateway_multicast_group_source(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGatewayMulticastGroupSource", "isCfnTransitGatewayMulticastGroupSource", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 27

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_group_member => { kind: :property, name: "attrGroupMember", is_optional: false },
    :attr_group_source => { kind: :property, name: "attrGroupSource", is_optional: false },
    :attr_member_type => { kind: :property, name: "attrMemberType", is_optional: false },
    :attr_resource_id => { kind: :property, name: "attrResourceId", is_optional: false },
    :attr_resource_type => { kind: :property, name: "attrResourceType", is_optional: false },
    :attr_source_type => { kind: :property, name: "attrSourceType", is_optional: false },
    :attr_subnet_id => { kind: :property, name: "attrSubnetId", is_optional: false },
    :attr_transit_gateway_attachment_id => { kind: :property, name: "attrTransitGatewayAttachmentId", is_optional: false },
    :transit_gateway_multicast_group_source_ref => { kind: :property, name: "transitGatewayMulticastGroupSourceRef", is_optional: false },
    :group_ip_address => { kind: :property, name: "groupIpAddress", is_optional: false },
    :network_interface_id => { kind: :property, name: "networkInterfaceId", is_optional: false },
    :transit_gateway_multicast_domain_id => { kind: :property, name: "transitGatewayMulticastDomainId", is_optional: false },
    :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.



318
319
320
321
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 318

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:



330
331
332
333
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 330

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:



340
341
342
343
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 340

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:



351
352
353
354
355
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 351

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.


408
409
410
411
412
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 408

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.



418
419
420
421
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 418

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.



430
431
432
433
434
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 430

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:



443
444
445
446
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 443

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:



465
466
467
468
469
470
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 465

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_group_member ⇒ AWSCDK::IResolvable

Information about the registered transit gateway multicast domain group members.

Returns:



188
189
190
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 188

def attr_group_member()
  jsii_get_property("attrGroupMember")
end

#attr_group_source ⇒ AWSCDK::IResolvable

Indicates that the resource is a transit gateway group member.

Returns:



195
196
197
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 195

def attr_group_source()
  jsii_get_property("attrGroupSource")
end

#attr_member_type ⇒ String

Returns:

  • (String) 


200
201
202
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 200

def attr_member_type()
  jsii_get_property("attrMemberType")
end

#attr_resource_id ⇒ String

The ID of the resource.

Returns:

  • (String) 


207
208
209
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 207

def attr_resource_id()
  jsii_get_property("attrResourceId")
end

#attr_resource_type ⇒ String

The type of resource, for example a VPC attachment.

Returns:

  • (String) 


214
215
216
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 214

def attr_resource_type()
  jsii_get_property("attrResourceType")
end

#attr_source_type ⇒ String

The type of source.

Returns:

  • (String) 


221
222
223
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 221

def attr_source_type()
  jsii_get_property("attrSourceType")
end

#attr_subnet_id ⇒ String

The ID of the subnet.

Returns:

  • (String) 


228
229
230
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 228

def attr_subnet_id()
  jsii_get_property("attrSubnetId")
end

#attr_transit_gateway_attachment_id ⇒ String

The ID of the transit gateway attachment.

Returns:

  • (String) 


235
236
237
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 235

def attr_transit_gateway_attachment_id()
  jsii_get_property("attrTransitGatewayAttachmentId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



134
135
136
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 134

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


139
140
141
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 139

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


474
475
476
477
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 474

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


144
145
146
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 144

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


151
152
153
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 151

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


96
97
98
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 96

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



156
157
158
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 156

def env()
  jsii_get_property("env")
end

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

Returns a token for an runtime attribute of this resource.

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

Parameters:

Returns:



487
488
489
490
491
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 487

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:



498
499
500
501
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 498

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

#group_ip_address ⇒ String

The IP address assigned to the transit gateway multicast group.

Returns:

  • (String) 


249
250
251
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 249

def group_ip_address()
  jsii_get_property("groupIpAddress")
end

#group_ip_address=(value) ⇒ Object 



253
254
255
256
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 253

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



568
569
570
571
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 568

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) 


108
109
110
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 108

def logical_id()
  jsii_get_property("logicalId")
end

#network_interface_id ⇒ String

The group sources' network interface IDs to register with the transit gateway multicast group.

Returns:

  • (String) 


261
262
263
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 261

def network_interface_id()
  jsii_get_property("networkInterfaceId")
end

#network_interface_id=(value) ⇒ Object 



265
266
267
268
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 265

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


91
92
93
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 91

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:



509
510
511
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 509

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:



516
517
518
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 516

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.



309
310
311
312
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 309

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) 


127
128
129
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 127

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:



527
528
529
530
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 527

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


534
535
536
537
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 534

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:



544
545
546
547
548
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 544

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.



553
554
555
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 553

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



117
118
119
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 117

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



285
286
287
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 285

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

#transit_gateway_multicast_domain_id ⇒ String

The ID of the transit gateway multicast domain.

Returns:

  • (String) 


273
274
275
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 273

def transit_gateway_multicast_domain_id()
  jsii_get_property("transitGatewayMulticastDomainId")
end

#transit_gateway_multicast_domain_id=(value) ⇒ Object 



277
278
279
280
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 277

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

#transit_gateway_multicast_group_source_ref ⇒ AWSCDK::Interfaces::AWSEC2::TransitGatewayMulticastGroupSourceReference

A reference to a TransitGatewayMulticastGroupSource resource.

Returns:



242
243
244
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 242

def transit_gateway_multicast_group_source_ref()
  jsii_get_property("transitGatewayMulticastGroupSourceRef")
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}) 


164
165
166
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 164

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


174
175
176
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 174

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


559
560
561
562
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 559

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

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

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

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


298
299
300
301
302
303
 
# File 'ec2/cfn_transit_gateway_multicast_group_source.rb', line 298

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