Class: AWSCDK::EC2::CfnIPAMResourceDiscoveryAssociation

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEC2::IIPAMResourceDiscoveryAssociationRef
Defined in:
ec2/cfn_ipam_resource_discovery_association.rb

Overview

An IPAM resource discovery association.

An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnIPAMResourceDiscoveryAssociation

Create a new AWS::EC2::IPAMResourceDiscoveryAssociation.

Parameters:



20
21
22
23
24
25
26
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 20

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

Class Method Details

.arn_for_ipam_resource_discovery_association(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_ipam_resource_discovery_association(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUlQQU1SZXNvdXJjZURpc2NvdmVyeUFzc29jaWF0aW9uUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscoveryAssociation", "arnForIPAMResourceDiscoveryAssociation", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


216
217
218
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 216

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

.from_ipam_resource_discovery_association_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMResourceDiscoveryAssociationRef

Creates a new IIPAMResourceDiscoveryAssociationRef from an ARN.

Parameters:

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

Returns:



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

def self.from_ipam_resource_discovery_association_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscoveryAssociation", "fromIPAMResourceDiscoveryAssociationArn", [scope, id, arn])
end

.from_ipam_resource_discovery_association_id(scope, id, ipam_resource_discovery_association_id) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMResourceDiscoveryAssociationRef

Creates a new IIPAMResourceDiscoveryAssociationRef from a ipamResourceDiscoveryAssociationId.

Parameters:

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

Returns:



107
108
109
110
111
112
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 107

def self.from_ipam_resource_discovery_association_id(scope, id, ipam_resource_discovery_association_id)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(ipam_resource_discovery_association_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipamResourceDiscoveryAssociationId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscoveryAssociation", "fromIpamResourceDiscoveryAssociationId", [scope, id, ipam_resource_discovery_association_id])
end

.is_cfn_ipam_resource_discovery_association(x) ⇒ Boolean

Checks whether the given object is a CfnIPAMResourceDiscoveryAssociation.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_ipam_resource_discovery_association(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscoveryAssociation", "isCfnIPAMResourceDiscoveryAssociation", [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
 
# File 'ec2/cfn_ipam_resource_discovery_association.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_ipam_arn => { kind: :property, name: "attrIpamArn", is_optional: false },
    :attr_ipam_region => { kind: :property, name: "attrIpamRegion", is_optional: false },
    :attr_ipam_resource_discovery_association_arn => { kind: :property, name: "attrIpamResourceDiscoveryAssociationArn", is_optional: false },
    :attr_ipam_resource_discovery_association_id => { kind: :property, name: "attrIpamResourceDiscoveryAssociationId", is_optional: false },
    :attr_is_default => { kind: :property, name: "attrIsDefault", is_optional: false },
    :attr_owner_id => { kind: :property, name: "attrOwnerId", is_optional: false },
    :attr_resource_discovery_status => { kind: :property, name: "attrResourceDiscoveryStatus", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :ipam_resource_discovery_association_ref => { kind: :property, name: "ipamResourceDiscoveryAssociationRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :ipam_id => { kind: :property, name: "ipamId", is_optional: false },
    :ipam_resource_discovery_id => { kind: :property, name: "ipamResourceDiscoveryId", is_optional: false },
    :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.



378
379
380
381
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 378

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:



390
391
392
393
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 390

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:



400
401
402
403
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 400

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:



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

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.


468
469
470
471
472
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 468

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.



478
479
480
481
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 478

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.



490
491
492
493
494
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 490

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:



503
504
505
506
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 503

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:



525
526
527
528
529
530
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 525

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

The IPAM ARN.

Returns:

  • (String) 


223
224
225
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 223

def attr_ipam_arn()
  jsii_get_property("attrIpamArn")
end

#attr_ipam_region ⇒ String

The IPAM home Region.

Returns:

  • (String) 


230
231
232
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 230

def attr_ipam_region()
  jsii_get_property("attrIpamRegion")
end

#attr_ipam_resource_discovery_association_arn ⇒ String

The resource discovery association ARN.

Returns:

  • (String) 


237
238
239
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 237

def attr_ipam_resource_discovery_association_arn()
  jsii_get_property("attrIpamResourceDiscoveryAssociationArn")
end

#attr_ipam_resource_discovery_association_id ⇒ String

The resource discovery association ID.

Returns:

  • (String) 


244
245
246
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 244

def attr_ipam_resource_discovery_association_id()
  jsii_get_property("attrIpamResourceDiscoveryAssociationId")
end

#attr_is_default ⇒ AWSCDK::IResolvable

Defines if the resource discovery is the default.

When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.

Returns:



253
254
255
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 253

def attr_is_default()
  jsii_get_property("attrIsDefault")
end

#attr_owner_id ⇒ String

The owner ID.

Returns:

  • (String) 


260
261
262
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 260

def attr_owner_id()
  jsii_get_property("attrOwnerId")
end

#attr_resource_discovery_status ⇒ String

The resource discovery status.

  • active - Connection or permissions required to read the results of the resource discovery are intact.
  • not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.

Returns:

  • (String) 


270
271
272
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 270

def attr_resource_discovery_status()
  jsii_get_property("attrResourceDiscoveryStatus")
end

#attr_state ⇒ String

The lifecycle state of the association when you associate or disassociate a resource discovery.

  • associate-in-progress - Resource discovery is being associated.
  • associate-complete - Resource discovery association is complete.
  • associate-failed - Resource discovery association has failed.
  • disassociate-in-progress - Resource discovery is being disassociated.
  • disassociate-complete - Resource discovery disassociation is complete.
  • disassociate-failed - Resource discovery disassociation has failed.
  • isolate-in-progress - AWS account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
  • isolate-complete - Resource discovery isolation is complete..
  • restore-in-progress - Resource discovery is being restored.

Returns:

  • (String) 


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

def attr_state()
  jsii_get_property("attrState")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



169
170
171
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 169

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


174
175
176
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 174

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


534
535
536
537
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 534

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


179
180
181
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 179

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


131
132
133
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 131

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



191
192
193
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 191

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:



547
548
549
550
551
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 547

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:



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

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:



628
629
630
631
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 628

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

#ipam_id ⇒ String

The IPAM ID.

Returns:

  • (String) 


308
309
310
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 308

def ipam_id()
  jsii_get_property("ipamId")
end

#ipam_id=(value) ⇒ Object 



312
313
314
315
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 312

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

#ipam_resource_discovery_association_ref ⇒ AWSCDK::Interfaces::AWSEC2::IPAMResourceDiscoveryAssociationReference

A reference to a IPAMResourceDiscoveryAssociation resource.

Returns:



294
295
296
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 294

def ipam_resource_discovery_association_ref()
  jsii_get_property("ipamResourceDiscoveryAssociationRef")
end

#ipam_resource_discovery_id ⇒ String

The resource discovery ID.

Returns:

  • (String) 


320
321
322
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 320

def ipam_resource_discovery_id()
  jsii_get_property("ipamResourceDiscoveryId")
end

#ipam_resource_discovery_id=(value) ⇒ Object 



324
325
326
327
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 324

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


143
144
145
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 143

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


126
127
128
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 126

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:



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

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:



576
577
578
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 576

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.



369
370
371
372
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 369

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) 


162
163
164
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 162

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:



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

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


594
595
596
597
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 594

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:



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

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

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



613
614
615
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 613

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:



152
153
154
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 152

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



301
302
303
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 301

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

A tag is a label that you assign to an AWS resource.

Returns:



332
333
334
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 332

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



336
337
338
339
340
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 336

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



345
346
347
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 345

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


199
200
201
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 199

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


209
210
211
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 209

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


619
620
621
622
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 619

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) 


358
359
360
361
362
363
 
# File 'ec2/cfn_ipam_resource_discovery_association.rb', line 358

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