Class: AWSCDK::EC2::CfnLocalGatewayVirtualInterface

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSEC2::ILocalGatewayVirtualInterfaceRef
Defined in:
ec2/cfn_local_gateway_virtual_interface.rb

Overview

Describes a local gateway virtual interface.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnLocalGatewayVirtualInterface

Create a new AWS::EC2::LocalGatewayVirtualInterface.

Parameters:



18
19
20
21
22
23
24
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 18

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

Class Method Details

.arn_for_local_gateway_virtual_interface(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_local_gateway_virtual_interface(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUxvY2FsR2F0ZXdheVZpcnR1YWxJbnRlcmZhY2VSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnLocalGatewayVirtualInterface", "arnForLocalGatewayVirtualInterface", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_local_gateway_virtual_interface_id(scope, id, local_gateway_virtual_interface_id) ⇒ AWSCDK::Interfaces::AWSEC2::ILocalGatewayVirtualInterfaceRef

Creates a new ILocalGatewayVirtualInterfaceRef from a localGatewayVirtualInterfaceId.

Parameters:

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

Returns:



94
95
96
97
98
99
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 94

def self.from_local_gateway_virtual_interface_id(scope, id, local_gateway_virtual_interface_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(local_gateway_virtual_interface_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "localGatewayVirtualInterfaceId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnLocalGatewayVirtualInterface", "fromLocalGatewayVirtualInterfaceId", [scope, id, local_gateway_virtual_interface_id])
end

.is_cfn_local_gateway_virtual_interface(x) ⇒ Boolean

Checks whether the given object is a CfnLocalGatewayVirtualInterface.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


105
106
107
108
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 105

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

.jsii_overridable_methods ⇒ Object 



26
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
78
79
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 26

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_configuration_state => { kind: :property, name: "attrConfigurationState", is_optional: false },
    :attr_local_bgp_asn => { kind: :property, name: "attrLocalBgpAsn", is_optional: false },
    :attr_local_gateway_id => { kind: :property, name: "attrLocalGatewayId", is_optional: false },
    :attr_local_gateway_virtual_interface_id => { kind: :property, name: "attrLocalGatewayVirtualInterfaceId", is_optional: false },
    :attr_owner_id => { kind: :property, name: "attrOwnerId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :local_gateway_virtual_interface_ref => { kind: :property, name: "localGatewayVirtualInterfaceRef", is_optional: false },
    :local_address => { kind: :property, name: "localAddress", is_optional: false },
    :local_gateway_virtual_interface_group_id => { kind: :property, name: "localGatewayVirtualInterfaceGroupId", is_optional: false },
    :outpost_lag_id => { kind: :property, name: "outpostLagId", is_optional: false },
    :peer_address => { kind: :property, name: "peerAddress", is_optional: false },
    :vlan => { kind: :property, name: "vlan", is_optional: false },
    :peer_bgp_asn => { kind: :property, name: "peerBgpAsn", is_optional: true },
    :peer_bgp_asn_extended => { kind: :property, name: "peerBgpAsnExtended", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



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

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:



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

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:



411
412
413
414
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 411

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:



422
423
424
425
426
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 422

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.


479
480
481
482
483
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 479

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.



489
490
491
492
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 489

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.



501
502
503
504
505
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 501

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:



514
515
516
517
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 514

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:



536
537
538
539
540
541
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 536

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

The current state of the local gateway virtual interface.

Returns:

  • (String) 


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

def attr_configuration_state()
  jsii_get_property("attrConfigurationState")
end

#attr_local_bgp_asn ⇒ Numeric

The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.

Returns:

  • (Numeric) 


217
218
219
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 217

def attr_local_bgp_asn()
  jsii_get_property("attrLocalBgpAsn")
end

#attr_local_gateway_id ⇒ String

The ID of the local gateway.

Returns:

  • (String) 


224
225
226
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 224

def attr_local_gateway_id()
  jsii_get_property("attrLocalGatewayId")
end

#attr_local_gateway_virtual_interface_id ⇒ String

The ID of the virtual interface.

Returns:

  • (String) 


231
232
233
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 231

def attr_local_gateway_virtual_interface_id()
  jsii_get_property("attrLocalGatewayVirtualInterfaceId")
end

#attr_owner_id ⇒ String

The ID of the AWS account that owns the local gateway virtual interface.

Returns:

  • (String) 


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

def attr_owner_id()
  jsii_get_property("attrOwnerId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



245
246
247
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 245

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


173
174
175
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 173

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 178

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:



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

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:



569
570
571
572
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 569

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:



639
640
641
642
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 639

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

#local_address ⇒ String

The local address.

Returns:

  • (String) 


259
260
261
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 259

def local_address()
  jsii_get_property("localAddress")
end

#local_address=(value) ⇒ Object 



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

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

#local_gateway_virtual_interface_group_id ⇒ String

The ID of the local gateway virtual interface group.

Returns:

  • (String) 


271
272
273
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 271

def local_gateway_virtual_interface_group_id()
  jsii_get_property("localGatewayVirtualInterfaceGroupId")
end

#local_gateway_virtual_interface_group_id=(value) ⇒ Object 



275
276
277
278
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 275

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

#local_gateway_virtual_interface_ref ⇒ AWSCDK::Interfaces::AWSEC2::LocalGatewayVirtualInterfaceReference

A reference to a LocalGatewayVirtualInterface resource.

Returns:



252
253
254
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 252

def local_gateway_virtual_interface_ref()
  jsii_get_property("localGatewayVirtualInterfaceRef")
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) 


130
131
132
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 113

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:



580
581
582
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 580

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:



587
588
589
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 587

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

#outpost_lag_id ⇒ String

The Outpost LAG ID.

Returns:

  • (String) 


283
284
285
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 283

def outpost_lag_id()
  jsii_get_property("outpostLagId")
end

#outpost_lag_id=(value) ⇒ Object 



287
288
289
290
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 287

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



380
381
382
383
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 380

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

#peer_address ⇒ String

The peer address.

Returns:

  • (String) 


295
296
297
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 295

def peer_address()
  jsii_get_property("peerAddress")
end

#peer_address=(value) ⇒ Object 



299
300
301
302
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 299

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

#peer_bgp_asn ⇒ Numeric?

The peer BGP ASN.

Returns:

  • (Numeric, nil) 


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

def peer_bgp_asn()
  jsii_get_property("peerBgpAsn")
end

#peer_bgp_asn=(value) ⇒ Object 



323
324
325
326
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 323

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

#peer_bgp_asn_extended ⇒ Numeric?

The extended 32-bit ASN of the BGP peer for use with larger ASN values.

Returns:

  • (Numeric, nil) 


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

def peer_bgp_asn_extended()
  jsii_get_property("peerBgpAsnExtended")
end

#peer_bgp_asn_extended=(value) ⇒ Object 



335
336
337
338
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 335

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


149
150
151
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 149

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:



598
599
600
601
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 598

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


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

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:



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

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.



624
625
626
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 624

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:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags assigned to the virtual interface.

Returns:



343
344
345
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 343

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



347
348
349
350
351
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 347

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



356
357
358
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 356

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

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


186
187
188
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 186

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


630
631
632
633
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 630

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

#vlan ⇒ Numeric

The ID of the VLAN.

Returns:

  • (Numeric) 


307
308
309
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 307

def vlan()
  jsii_get_property("vlan")
end

#vlan=(value) ⇒ Object 



311
312
313
314
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 311

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


369
370
371
372
373
374
 
# File 'ec2/cfn_local_gateway_virtual_interface.rb', line 369

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