Class: AWSCDK::VPCLattice::CfnResourceConfiguration

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSVpclattice::IResourceConfigurationRef
Defined in:
vpc_lattice/cfn_resource_configuration.rb

Overview

Creates a resource configuration.

A resource configuration defines a specific resource. You can associate a resource configuration with a service network or a VPC endpoint.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnResourceConfiguration

Create a new AWS::VpcLattice::ResourceConfiguration.

Parameters:



20
21
22
23
24
25
26
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 20

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

Class Method Details

.arn_for_resource_configuration(resource) ⇒ String

Parameters:

Returns:

  • (String) 


87
88
89
90
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 87

def self.arn_for_resource_configuration(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c192cGNsYXR0aWNlLklSZXNvdXJjZUNvbmZpZ3VyYXRpb25SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_vpclattice.CfnResourceConfiguration", "arnForResourceConfiguration", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_resource_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnResourceConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


96
97
98
99
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 96

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

.jsii_overridable_methods ⇒ Object 



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
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 28

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_id => { kind: :property, name: "attrId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :resource_configuration_ref => { kind: :property, name: "resourceConfigurationRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :resource_configuration_type => { kind: :property, name: "resourceConfigurationType", is_optional: false },
    :allow_association_to_sharable_service_network => { kind: :property, name: "allowAssociationToSharableServiceNetwork", is_optional: true },
    :custom_domain_name => { kind: :property, name: "customDomainName", is_optional: true },
    :domain_verification_id => { kind: :property, name: "domainVerificationId", is_optional: true },
    :group_domain => { kind: :property, name: "groupDomain", is_optional: true },
    :port_ranges => { kind: :property, name: "portRanges", is_optional: true },
    :protocol_type => { kind: :property, name: "protocolType", is_optional: true },
    :resource_configuration_auth_type => { kind: :property, name: "resourceConfigurationAuthType", is_optional: true },
    :resource_configuration_definition => { kind: :property, name: "resourceConfigurationDefinition", is_optional: true },
    :resource_configuration_group_id => { kind: :property, name: "resourceConfigurationGroupId", is_optional: true },
    :resource_gateway_id => { kind: :property, name: "resourceGatewayId", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



422
423
424
425
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 422

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:



434
435
436
437
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 434

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:



444
445
446
447
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 444

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:



455
456
457
458
459
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 455

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.


512
513
514
515
516
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 512

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.



522
523
524
525
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 522

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.



534
535
536
537
538
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 534

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

#allow_association_to_sharable_service_network ⇒ Boolean, ...

Specifies whether the resource configuration can be associated with a sharable service network.

Returns:



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

def allow_association_to_sharable_service_network()
  jsii_get_property("allowAssociationToSharableServiceNetwork")
end

#allow_association_to_sharable_service_network=(value) ⇒ Object 



259
260
261
262
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 259

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



547
548
549
550
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 547

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:



569
570
571
572
573
574
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 569

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 resource configuration.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_id ⇒ String

The ID of the resource configuration.

Returns:

  • (String) 


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

def attr_id()
  jsii_get_property("attrId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



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

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



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

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


578
579
580
581
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 578

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#custom_domain_name ⇒ String?

The custom domain name.

Returns:

  • (String, nil) 


267
268
269
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 267

def custom_domain_name()
  jsii_get_property("customDomainName")
end

#custom_domain_name=(value) ⇒ Object 



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

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

#domain_verification_id ⇒ String?

The domain verification ID.

Returns:

  • (String, nil) 


279
280
281
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 279

def domain_verification_id()
  jsii_get_property("domainVerificationId")
end

#domain_verification_id=(value) ⇒ Object 



283
284
285
286
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 283

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

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:



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

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:



602
603
604
605
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 602

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#group_domain ⇒ String?

(GROUP) The group domain for a group resource configuration.

Returns:

  • (String, nil) 


291
292
293
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 291

def group_domain()
  jsii_get_property("groupDomain")
end

#group_domain=(value) ⇒ Object 



295
296
297
298
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 295

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



672
673
674
675
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 672

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) 


121
122
123
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 121

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name of the resource configuration.

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


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

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:



613
614
615
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 613

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:



620
621
622
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 620

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.



413
414
415
416
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 413

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

#port_ranges ⇒ Array<String>?

(SINGLE, GROUP, CHILD) The TCP port ranges that a consumer can use to access a resource configuration (for example: 1-65535).

Returns:

  • (Array<String>, nil) 


303
304
305
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 303

def port_ranges()
  jsii_get_property("portRanges")
end

#port_ranges=(value) ⇒ Object 



307
308
309
310
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 307

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

#protocol_type ⇒ String?

(SINGLE, GROUP) The protocol accepted by the resource configuration.

Returns:

  • (String, nil) 


315
316
317
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 315

def protocol_type()
  jsii_get_property("protocolType")
end

#protocol_type=(value) ⇒ Object 



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

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


140
141
142
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 140

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:



631
632
633
634
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 631

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


638
639
640
641
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 638

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:



648
649
650
651
652
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 648

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

#resource_configuration_auth_type ⇒ String?

The auth type for the resource configuration.

Returns:

  • (String, nil) 


327
328
329
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 327

def resource_configuration_auth_type()
  jsii_get_property("resourceConfigurationAuthType")
end

#resource_configuration_auth_type=(value) ⇒ Object 



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

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

#resource_configuration_definition ⇒ AWSCDK::IResolvable, ...

Identifies the resource configuration in one of the following ways:.

Returns:



339
340
341
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 339

def resource_configuration_definition()
  jsii_get_property("resourceConfigurationDefinition")
end

#resource_configuration_definition=(value) ⇒ Object 



343
344
345
346
347
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 343

def resource_configuration_definition=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::VPCLattice::CfnResourceConfiguration::ResourceConfigurationDefinitionProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c192cGNsYXR0aWNlLkNmblJlc291cmNlQ29uZmlndXJhdGlvbi5SZXNvdXJjZUNvbmZpZ3VyYXRpb25EZWZpbml0aW9uUHJvcGVydHkifV19fQ==")), "resourceConfigurationDefinition") unless value.nil?
  jsii_set_property("resourceConfigurationDefinition", value)
end

#resource_configuration_group_id ⇒ String?

The ID of the group resource configuration.

Returns:

  • (String, nil) 


352
353
354
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 352

def resource_configuration_group_id()
  jsii_get_property("resourceConfigurationGroupId")
end

#resource_configuration_group_id=(value) ⇒ Object 



356
357
358
359
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 356

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

#resource_configuration_ref ⇒ AWSCDK::Interfaces::AWSVpclattice::ResourceConfigurationReference

A reference to a ResourceConfiguration resource.

Returns:



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

def resource_configuration_ref()
  jsii_get_property("resourceConfigurationRef")
end

#resource_configuration_type ⇒ String

The type of resource configuration.

A resource configuration can be one of the following types:.

Returns:

  • (String) 


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

def resource_configuration_type()
  jsii_get_property("resourceConfigurationType")
end

#resource_configuration_type=(value) ⇒ Object 



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

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

#resource_gateway_id ⇒ String?

The ID of the resource gateway.

Returns:

  • (String, nil) 


364
365
366
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 364

def resource_gateway_id()
  jsii_get_property("resourceGatewayId")
end

#resource_gateway_id=(value) ⇒ Object 



368
369
370
371
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 368

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



657
658
659
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 657

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:



130
131
132
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 130

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

The tags for the resource configuration.

Returns:



376
377
378
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 376

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



380
381
382
383
384
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 380

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



389
390
391
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 389

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


177
178
179
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 177

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


187
188
189
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 187

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


663
664
665
666
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 663

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) 


402
403
404
405
406
407
 
# File 'vpc_lattice/cfn_resource_configuration.rb', line 402

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