Class: AWSCDK::EC2::CfnTransitGateway

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::ITransitGatewayRef
Defined in:
ec2/cfn_transit_gateway.rb

Overview

Specifies a transit gateway.

You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available state, you can attach your VPCs and VPN connections to the transit gateway.

To attach your VPCs, use AWS::EC2::TransitGatewayAttachment .

To attach a VPN connection, use AWS::EC2::CustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to AWS::EC2::VPNConnection .

When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use AWS::EC2::TransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use AWS::EC2::TransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AWS::EC2::TransitGatewayRouteTableAssociation to associate a resource attachment with a transit gateway route table.

To create a transit gateway with EncryptionSupport enabled through CloudFormation, you will need the ec2:ModifyTransitGateway Identity and Access Management (IAM) permission. For more information, see ModifyTransitGateway in Actions, resources, and condition keys for Amazon EC2 of the Identify and Access Management Service Authorization Reference .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnTransitGateway

Create a new AWS::EC2::TransitGateway.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EC2::CfnTransitGatewayProps, nil) (defaults to: nil) —

    Resource properties.



28
29
30
31
32
33
34
 
# File 'ec2/cfn_transit_gateway.rb', line 28

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::EC2::CfnTransitGatewayProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmblRyYW5zaXRHYXRld2F5UHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_transit_gateway(resource) ⇒ String

Parameters:

Returns:

  • (String) 


97
98
99
100
 
# File 'ec2/cfn_transit_gateway.rb', line 97

