Class: AWSCDK::NetworkManager::CfnVPCAttachment

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSNetworkmanager::IVPCAttachmentRef
Defined in:
network_manager/cfn_vpc_attachment.rb

Overview

Creates a VPC attachment on an edge location of a core network.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnVPCAttachment

Create a new AWS::NetworkManager::VpcAttachment.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::NetworkManager::CfnVPCAttachmentProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'network_manager/cfn_vpc_attachment.rb', line 18

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

Class Method Details

.arn_for_vpc_attachment(resource) ⇒ String

Parameters:

Returns:

  • (String) 


91
92
93
94
 
# File 'network_manager/cfn_vpc_attachment.rb', line 91

def self.arn_for_vpc_attachment(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19uZXR3b3JrbWFuYWdlci5JVnBjQXR0YWNobWVudFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnVpcAttachment", "arnForVpcAttachment", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


211
212
213
 
# File 'network_manager/cfn_vpc_attachment.rb', line 211

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

.from_attachment_id(scope, id, attachment_id) ⇒ AWSCDK::Interfaces::AWSNetworkmanager::IVPCAttachmentRef

Creates a new IVpcAttachmentRef from a attachmentId.

Parameters:

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

Returns:



102
103
104
105
106
107
 
# File 'network_manager/cfn_vpc_attachment.rb', line 102

def self.from_attachment_id(scope, id, attachment_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(attachment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attachmentId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnVpcAttachment", "fromAttachmentId", [scope, id, attachment_id])
end

.is_cfn_vpc_attachment(x) ⇒ Boolean

Checks whether the given object is a CfnVpcAttachment.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


113
114
115
116
 
# File 'network_manager/cfn_vpc_attachment.rb', line 113

def self.is_cfn_vpc_attachment(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_networkmanager.CfnVpcAttachment", "isCfnVpcAttachment", [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
80
81
82
83
84
85
86
87
 
# File 'network_manager/cfn_vpc_attachment.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_attachment_id => { kind: :property, name: "attrAttachmentId", is_optional: false },
    :attr_attachment_policy_rule_number => { kind: :property, name: "attrAttachmentPolicyRuleNumber", is_optional: false },
    :attr_attachment_type => { kind: :property, name: "attrAttachmentType", is_optional: false },
    :attr_core_network_arn => { kind: :property, name: "attrCoreNetworkArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_edge_location => { kind: :property, name: "attrEdgeLocation", is_optional: false },
    :attr_last_modification_errors => { kind: :property, name: "attrLastModificationErrors", is_optional: false },
    :attr_network_function_group_name => { kind: :property, name: "attrNetworkFunctionGroupName", is_optional: false },
    :attr_owner_account_id => { kind: :property, name: "attrOwnerAccountId", is_optional: false },
    :attr_resource_arn => { kind: :property, name: "attrResourceArn", is_optional: false },
    :attr_segment_name => { kind: :property, name: "attrSegmentName", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :vpc_attachment_ref => { kind: :property, name: "vpcAttachmentRef", is_optional: false },
    :core_network_id => { kind: :property, name: "coreNetworkId", is_optional: false },
    :subnet_arns => { kind: :property, name: "subnetArns", is_optional: false },
    :vpc_arn => { kind: :property, name: "vpcArn", is_optional: false },
    :options => { kind: :property, name: "options", is_optional: true },
    :proposed_network_function_group_change => { kind: :property, name: "proposedNetworkFunctionGroupChange", is_optional: true },
    :proposed_segment_change => { kind: :property, name: "proposedSegmentChange", is_optional: true },
    :routing_policy_label => { kind: :property, name: "routingPolicyLabel", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", 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.



460
461
462
463
 
# File 'network_manager/cfn_vpc_attachment.rb', line 460

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:



472
473
474
475
 
# File 'network_manager/cfn_vpc_attachment.rb', line 472

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:



482
483
484
485
 
# File 'network_manager/cfn_vpc_attachment.rb', line 482

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:



493
494
495
496
497
 
# File 'network_manager/cfn_vpc_attachment.rb', line 493

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.


550
551
552
553
554
 
# File 'network_manager/cfn_vpc_attachment.rb', line 550

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.



560
561
562
563
 
# File 'network_manager/cfn_vpc_attachment.rb', line 560

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.



572
573
574
575
576
 
# File 'network_manager/cfn_vpc_attachment.rb', line 572

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:



585
586
587
588
 
# File 'network_manager/cfn_vpc_attachment.rb', line 585

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:



607
608
609
610
611
612
 
# File 'network_manager/cfn_vpc_attachment.rb', line 607

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

The ID of the VPC attachment.

Returns:

  • (String) 


218
219
220
 
# File 'network_manager/cfn_vpc_attachment.rb', line 218

def attr_attachment_id()
  jsii_get_property("attrAttachmentId")
end

#attr_attachment_policy_rule_number ⇒ Numeric

The policy rule number associated with the attachment.

Returns:

  • (Numeric) 


225
226
227
 
# File 'network_manager/cfn_vpc_attachment.rb', line 225

def attr_attachment_policy_rule_number()
  jsii_get_property("attrAttachmentPolicyRuleNumber")
end

#attr_attachment_type ⇒ String

The type of attachment.

This will be VPC .

Returns:

  • (String) 


234
235
236
 
# File 'network_manager/cfn_vpc_attachment.rb', line 234

def attr_attachment_type()
  jsii_get_property("attrAttachmentType")
end

#attr_core_network_arn ⇒ String

The ARN of the core network.

Returns:

  • (String) 


241
242
243
 
# File 'network_manager/cfn_vpc_attachment.rb', line 241

def attr_core_network_arn()
  jsii_get_property("attrCoreNetworkArn")
end

#attr_created_at ⇒ String

The timestamp when the VPC attachment was created.

Returns:

  • (String) 


248
249
250
 
# File 'network_manager/cfn_vpc_attachment.rb', line 248

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_edge_location ⇒ String

The Region where the core network edge is located.

Returns:

  • (String) 


255
256
257
 
# File 'network_manager/cfn_vpc_attachment.rb', line 255

def attr_edge_location()
  jsii_get_property("attrEdgeLocation")
end

#attr_last_modification_errors ⇒ Array<String>

Errors from the last modification of the attachment.

Returns:

  • (Array<String>) 


262
263
264
 
# File 'network_manager/cfn_vpc_attachment.rb', line 262

def attr_last_modification_errors()
  jsii_get_property("attrLastModificationErrors")
end

#attr_network_function_group_name ⇒ String

The name of the network function group.

Returns:

  • (String) 


269
270
271
 
# File 'network_manager/cfn_vpc_attachment.rb', line 269

def attr_network_function_group_name()
  jsii_get_property("attrNetworkFunctionGroupName")
end

#attr_owner_account_id ⇒ String

The ID of the VPC attachment owner.

Returns:

  • (String) 


276
277
278
 
# File 'network_manager/cfn_vpc_attachment.rb', line 276

def ()
  jsii_get_property("attrOwnerAccountId")
end

#attr_resource_arn ⇒ String

The resource ARN for the VPC attachment.

Returns:

  • (String) 


283
284
285
 
# File 'network_manager/cfn_vpc_attachment.rb', line 283

def attr_resource_arn()
  jsii_get_property("attrResourceArn")
end

#attr_segment_name ⇒ String

The name of the attachment's segment.

Returns:

  • (String) 


290
291
292
 
# File 'network_manager/cfn_vpc_attachment.rb', line 290

def attr_segment_name()
  jsii_get_property("attrSegmentName")
end

#attr_state ⇒ String

The state of the attachment.

This can be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING .

Returns:

  • (String) 


299
300
301
 
# File 'network_manager/cfn_vpc_attachment.rb', line 299

def attr_state()
  jsii_get_property("attrState")
end

#attr_updated_at ⇒ String

The timestamp when the VPC attachment was last updated.

Returns:

  • (String) 


306
307
308
 
# File 'network_manager/cfn_vpc_attachment.rb', line 306

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



164
165
166
 
# File 'network_manager/cfn_vpc_attachment.rb', line 164

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


169
170
171
 
# File 'network_manager/cfn_vpc_attachment.rb', line 169

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


616
617
618
619
 
# File 'network_manager/cfn_vpc_attachment.rb', line 616

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


174
175
176
 
# File 'network_manager/cfn_vpc_attachment.rb', line 174

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


181
182
183
 
# File 'network_manager/cfn_vpc_attachment.rb', line 181

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#core_network_id ⇒ String

The core network ID.

Returns:

  • (String) 


327
328
329
 
# File 'network_manager/cfn_vpc_attachment.rb', line 327

def core_network_id()
  jsii_get_property("coreNetworkId")
end

#core_network_id=(value) ⇒ Object 



331
332
333
334
 
# File 'network_manager/cfn_vpc_attachment.rb', line 331

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


126
127
128
 
# File 'network_manager/cfn_vpc_attachment.rb', line 126

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



186
187
188
 
# File 'network_manager/cfn_vpc_attachment.rb', line 186

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:



629
630
631
632
633
 
# File 'network_manager/cfn_vpc_attachment.rb', line 629

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:



640
641
642
643
 
# File 'network_manager/cfn_vpc_attachment.rb', line 640

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:



710
711
712
713
 
# File 'network_manager/cfn_vpc_attachment.rb', line 710

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) 


138
139
140
 
# File 'network_manager/cfn_vpc_attachment.rb', line 138

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


121
122
123
 
# File 'network_manager/cfn_vpc_attachment.rb', line 121

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:



651
652
653
 
# File 'network_manager/cfn_vpc_attachment.rb', line 651

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:



658
659
660
 
# File 'network_manager/cfn_vpc_attachment.rb', line 658

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

#options ⇒ AWSCDK::IResolvable, ...

Options for creating the VPC attachment.

Returns:



363
364
365
 
# File 'network_manager/cfn_vpc_attachment.rb', line 363

def options()
  jsii_get_property("options")
end

#options=(value) ⇒ Object 



367
368
369
370
371
 
# File 'network_manager/cfn_vpc_attachment.rb', line 367

def options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnVPCAttachment::VPCOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5WcGNBdHRhY2htZW50LlZwY09wdGlvbnNQcm9wZXJ0eSJ9XX19")), "options") unless value.nil?
  jsii_set_property("options", 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.



451
452
453
454
 
# File 'network_manager/cfn_vpc_attachment.rb', line 451

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

#proposed_network_function_group_change ⇒ AWSCDK::IResolvable, ...

Describes proposed changes to a network function group.

Returns:



376
377
378
 
# File 'network_manager/cfn_vpc_attachment.rb', line 376

def proposed_network_function_group_change()
  jsii_get_property("proposedNetworkFunctionGroupChange")
end

#proposed_network_function_group_change=(value) ⇒ Object 



380
381
382
383
384
 
# File 'network_manager/cfn_vpc_attachment.rb', line 380

def proposed_network_function_group_change=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnVPCAttachment::ProposedNetworkFunctionGroupChangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5WcGNBdHRhY2htZW50LlByb3Bvc2VkTmV0d29ya0Z1bmN0aW9uR3JvdXBDaGFuZ2VQcm9wZXJ0eSJ9XX19")), "proposedNetworkFunctionGroupChange") unless value.nil?
  jsii_set_property("proposedNetworkFunctionGroupChange", value)
end

#proposed_segment_change ⇒ AWSCDK::IResolvable, ...

Describes a proposed segment change.

Returns:



389
390
391
 
# File 'network_manager/cfn_vpc_attachment.rb', line 389

def proposed_segment_change()
  jsii_get_property("proposedSegmentChange")
end

#proposed_segment_change=(value) ⇒ Object 



393
394
395
396
397
 
# File 'network_manager/cfn_vpc_attachment.rb', line 393

def proposed_segment_change=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::NetworkManager::CfnVPCAttachment::ProposedSegmentChangeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19uZXR3b3JrbWFuYWdlci5DZm5WcGNBdHRhY2htZW50LlByb3Bvc2VkU2VnbWVudENoYW5nZVByb3BlcnR5In1dfX0=")), "proposedSegmentChange") unless value.nil?
  jsii_set_property("proposedSegmentChange", 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) 


157
158
159
 
# File 'network_manager/cfn_vpc_attachment.rb', line 157

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:



669
670
671
672
 
# File 'network_manager/cfn_vpc_attachment.rb', line 669

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


676
677
678
679
 
# File 'network_manager/cfn_vpc_attachment.rb', line 676

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:



686
687
688
689
690
 
# File 'network_manager/cfn_vpc_attachment.rb', line 686

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

#routing_policy_label ⇒ String?

Routing policy label.

Returns:

  • (String, nil) 


402
403
404
 
# File 'network_manager/cfn_vpc_attachment.rb', line 402

def routing_policy_label()
  jsii_get_property("routingPolicyLabel")
end

#routing_policy_label=(value) ⇒ Object 



406
407
408
409
 
# File 'network_manager/cfn_vpc_attachment.rb', line 406

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



695
696
697
 
# File 'network_manager/cfn_vpc_attachment.rb', line 695

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:



147
148
149
 
# File 'network_manager/cfn_vpc_attachment.rb', line 147

def stack()
  jsii_get_property("stack")
end

#subnet_arns ⇒ Array<String>

The subnet ARNs.

Returns:

  • (Array<String>) 


339
340
341
 
# File 'network_manager/cfn_vpc_attachment.rb', line 339

def subnet_arns()
  jsii_get_property("subnetArns")
end

#subnet_arns=(value) ⇒ Object 



343
344
345
346
 
# File 'network_manager/cfn_vpc_attachment.rb', line 343

def subnet_arns=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "subnetArns")
  jsii_set_property("subnetArns", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



313
314
315
 
# File 'network_manager/cfn_vpc_attachment.rb', line 313

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags associated with the VPC attachment.

Returns:



414
415
416
 
# File 'network_manager/cfn_vpc_attachment.rb', line 414

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



418
419
420
421
422
 
# File 'network_manager/cfn_vpc_attachment.rb', line 418

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



427
428
429
 
# File 'network_manager/cfn_vpc_attachment.rb', line 427

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


194
195
196
 
# File 'network_manager/cfn_vpc_attachment.rb', line 194

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


204
205
206
 
# File 'network_manager/cfn_vpc_attachment.rb', line 204

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


701
702
703
704
 
# File 'network_manager/cfn_vpc_attachment.rb', line 701

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

#vpc_arn ⇒ String

The ARN of the VPC attachment.

Returns:

  • (String) 


351
352
353
 
# File 'network_manager/cfn_vpc_attachment.rb', line 351

def vpc_arn()
  jsii_get_property("vpcArn")
end

#vpc_arn=(value) ⇒ Object 



355
356
357
358
 
# File 'network_manager/cfn_vpc_attachment.rb', line 355

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

#vpc_attachment_ref ⇒ AWSCDK::Interfaces::AWSNetworkmanager::VPCAttachmentReference

A reference to a VpcAttachment resource.

Returns:



320
321
322
 
# File 'network_manager/cfn_vpc_attachment.rb', line 320

def vpc_attachment_ref()
  jsii_get_property("vpcAttachmentRef")
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) 


440
441
442
443
444
445
 
# File 'network_manager/cfn_vpc_attachment.rb', line 440

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