Class: AWSCDK::EC2::CfnRoute

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

Overview

Specifies a route in a route table. For more information, see Routes in the Amazon VPC User Guide .

You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target.

If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a DependsOn Attribute in the AWS::EC2::Route resource to explicitly declare a dependency on the AWS::EC2::TransitGatewayAttachment resource.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRoute

Create a new AWS::EC2::Route.

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

    Resource properties.



21
22
23
24
25
26
27
 
# File 'ec2/cfn_route.rb', line 21

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


189
190
191
 
# File 'ec2/cfn_route.rb', line 189

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

.is_cfn_route(x) ⇒ Boolean

Checks whether the given object is a CfnRoute.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'ec2/cfn_route.rb', line 29

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_cidr_block => { kind: :property, name: "attrCidrBlock", is_optional: false },
    :route_ref => { kind: :property, name: "routeRef", is_optional: false },
    :route_table_id => { kind: :property, name: "routeTableId", is_optional: false },
    :carrier_gateway_id => { kind: :property, name: "carrierGatewayId", is_optional: true },
    :core_network_arn => { kind: :property, name: "coreNetworkArn", is_optional: true },
    :destination_cidr_block => { kind: :property, name: "destinationCidrBlock", is_optional: true },
    :destination_ipv6_cidr_block => { kind: :property, name: "destinationIpv6CidrBlock", is_optional: true },
    :destination_prefix_list_id => { kind: :property, name: "destinationPrefixListId", is_optional: true },
    :egress_only_internet_gateway_id => { kind: :property, name: "egressOnlyInternetGatewayId", is_optional: true },
    :gateway_id => { kind: :property, name: "gatewayId", is_optional: true },
    :instance_id => { kind: :property, name: "instanceId", is_optional: true },
    :local_gateway_id => { kind: :property, name: "localGatewayId", is_optional: true },
    :nat_gateway_id => { kind: :property, name: "natGatewayId", is_optional: true },
    :network_interface_id => { kind: :property, name: "networkInterfaceId", is_optional: true },
    :odb_network_arn => { kind: :property, name: "odbNetworkArn", is_optional: true },
    :transit_gateway_id => { kind: :property, name: "transitGatewayId", is_optional: true },
    :vpc_endpoint_id => { kind: :property, name: "vpcEndpointId", is_optional: true },
    :vpc_peering_connection_id => { kind: :property, name: "vpcPeeringConnectionId", 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.



435
436
437
438
 
# File 'ec2/cfn_route.rb', line 435

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:



447
448
449
450
 
# File 'ec2/cfn_route.rb', line 447

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:



457
458
459
460
 
# File 'ec2/cfn_route.rb', line 457

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:



468
469
470
471
472
 
# File 'ec2/cfn_route.rb', line 468

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.


525
526
527
528
529
 
# File 'ec2/cfn_route.rb', line 525

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.



535
536
537
538
 
# File 'ec2/cfn_route.rb', line 535

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.



547
548
549
550
551
 
# File 'ec2/cfn_route.rb', line 547

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:



560
561
562
563
 
# File 'ec2/cfn_route.rb', line 560

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:



582
583
584
585
586
587
 
# File 'ec2/cfn_route.rb', line 582

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

The IPv4 CIDR block.

Returns:

  • (String) 


196
197
198
 
# File 'ec2/cfn_route.rb', line 196

def attr_cidr_block()
  jsii_get_property("attrCidrBlock")
end

#carrier_gateway_id ⇒ String?

The ID of the carrier gateway.

Returns:

  • (String, nil) 


222
223
224
 
# File 'ec2/cfn_route.rb', line 222

def carrier_gateway_id()
  jsii_get_property("carrierGatewayId")
end

#carrier_gateway_id=(value) ⇒ Object 



226
227
228
229
 
# File 'ec2/cfn_route.rb', line 226

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'ec2/cfn_route.rb', line 142

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


147
148
149
 
# File 'ec2/cfn_route.rb', line 147

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


591
592
593
594
 
# File 'ec2/cfn_route.rb', line 591

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


152
153
154
 
# File 'ec2/cfn_route.rb', line 152

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


159
160
161
 
# File 'ec2/cfn_route.rb', line 159

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#core_network_arn ⇒ String?

The Amazon Resource Name (ARN) of the core network.

Returns:

  • (String, nil) 


234
235
236
 
# File 'ec2/cfn_route.rb', line 234

def core_network_arn()
  jsii_get_property("coreNetworkArn")
end

#core_network_arn=(value) ⇒ Object 



238
239
240
241
 
# File 'ec2/cfn_route.rb', line 238

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


104
105
106
 
# File 'ec2/cfn_route.rb', line 104

def creation_stack()
  jsii_get_property("creationStack")
end

#destination_cidr_block ⇒ String?

The IPv4 CIDR address block used for the destination match.

Returns:

  • (String, nil) 


246
247
248
 
# File 'ec2/cfn_route.rb', line 246

def destination_cidr_block()
  jsii_get_property("destinationCidrBlock")
end

#destination_cidr_block=(value) ⇒ Object 



250
251
252
253
 
# File 'ec2/cfn_route.rb', line 250

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

#destination_ipv6_cidr_block ⇒ String?

The IPv6 CIDR block used for the destination match.

Returns:

  • (String, nil) 


258
259
260
 
# File 'ec2/cfn_route.rb', line 258

def destination_ipv6_cidr_block()
  jsii_get_property("destinationIpv6CidrBlock")
end

#destination_ipv6_cidr_block=(value) ⇒ Object 



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

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

#destination_prefix_list_id ⇒ String?

The ID of a prefix list used for the destination match.

Returns:

  • (String, nil) 


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

def destination_prefix_list_id()
  jsii_get_property("destinationPrefixListId")
end

#destination_prefix_list_id=(value) ⇒ Object 



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

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

#egress_only_internet_gateway_id ⇒ String?

[IPv6 traffic only] The ID of an egress-only internet gateway.

Returns:

  • (String, nil) 


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

def egress_only_internet_gateway_id()
  jsii_get_property("egressOnlyInternetGatewayId")
end

#egress_only_internet_gateway_id=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#gateway_id ⇒ String?

The ID of an internet gateway or virtual private gateway attached to your VPC.

Returns:

  • (String, nil) 


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

def gateway_id()
  jsii_get_property("gatewayId")
end

#gateway_id=(value) ⇒ Object 



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

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



604
605
606
607
608
 
# File 'ec2/cfn_route.rb', line 604

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:



615
616
617
618
 
# File 'ec2/cfn_route.rb', line 615

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:



685
686
687
688
 
# File 'ec2/cfn_route.rb', line 685

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

#instance_id ⇒ String?

The ID of a NAT instance in your VPC.

Returns:

  • (String, nil) 


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

def instance_id()
  jsii_get_property("instanceId")
end

#instance_id=(value) ⇒ Object 



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

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

#local_gateway_id ⇒ String?

The ID of the local gateway.

Returns:

  • (String, nil) 


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

def local_gateway_id()
  jsii_get_property("localGatewayId")
end

#local_gateway_id=(value) ⇒ Object 



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

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


116
117
118
 
# File 'ec2/cfn_route.rb', line 116

def logical_id()
  jsii_get_property("logicalId")
end

#nat_gateway_id ⇒ String?

[IPv4 traffic only] The ID of a NAT gateway.

Returns:

  • (String, nil) 


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

def nat_gateway_id()
  jsii_get_property("natGatewayId")
end

#nat_gateway_id=(value) ⇒ Object 



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

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

#network_interface_id ⇒ String?

The ID of a network interface.

Returns:

  • (String, nil) 


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

def network_interface_id()
  jsii_get_property("networkInterfaceId")
end

#network_interface_id=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'ec2/cfn_route.rb', line 99

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:



626
627
628
 
# File 'ec2/cfn_route.rb', line 626

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:



633
634
635
 
# File 'ec2/cfn_route.rb', line 633

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

#odb_network_arn ⇒ String?

The Amazon Resource Name (ARN) of the ODB network.

Returns:

  • (String, nil) 


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

def odb_network_arn()
  jsii_get_property("odbNetworkArn")
end

#odb_network_arn=(value) ⇒ Object 



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

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

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



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

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) 


