Class: AWSCDK::VPCLattice::CfnServiceNetworkVPCAssociation

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSVpclattice::IServiceNetworkVPCAssociationRef
Defined in:
vpc_lattice/cfn_service_network_vpc_association.rb

Overview

Associates a VPC with a service network.

When you associate a VPC with the service network, it enables all the resources within that VPC to be clients and communicate with other services in the service network. For more information, see Manage VPC associations in the Amazon VPC Lattice User Guide .

You can't use this operation if there is a disassociation in progress. If the association fails, retry by deleting the association and recreating it.

As a result of this operation, the association gets created in the service network account and the VPC owner account.

If you add a security group to the service network and VPC association, the association must continue to always have at least one security group. You can add or edit security groups at any time. However, to remove all security groups, you must first delete the association and recreate it without security groups.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::VpcLattice::ServiceNetworkVpcAssociation.

Parameters:



26
27
28
29
30
31
32
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 26

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

Class Method Details

.arn_for_service_network_vpc_association(resource) ⇒ String

Parameters:

Returns:

  • (String) 


92
93
94
95
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 92

def self.arn_for_service_network_vpc_association(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c192cGNsYXR0aWNlLklTZXJ2aWNlTmV0d29ya1ZwY0Fzc29jaWF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_vpclattice.CfnServiceNetworkVpcAssociation", "arnForServiceNetworkVpcAssociation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


199
200
201
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 199

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

.is_cfn_service_network_vpc_association(x) ⇒ Boolean

Checks whether the given object is a CfnServiceNetworkVpcAssociation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


101
102
103
104
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 101

def self.is_cfn_service_network_vpc_association(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_vpclattice.CfnServiceNetworkVpcAssociation", "isCfnServiceNetworkVpcAssociation", [x])
end

.jsii_overridable_methods ⇒ Object 



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
88
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 34

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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_service_network_arn => { kind: :property, name: "attrServiceNetworkArn", is_optional: false },
    :attr_service_network_id => { kind: :property, name: "attrServiceNetworkId", is_optional: false },
    :attr_service_network_name => { kind: :property, name: "attrServiceNetworkName", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_vpc_id => { kind: :property, name: "attrVpcId", is_optional: false },
    :service_network_vpc_association_ref => { kind: :property, name: "serviceNetworkVpcAssociationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :dns_options => { kind: :property, name: "dnsOptions", is_optional: true },
    :private_dns_enabled => { kind: :property, name: "privateDnsEnabled", is_optional: true },
    :security_group_ids => { kind: :property, name: "securityGroupIds", is_optional: true },
    :service_network_identifier => { kind: :property, name: "serviceNetworkIdentifier", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :vpc_identifier => { kind: :property, name: "vpcIdentifier", 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.



383
384
385
386
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 383

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:



395
396
397
398
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 395

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:



405
406
407
408
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 405

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:



416
417
418
419
420
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 416

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.


473
474
475
476
477
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 473

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.



483
484
485
486
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 483

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.



495
496
497
498
499
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 495

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:



508
509
510
511
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 508

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:



530
531
532
533
534
535
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 530

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

The Amazon Resource Name (ARN) of the association between the service network and the VPC.

Returns:

  • (String) 


206
207
208
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 206

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_created_at ⇒ String

The date and time that the association was created, specified in ISO-8601 format.

Returns:

  • (String) 


213
214
215
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 213

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_id ⇒ String

The ID of the specified association between the service network and the VPC.

Returns:

  • (String) 


220
221
222
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 220

def attr_id()
  jsii_get_property("attrId")
end

#attr_service_network_arn ⇒ String

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

Returns:

  • (String) 


227
228
229
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 227

def attr_service_network_arn()
  jsii_get_property("attrServiceNetworkArn")
end

#attr_service_network_id ⇒ String

The ID of the service network.

Returns:

  • (String) 


234
235
236
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 234

def attr_service_network_id()
  jsii_get_property("attrServiceNetworkId")
end

#attr_service_network_name ⇒ String

The name of the service network.

Returns:

  • (String) 


241
242
243
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 241

def attr_service_network_name()
  jsii_get_property("attrServiceNetworkName")
end

#attr_status ⇒ String

The status of the association.

Returns:

  • (String) 


248
249
250
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 248

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_vpc_id ⇒ String

The ID of the VPC.

Returns:

  • (String) 


255
256
257
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 255

def attr_vpc_id()
  jsii_get_property("attrVpcId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



152
153
154
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 152

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


157
158
159
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 157

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


539
540
541
542
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 539

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


162
163
164
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 162

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


169
170
171
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 169

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


114
115
116
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 114

def creation_stack()
  jsii_get_property("creationStack")
end

#dns_options ⇒ AWSCDK::IResolvable, ...

The DNS options for the service network VPC association.

Returns:



276
277
278
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 276

def dns_options()
  jsii_get_property("dnsOptions")
end

#dns_options=(value) ⇒ Object 



280
281
282
283
284
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 280

def dns_options=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::VPCLattice::CfnServiceNetworkVPCAssociation::DNSOptionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192cGNsYXR0aWNlLkNmblNlcnZpY2VOZXR3b3JrVnBjQXNzb2NpYXRpb24uRG5zT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "dnsOptions") unless value.nil?
  jsii_set_property("dnsOptions", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



174
175
176
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 174

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:



552
553
554
555
556
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 552

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:



563
564
565
566
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 563

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:



633
634
635
636
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 633

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) 


126
127
128
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 126

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


109
110
111
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 109

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:



574
575
576
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 574

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:



581
582
583
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 581

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

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



374
375
376
377
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 374

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

#private_dns_enabled ⇒ Boolean, ...

Indicates if private DNS is enabled for the service network VPC association.

Returns:



289
290
291
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 289

def private_dns_enabled()
  jsii_get_property("privateDnsEnabled")
end

#private_dns_enabled=(value) ⇒ Object 



293
294
295
296
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 293

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


145
146
147
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 145

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:



592
593
594
595
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 592

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


599
600
601
602
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 599

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:



609
610
611
612
613
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 609

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#security_group_ids ⇒ Array<String>?

The IDs of the security groups.

Returns:

  • (Array<String>, nil) 


301
302
303
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 301

def security_group_ids()
  jsii_get_property("securityGroupIds")
end

#security_group_ids=(value) ⇒ Object 



305
306
307
308
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 305

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

#service_network_identifier ⇒ String?

The ID or ARN of the service network.

Returns:

  • (String, nil) 


313
314
315
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 313

def service_network_identifier()
  jsii_get_property("serviceNetworkIdentifier")
end

#service_network_identifier=(value) ⇒ Object 



317
318
319
320
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 317

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

#service_network_vpc_association_ref ⇒ AWSCDK::Interfaces::AWSVpclattice::ServiceNetworkVPCAssociationReference

A reference to a ServiceNetworkVpcAssociation resource.

Returns:



262
263
264
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 262

def service_network_vpc_association_ref()
  jsii_get_property("serviceNetworkVpcAssociationRef")
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.



618
619
620
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 618

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:



135
136
137
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 135

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



269
270
271
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 269

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the association.

Returns:



325
326
327
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 325

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



329
330
331
332
333
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 329

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



350
351
352
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 350

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


182
183
184
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 182

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


192
193
194
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 192

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


624
625
626
627
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 624

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

#vpc_identifier ⇒ String?

The ID of the VPC.

Returns:

  • (String, nil) 


338
339
340
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 338

def vpc_identifier()
  jsii_get_property("vpcIdentifier")
end

#vpc_identifier=(value) ⇒ Object 



342
343
344
345
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 342

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


363
364
365
366
367
368
 
# File 'vpc_lattice/cfn_service_network_vpc_association.rb', line 363

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