def self.arn_for_transit_gateway(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSVRyYW5zaXRHYXRld2F5UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGateway", "arnForTransitGateway", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


230
231
232
 
# File 'ec2/cfn_transit_gateway.rb', line 230

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

.from_transit_gateway_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::ITransitGatewayRef

Creates a new ITransitGatewayRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



108
109
110
111
112
113
 
# File 'ec2/cfn_transit_gateway.rb', line 108

def self.from_transit_gateway_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGateway", "fromTransitGatewayArn", [scope, id, arn])
end

.from_transit_gateway_id(scope, id, transit_gateway_id) ⇒ AWSCDK::Interfaces::AWSEC2::ITransitGatewayRef

Creates a new ITransitGatewayRef from a transitGatewayId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • transit_gateway_id (String)

Returns:



121
122
123
124
125
126
 
# File 'ec2/cfn_transit_gateway.rb', line 121

def self.from_transit_gateway_id(scope, id, transit_gateway_id)
  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(transit_gateway_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "transitGatewayId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnTransitGateway", "fromTransitGatewayId", [scope, id, transit_gateway_id])
end

.is_cfn_transit_gateway(x) ⇒ Boolean

Checks whether the given object is a CfnTransitGateway.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


132
133
134
135
 
# File 'ec2/cfn_transit_gateway.rb', line 132

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

.jsii_overridable_methods ⇒ Object 



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
92
93
 
# File 'ec2/cfn_transit_gateway.rb', line 36

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_encryption_support_state => { kind: :property, name: "attrEncryptionSupportState", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_transit_gateway_arn => { kind: :property, name: "attrTransitGatewayArn", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :transit_gateway_ref => { kind: :property, name: "transitGatewayRef", is_optional: false },
    :amazon_side_asn => { kind: :property, name: "amazonSideAsn", is_optional: true },
    :association_default_route_table_id => { kind: :property, name: "associationDefaultRouteTableId", is_optional: true },
    :auto_accept_shared_attachments => { kind: :property, name: "autoAcceptSharedAttachments", is_optional: true },
    :default_route_table_association => { kind: :property, name: "defaultRouteTableAssociation", is_optional: true },
    :default_route_table_propagation => { kind: :property, name: "defaultRouteTablePropagation", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :dns_support => { kind: :property, name: "dnsSupport", is_optional: true },
    :encryption_support => { kind: :property, name: "encryptionSupport", is_optional: true },
    :multicast_support => { kind: :property, name: "multicastSupport", is_optional: true },
    :propagation_default_route_table_id => { kind: :property, name: "propagationDefaultRouteTableId", is_optional: true },
    :security_group_referencing_support => { kind: :property, name: "securityGroupReferencingSupport", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :transit_gateway_cidr_blocks => { kind: :property, name: "transitGatewayCidrBlocks", is_optional: true },
    :vpn_ecmp_support => { kind: :property, name: "vpnEcmpSupport", 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.



472
473
474
475
 
# File 'ec2/cfn_transit_gateway.rb', line 472

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:



484
485
486
487
 
# File 'ec2/cfn_transit_gateway.rb', line 484

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:



494
495
496
497
 
# File 'ec2/cfn_transit_gateway.rb', line 494

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:



505
506
507
508
509
 
# File 'ec2/cfn_transit_gateway.rb', line 505

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.


562
563
564
565
566
 
# File 'ec2/cfn_transit_gateway.rb', line 562

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.



572
573
574
575
 
# File 'ec2/cfn_transit_gateway.rb', line 572

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.



584
585
586
587
588
 
# File 'ec2/cfn_transit_gateway.rb', line 584

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

#amazon_side_asn ⇒ Numeric?

A private Autonomous System Number (ASN) for the Amazon side of a BGP session.

Returns:

  • (Numeric, nil) 


270
271
272
 
# File 'ec2/cfn_transit_gateway.rb', line 270

def amazon_side_asn()
  jsii_get_property("amazonSideAsn")
end

#amazon_side_asn=(value) ⇒ Object 



274
275
276
277
 
# File 'ec2/cfn_transit_gateway.rb', line 274

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



597
598
599
600
 
# File 'ec2/cfn_transit_gateway.rb', line 597

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:



619
620
621
622
623
624
 
# File 'ec2/cfn_transit_gateway.rb', line 619

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

#association_default_route_table_id ⇒ String?

The ID of the default association route table.

Returns:

  • (String, nil) 


282
283
284
 
# File 'ec2/cfn_transit_gateway.rb', line 282

def association_default_route_table_id()
  jsii_get_property("associationDefaultRouteTableId")
end

#association_default_route_table_id=(value) ⇒ Object 



286
287
288
289
 
# File 'ec2/cfn_transit_gateway.rb', line 286

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

#attr_encryption_support_state ⇒ String

The encryption support state of the transit gateway.

Returns:

  • (String) 


237
238
239
 
# File 'ec2/cfn_transit_gateway.rb', line 237

def attr_encryption_support_state()
  jsii_get_property("attrEncryptionSupportState")
end

#attr_id ⇒ String

The ID of the transit gateway.

Returns:

  • (String) 


244
245
246
 
# File 'ec2/cfn_transit_gateway.rb', line 244

def attr_id()
  jsii_get_property("attrId")
end

#attr_transit_gateway_arn ⇒ String

Returns:

  • (String) 


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

def attr_transit_gateway_arn()
  jsii_get_property("attrTransitGatewayArn")
end

#auto_accept_shared_attachments ⇒ String?

Enable or disable automatic acceptance of attachment requests.

Returns:

  • (String, nil) 


294
295
296
 
# File 'ec2/cfn_transit_gateway.rb', line 294

def auto_accept_shared_attachments()
  jsii_get_property("autoAcceptSharedAttachments")
end

#auto_accept_shared_attachments=(value) ⇒ Object 



298
299
300
301
 
# File 'ec2/cfn_transit_gateway.rb', line 298

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



183
184
185
 
# File 'ec2/cfn_transit_gateway.rb', line 183

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


628
629
630
631
 
# File 'ec2/cfn_transit_gateway.rb', line 628

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


193
194
195
 
# File 'ec2/cfn_transit_gateway.rb', line 193

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


145
146
147
 
# File 'ec2/cfn_transit_gateway.rb', line 145

def creation_stack()
  jsii_get_property("creationStack")
end

#default_route_table_association ⇒ String?

Enable or disable automatic association with the default association route table.

Returns:

  • (String, nil) 


306
307
308
 
# File 'ec2/cfn_transit_gateway.rb', line 306

def default_route_table_association()
  jsii_get_property("defaultRouteTableAssociation")
end

#default_route_table_association=(value) ⇒ Object 



310
311
312
313
 
# File 'ec2/cfn_transit_gateway.rb', line 310

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

#default_route_table_propagation ⇒ String?

Enable or disable automatic propagation of routes to the default propagation route table.

Returns:

  • (String, nil) 


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

def default_route_table_propagation()
  jsii_get_property("defaultRouteTablePropagation")
end

#default_route_table_propagation=(value) ⇒ Object 



322
323
324
325
 
# File 'ec2/cfn_transit_gateway.rb', line 322

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

#description ⇒ String?

The description of the transit gateway.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



334
335
336
337
 
# File 'ec2/cfn_transit_gateway.rb', line 334

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

#dns_support ⇒ String?

Enable or disable DNS support.

Returns:

  • (String, nil) 


342
343
344
 
# File 'ec2/cfn_transit_gateway.rb', line 342

def dns_support()
  jsii_get_property("dnsSupport")
end

#dns_support=(value) ⇒ Object 



346
347
348
349
 
# File 'ec2/cfn_transit_gateway.rb', line 346

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

#encryption_support ⇒ String?

Enable or disable encryption support.

Returns:

  • (String, nil) 


354
355
356
 
# File 'ec2/cfn_transit_gateway.rb', line 354

def encryption_support()
  jsii_get_property("encryptionSupport")
end

#encryption_support=(value) ⇒ Object 



358
359
360
361
 
# File 'ec2/cfn_transit_gateway.rb', line 358

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



205
206
207
 
# File 'ec2/cfn_transit_gateway.rb', line 205

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:



641
642
643
644
645
 
# File 'ec2/cfn_transit_gateway.rb', line 641

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:



652
653
654
655
 
# File 'ec2/cfn_transit_gateway.rb', line 652

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



722
723
724
725
 
# File 'ec2/cfn_transit_gateway.rb', line 722

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) 


157
158
159
 
# File 'ec2/cfn_transit_gateway.rb', line 157

def logical_id()
  jsii_get_property("logicalId")
end

#multicast_support ⇒ String?

Indicates whether multicast is enabled on the transit gateway.

Returns:

  • (String, nil) 


366
367
368
 
# File 'ec2/cfn_transit_gateway.rb', line 366

def multicast_support()
  jsii_get_property("multicastSupport")
end

#multicast_support=(value) ⇒ Object 



370
371
372
373
 
# File 'ec2/cfn_transit_gateway.rb', line 370

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


140
141
142
 
# File 'ec2/cfn_transit_gateway.rb', line 140

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:



663
664
665
 
# File 'ec2/cfn_transit_gateway.rb', line 663

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:



670
671
672
 
# File 'ec2/cfn_transit_gateway.rb', line 670

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.



463
464
465
466
 
# File 'ec2/cfn_transit_gateway.rb', line 463

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

#propagation_default_route_table_id ⇒ String?

The ID of the default propagation route table.

Returns:

  • (String, nil) 


378
379
380
 
# File 'ec2/cfn_transit_gateway.rb', line 378

def propagation_default_route_table_id()
  jsii_get_property("propagationDefaultRouteTableId")
end

#propagation_default_route_table_id=(value) ⇒ Object 



382
383
384
385
 
# File 'ec2/cfn_transit_gateway.rb', line 382

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


176
177
178
 
# File 'ec2/cfn_transit_gateway.rb', line 176

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:



681
682
683
684
 
# File 'ec2/cfn_transit_gateway.rb', line 681

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


688
689
690
691
 
# File 'ec2/cfn_transit_gateway.rb', line 688

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:



698
699
700
701
702
 
# File 'ec2/cfn_transit_gateway.rb', line 698

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

#security_group_referencing_support ⇒ String?

Enables you to reference a security group across VPCs attached to a transit gateway (TGW).

Returns:

  • (String, nil) 


390
391
392
 
# File 'ec2/cfn_transit_gateway.rb', line 390

def security_group_referencing_support()
  jsii_get_property("securityGroupReferencingSupport")
end

#security_group_referencing_support=(value) ⇒ Object 



394
395
396
397
 
# File 'ec2/cfn_transit_gateway.rb', line 394

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



707
708
709
 
# File 'ec2/cfn_transit_gateway.rb', line 707

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:



166
167
168
 
# File 'ec2/cfn_transit_gateway.rb', line 166

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



256
257
258
 
# File 'ec2/cfn_transit_gateway.rb', line 256

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the transit gateway.

Returns:



402
403
404
 
# File 'ec2/cfn_transit_gateway.rb', line 402

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



406
407
408
409
410
 
# File 'ec2/cfn_transit_gateway.rb', line 406

def tags_raw=(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=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



439
440
441
 
# File 'ec2/cfn_transit_gateway.rb', line 439

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

#transit_gateway_cidr_blocks ⇒ Array<String>?

The transit gateway CIDR blocks.

Returns:

  • (Array<String>, nil) 


415
416
417
 
# File 'ec2/cfn_transit_gateway.rb', line 415

def transit_gateway_cidr_blocks()
  jsii_get_property("transitGatewayCidrBlocks")
end

#transit_gateway_cidr_blocks=(value) ⇒ Object 



419
420
421
422
 
# File 'ec2/cfn_transit_gateway.rb', line 419

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

#transit_gateway_ref ⇒ AWSCDK::Interfaces::AWSEC2::TransitGatewayReference

A reference to a TransitGateway resource.

Returns:



263
264
265
 
# File 'ec2/cfn_transit_gateway.rb', line 263

def transit_gateway_ref()
  jsii_get_property("transitGatewayRef")
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}) 


213
214
215
 
# File 'ec2/cfn_transit_gateway.rb', line 213

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


223
224
225
 
# File 'ec2/cfn_transit_gateway.rb', line 223

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


713
714
715
716
 
# File 'ec2/cfn_transit_gateway.rb', line 713

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

#vpn_ecmp_support ⇒ String?

Enable or disable Equal Cost Multipath Protocol support.

Returns:

  • (String, nil) 


427
428
429
 
# File 'ec2/cfn_transit_gateway.rb', line 427

def vpn_ecmp_support()
  jsii_get_property("vpnEcmpSupport")
end

#vpn_ecmp_support=(value) ⇒ Object 



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

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


452
453
454
455
456
457
 
# File 'ec2/cfn_transit_gateway.rb', line 452

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