Class: AWSCDK::VPCLattice::CfnServiceNetworkServiceAssociation

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

Overview

Associates the specified service with the specified service network.

For more information, see Manage service associations in the Amazon VPC Lattice User Guide .

You can't use this operation if the service and service network are already associated or if there is a disassociation or deletion in progress. If the association fails, you can retry the operation by deleting the association and recreating it.

You cannot associate a service and service network that are shared with a caller. The caller must own either the service or the service network.

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::VpcLattice::ServiceNetworkServiceAssociation.

Parameters:



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

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

Class Method Details

.arn_for_service_network_service_association(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 94

def self.arn_for_service_network_service_association(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c192cGNsYXR0aWNlLklTZXJ2aWNlTmV0d29ya1NlcnZpY2VBc3NvY2lhdGlvblJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_vpclattice.CfnServiceNetworkServiceAssociation", "arnForServiceNetworkServiceAssociation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 201

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

.is_cfn_service_network_service_association(x) ⇒ Boolean

Checks whether the given object is a CfnServiceNetworkServiceAssociation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 103

def self.is_cfn_service_network_service_association(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_vpclattice.CfnServiceNetworkServiceAssociation", "isCfnServiceNetworkServiceAssociation", [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
89
90
 
# File 'vpc_lattice/cfn_service_network_service_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_dns_entry_domain_name => { kind: :property, name: "attrDnsEntryDomainName", is_optional: false },
    :attr_dns_entry_hosted_zone_id => { kind: :property, name: "attrDnsEntryHostedZoneId", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_service_arn => { kind: :property, name: "attrServiceArn", is_optional: false },
    :attr_service_id => { kind: :property, name: "attrServiceId", is_optional: false },
    :attr_service_name => { kind: :property, name: "attrServiceName", 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 },
    :service_network_service_association_ref => { kind: :property, name: "serviceNetworkServiceAssociationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :dns_entry => { kind: :property, name: "dnsEntry", is_optional: true },
    :service_identifier => { kind: :property, name: "serviceIdentifier", is_optional: true },
    :service_network_identifier => { kind: :property, name: "serviceNetworkIdentifier", 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.



389
390
391
392
 
# File 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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_arn ⇒ String

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

Returns:

  • (String) 


208
209
210
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 208

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) 


215
216
217
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 215

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_dns_entry_domain_name ⇒ String

The domain name of the service.

Returns:

  • (String) 


222
223
224
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 222

def attr_dns_entry_domain_name()
  jsii_get_property("attrDnsEntryDomainName")
end

#attr_dns_entry_hosted_zone_id ⇒ String

The ID of the hosted zone.

Returns:

  • (String) 


229
230
231
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 229

def attr_dns_entry_hosted_zone_id()
  jsii_get_property("attrDnsEntryHostedZoneId")
end

#attr_id ⇒ String

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

Returns:

  • (String) 


236
237
238
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 236

def attr_id()
  jsii_get_property("attrId")
end

#attr_service_arn ⇒ String

The Amazon Resource Name (ARN) of the service.

Returns:

  • (String) 


243
244
245
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 243

def attr_service_arn()
  jsii_get_property("attrServiceArn")
end

#attr_service_id ⇒ String

The ID of the service.

Returns:

  • (String) 


250
251
252
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 250

def attr_service_id()
  jsii_get_property("attrServiceId")
end

#attr_service_name ⇒ String

The name of the service.

Returns:

  • (String) 


257
258
259
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 257

def attr_service_name()
  jsii_get_property("attrServiceName")
end

#attr_service_network_arn ⇒ String

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

Returns:

  • (String) 


264
265
266
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 264

def attr_service_network_arn()
  jsii_get_property("attrServiceNetworkArn")
end

#attr_service_network_id ⇒ String

The ID of the service network.

Returns:

  • (String) 


271
272
273
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 271

def attr_service_network_id()
  jsii_get_property("attrServiceNetworkId")
end

#attr_service_network_name ⇒ String

The name of the service network.

Returns:

  • (String) 


278
279
280
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 278

def attr_service_network_name()
  jsii_get_property("attrServiceNetworkName")
end

#attr_status ⇒ String

The status of the association between the service network and the service.

Returns:

  • (String) 


285
286
287
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 285

def attr_status()
  jsii_get_property("attrStatus")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



154
155
156
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 159

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 'vpc_lattice/cfn_service_network_service_association.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}) 


164
165
166
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#dns_entry ⇒ AWSCDK::IResolvable, ...

The DNS information of the service.

Returns:



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

def dns_entry()
  jsii_get_property("dnsEntry")
end

#dns_entry=(value) ⇒ Object 



310
311
312
313
314
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 310

def dns_entry=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::VPCLattice::CfnServiceNetworkServiceAssociation::DNSEntryProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192cGNsYXR0aWNlLkNmblNlcnZpY2VOZXR3b3JrU2VydmljZUFzc29jaWF0aW9uLkRuc0VudHJ5UHJvcGVydHkifV19fQ==")), "dnsEntry") unless value.nil?
  jsii_set_property("dnsEntry", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 176

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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.rb', line 639

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) 


128
129
130
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 111

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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.rb', line 587

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.



380
381
382
383
 
# File 'vpc_lattice/cfn_service_network_service_association.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

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


147
148
149
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 147

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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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 'vpc_lattice/cfn_service_network_service_association.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

#service_identifier ⇒ String?

The ID or ARN of the service.

Returns:

  • (String, nil) 


319
320
321
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 319

def service_identifier()
  jsii_get_property("serviceIdentifier")
end

#service_identifier=(value) ⇒ Object 



323
324
325
326
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 323

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

#service_network_identifier ⇒ String?

The ID or ARN of the service network.

Returns:

  • (String, nil) 


331
332
333
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 331

def service_network_identifier()
  jsii_get_property("serviceNetworkIdentifier")
end

#service_network_identifier=(value) ⇒ Object 



335
336
337
338
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 335

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_service_association_ref ⇒ AWSCDK::Interfaces::AWSVpclattice::ServiceNetworkServiceAssociationReference

A reference to a ServiceNetworkServiceAssociation resource.

Returns:



292
293
294
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 292

def service_network_service_association_ref()
  jsii_get_property("serviceNetworkServiceAssociationRef")
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 'vpc_lattice/cfn_service_network_service_association.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:



137
138
139
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 137

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



299
300
301
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 299

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The tags for the association.

Returns:



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

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



347
348
349
350
351
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 347

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



356
357
358
 
# File 'vpc_lattice/cfn_service_network_service_association.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}) 


184
185
186
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 184

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


194
195
196
 
# File 'vpc_lattice/cfn_service_network_service_association.rb', line 194

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 'vpc_lattice/cfn_service_network_service_association.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

#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 'vpc_lattice/cfn_service_network_service_association.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