135
136
137
 
# File 'ec2/cfn_route.rb', line 135

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:



644
645
646
647
 
# File 'ec2/cfn_route.rb', line 644

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


651
652
653
654
 
# File 'ec2/cfn_route.rb', line 651

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:



661
662
663
664
665
 
# File 'ec2/cfn_route.rb', line 661

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

#route_ref ⇒ AWSCDK::Interfaces::AWSEC2::RouteReference

A reference to a Route resource.

Returns:



203
204
205
 
# File 'ec2/cfn_route.rb', line 203

def route_ref()
  jsii_get_property("routeRef")
end

#route_table_id ⇒ String

The ID of the route table for the route.

Returns:

  • (String) 


210
211
212
 
# File 'ec2/cfn_route.rb', line 210

def route_table_id()
  jsii_get_property("routeTableId")
end

#route_table_id=(value) ⇒ Object 



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

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



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

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:



125
126
127
 
# File 'ec2/cfn_route.rb', line 125

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



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

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

#transit_gateway_id ⇒ String?

The ID of a transit gateway.

Returns:

  • (String, nil) 


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

def transit_gateway_id()
  jsii_get_property("transitGatewayId")
end

#transit_gateway_id=(value) ⇒ Object 



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

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


172
173
174
 
# File 'ec2/cfn_route.rb', line 172

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


182
183
184
 
# File 'ec2/cfn_route.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


676
677
678
679
 
# File 'ec2/cfn_route.rb', line 676

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

#vpc_endpoint_id ⇒ String?

The ID of a VPC endpoint.

Returns:

  • (String, nil) 


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

def vpc_endpoint_id()
  jsii_get_property("vpcEndpointId")
end

#vpc_endpoint_id=(value) ⇒ Object 



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

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

#vpc_peering_connection_id ⇒ String?

The ID of a VPC peering connection.

Returns:

  • (String, nil) 


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

def vpc_peering_connection_id()
  jsii_get_property("vpcPeeringConnectionId")
end

#vpc_peering_connection_id=(value) ⇒ Object 



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

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


415
416
417
418
419
420
 
# File 'ec2/cfn_route.rb', line 415

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