Class: AWSCDK::EC2::CfnIPAMResourceDiscovery

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

Overview

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::EC2::IPAMResourceDiscovery.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::EC2::CfnIPAMResourceDiscoveryProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 18

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

Class Method Details

.arn_for_ipam_resource_discovery(resource) ⇒ String

Parameters:

Returns:

  • (String) 


80
81
82
83
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 80

def self.arn_for_ipam_resource_discovery(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUlQQU1SZXNvdXJjZURpc2NvdmVyeVJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscovery", "arnForIPAMResourceDiscovery", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


213
214
215
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 213

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

.from_ipam_resource_discovery_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMResourceDiscoveryRef

Creates a new IIPAMResourceDiscoveryRef from an ARN.

Parameters:

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

Returns:



91
92
93
94
95
96
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 91

def self.from_ipam_resource_discovery_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.CfnIPAMResourceDiscovery", "fromIPAMResourceDiscoveryArn", [scope, id, arn])
end

.from_ipam_resource_discovery_id(scope, id, ipam_resource_discovery_id) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMResourceDiscoveryRef

Creates a new IIPAMResourceDiscoveryRef from a ipamResourceDiscoveryId.

Parameters:

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

Returns:



104
105
106
107
108
109
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 104

def self.from_ipam_resource_discovery_id(scope, id, ipam_resource_discovery_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_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipamResourceDiscoveryId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscovery", "fromIpamResourceDiscoveryId", [scope, id, ipam_resource_discovery_id])
end

.is_cfn_ipam_resource_discovery(x) ⇒ Boolean

Checks whether the given object is a CfnIPAMResourceDiscovery.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


115
116
117
118
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 115

def self.is_cfn_ipam_resource_discovery(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMResourceDiscovery", "isCfnIPAMResourceDiscovery", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_ipam_resource_discovery_arn => { kind: :property, name: "attrIpamResourceDiscoveryArn", is_optional: false },
    :attr_ipam_resource_discovery_id => { kind: :property, name: "attrIpamResourceDiscoveryId", is_optional: false },
    :attr_ipam_resource_discovery_region => { kind: :property, name: "attrIpamResourceDiscoveryRegion", is_optional: false },
    :attr_is_default => { kind: :property, name: "attrIsDefault", is_optional: false },
    :attr_owner_id => { kind: :property, name: "attrOwnerId", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :ipam_resource_discovery_ref => { kind: :property, name: "ipamResourceDiscoveryRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :operating_regions => { kind: :property, name: "operatingRegions", is_optional: true },
    :organizational_unit_exclusions => { kind: :property, name: "organizationalUnitExclusions", 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.



373
374
375
376
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 373

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:



385
386
387
388
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 385

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:



395
396
397
398
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 395

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:



406
407
408
409
410
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 406

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.


463
464
465
466
467
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 463

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.



473
474
475
476
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 473

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.



485
486
487
488
489
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 485

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:



498
499
500
501
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 498

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:



520
521
522
523
524
525
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 520

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

The resource discovery ARN.

Returns:

  • (String) 


220
221
222
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 220

def attr_ipam_resource_discovery_arn()
  jsii_get_property("attrIpamResourceDiscoveryArn")
end

#attr_ipam_resource_discovery_id ⇒ String

The resource discovery ID.

Returns:

  • (String) 


227
228
229
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 227

def attr_ipam_resource_discovery_id()
  jsii_get_property("attrIpamResourceDiscoveryId")
end

#attr_ipam_resource_discovery_region ⇒ String

The resource discovery Region.

Returns:

  • (String) 


234
235
236
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 234

def attr_ipam_resource_discovery_region()
  jsii_get_property("attrIpamResourceDiscoveryRegion")
end

#attr_is_default ⇒ AWSCDK::IResolvable

Defines if the resource discovery is the default.

The default resource discovery is the resource discovery automatically created when you create an IPAM.

Returns:



243
244
245
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 243

def attr_is_default()
  jsii_get_property("attrIsDefault")
end

#attr_owner_id ⇒ String

The owner ID.

Returns:

  • (String) 


250
251
252
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 250

def attr_owner_id()
  jsii_get_property("attrOwnerId")
end

#attr_state ⇒ String

The resource discovery's state.

  • create-in-progress - Resource discovery is being created.
  • create-complete - Resource discovery creation is complete.
  • create-failed - Resource discovery creation has failed.
  • modify-in-progress - Resource discovery is being modified.
  • modify-complete - Resource discovery modification is complete.
  • modify-failed - Resource discovery modification has failed.
  • delete-in-progress - Resource discovery is being deleted.
  • delete-complete - Resource discovery deletion is complete.
  • delete-failed - Resource discovery deletion has failed.
  • isolate-in-progress - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.
  • isolate-complete - Resource discovery isolation is complete.
  • restore-in-progress - AWS account that created the resource discovery and was isolated has been restored.

Returns:

  • (String) 


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

def attr_state()
  jsii_get_property("attrState")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



166
167
168
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 166

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


171
172
173
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 171

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


529
530
531
532
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 529

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


176
177
178
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 176

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


183
184
185
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 183

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


128
129
130
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 128

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The resource discovery description.

Returns:

  • (String, nil) 


291
292
293
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 291

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



295
296
297
298
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 295

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



188
189
190
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 188

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:



542
543
544
545
546
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 542

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:



553
554
555
556
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 553

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:



623
624
625
626
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 623

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

#ipam_resource_discovery_ref ⇒ AWSCDK::Interfaces::AWSEC2::IPAMResourceDiscoveryReference

A reference to a IPAMResourceDiscovery resource.

Returns:



277
278
279
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 277

def ipam_resource_discovery_ref()
  jsii_get_property("ipamResourceDiscoveryRef")
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) 


140
141
142
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 140

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


123
124
125
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 123

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:



564
565
566
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 564

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:



571
572
573
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 571

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

#operating_regions ⇒ AWSCDK::IResolvable, ...

The operating Regions for the resource discovery.

Returns:



303
304
305
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 303

def operating_regions()
  jsii_get_property("operatingRegions")
end

#operating_regions=(value) ⇒ Object 



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

def operating_regions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbklQQU1SZXNvdXJjZURpc2NvdmVyeS5JcGFtT3BlcmF0aW5nUmVnaW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "operatingRegions") unless value.nil?
  jsii_set_property("operatingRegions", value)
end

#organizational_unit_exclusions ⇒ AWSCDK::IResolvable, ...

If your IPAM is integrated with AWS Organizations, you can exclude an organizational unit (OU) from being managed by IPAM. When you exclude an OU, IPAM will not manage the IP addresses in accounts in that OU. For more information, see Exclude organizational units from IPAM in the Amazon Virtual Private Cloud IP Address Manager User Guide .

Returns:



315
316
317
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 315

def organizational_unit_exclusions()
  jsii_get_property("organizationalUnitExclusions")
end

#organizational_unit_exclusions=(value) ⇒ Object 



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

def organizational_unit_exclusions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLkNmbklQQU1SZXNvdXJjZURpc2NvdmVyeS5JcGFtUmVzb3VyY2VEaXNjb3ZlcnlPcmdhbml6YXRpb25hbFVuaXRFeGNsdXNpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "organizationalUnitExclusions") unless value.nil?
  jsii_set_property("organizationalUnitExclusions", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

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

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



364
365
366
367
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 364

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) 


159
160
161
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 159

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:



582
583
584
585
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 582

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


589
590
591
592
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 589

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:



599
600
601
602
603
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 599

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.



608
609
610
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 608

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:



149
150
151
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 149

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



284
285
286
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 284

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:



327
328
329
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 327

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



331
332
333
334
335
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 331

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



340
341
342
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 340

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


196
197
198
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 196

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


206
207
208
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 206

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


614
615
616
617
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 614

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) 


353
354
355
356
357
358
 
# File 'ec2/cfn_ipam_resource_discovery.rb', line 353

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