Class: AWSCDK::EC2::CfnIPAM

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

Overview

IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization.

For more information, see What is IPAM? in the Amazon VPC IPAM User Guide .

There are AWS Identity and Access Management (IAM) permissions required to fully manage an IPAM in CloudFormation. For more information, see Example policy in the Amazon VPC IPAM User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new AWS::EC2::IPAM.

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::CfnIPAMProps, nil) (defaults to: nil) —

    Resource properties.



22
23
24
25
26
27
28
 
# File 'ec2/cfn_ipam.rb', line 22

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

Class Method Details

.arn_for_ipam(resource) ⇒ String

Parameters:

Returns:

  • (String) 


89
90
91
92
 
# File 'ec2/cfn_ipam.rb', line 89

def self.arn_for_ipam(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUlQQU1SZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAM", "arnForIPAM", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


222
223
224
 
# File 'ec2/cfn_ipam.rb', line 222

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

.from_ipam_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMRef

Creates a new IIPAMRef from an ARN.

Parameters:

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

Returns:



100
101
102
103
104
105
 
# File 'ec2/cfn_ipam.rb', line 100

def self.from_ipam_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.CfnIPAM", "fromIPAMArn", [scope, id, arn])
end

.from_ipam_id(scope, id, ipam_id) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMRef

Creates a new IIPAMRef from a ipamId.

Parameters:

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

Returns:



113
114
115
116
117
118
 
# File 'ec2/cfn_ipam.rb', line 113

def self.from_ipam_id(scope, id, ipam_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_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipamId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAM", "fromIpamId", [scope, id, ipam_id])
end

.is_cfn_ipam(x) ⇒ Boolean

Checks whether the given object is a CfnIPAM.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


124
125
126
127
 
# File 'ec2/cfn_ipam.rb', line 124

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

.jsii_overridable_methods ⇒ Object 



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
84
85
 
# File 'ec2/cfn_ipam.rb', line 30

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_default_resource_discovery_association_id => { kind: :property, name: "attrDefaultResourceDiscoveryAssociationId", is_optional: false },
    :attr_default_resource_discovery_id => { kind: :property, name: "attrDefaultResourceDiscoveryId", is_optional: false },
    :attr_ipam_id => { kind: :property, name: "attrIpamId", is_optional: false },
    :attr_private_default_scope_id => { kind: :property, name: "attrPrivateDefaultScopeId", is_optional: false },
    :attr_public_default_scope_id => { kind: :property, name: "attrPublicDefaultScopeId", is_optional: false },
    :attr_resource_discovery_association_count => { kind: :property, name: "attrResourceDiscoveryAssociationCount", is_optional: false },
    :attr_scope_count => { kind: :property, name: "attrScopeCount", is_optional: false },
    :ipam_ref => { kind: :property, name: "ipamRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :default_resource_discovery_organizational_unit_exclusions => { kind: :property, name: "defaultResourceDiscoveryOrganizationalUnitExclusions", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_private_gua => { kind: :property, name: "enablePrivateGua", is_optional: true },
    :metered_account => { kind: :property, name: "meteredAccount", is_optional: true },
    :operating_regions => { kind: :property, name: "operatingRegions", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :tier => { kind: :property, name: "tier", 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.



417
418
419
420
 
# File 'ec2/cfn_ipam.rb', line 417

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:



429
430
431
432
 
# File 'ec2/cfn_ipam.rb', line 429

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:



439
440
441
442
 
# File 'ec2/cfn_ipam.rb', line 439

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:



450
451
452
453
454
 
# File 'ec2/cfn_ipam.rb', line 450

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.


507
508
509
510
511
 
# File 'ec2/cfn_ipam.rb', line 507

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.



517
518
519
520
 
# File 'ec2/cfn_ipam.rb', line 517

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.



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

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:



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

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:



564
565
566
567
568
569
 
# File 'ec2/cfn_ipam.rb', line 564

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 ARN of the IPAM.

Returns:

  • (String) 


229
230
231
 
# File 'ec2/cfn_ipam.rb', line 229

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_default_resource_discovery_association_id ⇒ String

The ID of the default resource discovery association.

Returns:

  • (String) 


236
237
238
 
# File 'ec2/cfn_ipam.rb', line 236

def attr_default_resource_discovery_association_id()
  jsii_get_property("attrDefaultResourceDiscoveryAssociationId")
end

#attr_default_resource_discovery_id ⇒ String

The ID of the default resource discovery.

Returns:

  • (String) 


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

def attr_default_resource_discovery_id()
  jsii_get_property("attrDefaultResourceDiscoveryId")
end

#attr_ipam_id ⇒ String

The ID of the IPAM.

Returns:

  • (String) 


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

def attr_ipam_id()
  jsii_get_property("attrIpamId")
end

#attr_private_default_scope_id ⇒ String

The ID of the default private scope.

Returns:

  • (String) 


257
258
259
 
# File 'ec2/cfn_ipam.rb', line 257

def attr_private_default_scope_id()
  jsii_get_property("attrPrivateDefaultScopeId")
end

#attr_public_default_scope_id ⇒ String

The ID of the default public scope.

Returns:

  • (String) 


264
265
266
 
# File 'ec2/cfn_ipam.rb', line 264

def attr_public_default_scope_id()
  jsii_get_property("attrPublicDefaultScopeId")
end

#attr_resource_discovery_association_count ⇒ Numeric

The number of resource discovery associations.

Returns:

  • (Numeric) 


271
272
273
 
# File 'ec2/cfn_ipam.rb', line 271

def attr_resource_discovery_association_count()
  jsii_get_property("attrResourceDiscoveryAssociationCount")
end

#attr_scope_count ⇒ Numeric

The number of scopes.

Returns:

  • (Numeric) 


278
279
280
 
# File 'ec2/cfn_ipam.rb', line 278

def attr_scope_count()
  jsii_get_property("attrScopeCount")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



175
176
177
 
# File 'ec2/cfn_ipam.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


180
181
182
 
# File 'ec2/cfn_ipam.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


573
574
575
576
 
# File 'ec2/cfn_ipam.rb', line 573

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


185
186
187
 
# File 'ec2/cfn_ipam.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


192
193
194
 
# File 'ec2/cfn_ipam.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


137
138
139
 
# File 'ec2/cfn_ipam.rb', line 137

def creation_stack()
  jsii_get_property("creationStack")
end

#default_resource_discovery_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:



299
300
301
 
# File 'ec2/cfn_ipam.rb', line 299

def default_resource_discovery_organizational_unit_exclusions()
  jsii_get_property("defaultResourceDiscoveryOrganizationalUnitExclusions")
end

#default_resource_discovery_organizational_unit_exclusions=(value) ⇒ Object 



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

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

#description ⇒ String?

The description for the IPAM.

Returns:

  • (String, nil) 


311
312
313
 
# File 'ec2/cfn_ipam.rb', line 311

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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

#enable_private_gua ⇒ Boolean, ...

Enable this option to use your own GUA ranges as private IPv6 addresses.

Returns:



323
324
325
 
# File 'ec2/cfn_ipam.rb', line 323

def enable_private_gua()
  jsii_get_property("enablePrivateGua")
end

#enable_private_gua=(value) ⇒ Object 



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

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



197
198
199
 
# File 'ec2/cfn_ipam.rb', line 197

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:



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

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:



597
598
599
600
 
# File 'ec2/cfn_ipam.rb', line 597

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:



667
668
669
670
 
# File 'ec2/cfn_ipam.rb', line 667

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

#ipam_ref ⇒ AWSCDK::Interfaces::AWSEC2::IPAMReference

A reference to a IPAM resource.

Returns:



285
286
287
 
# File 'ec2/cfn_ipam.rb', line 285

def ipam_ref()
  jsii_get_property("ipamRef")
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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#metered_account ⇒ String?

A metered account is an AWS account that is charged for active IP addresses managed in IPAM.

Returns:

  • (String, nil) 


335
336
337
 
# File 'ec2/cfn_ipam.rb', line 335

def ()
  jsii_get_property("meteredAccount")
end

#metered_account=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


132
133
134
 
# File 'ec2/cfn_ipam.rb', line 132

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:



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

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:



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

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

#operating_regions ⇒ AWSCDK::IResolvable, ...

The operating Regions for an IPAM.

Returns:



347
348
349
 
# File 'ec2/cfn_ipam.rb', line 347

def operating_regions()
  jsii_get_property("operatingRegions")
end

#operating_regions=(value) ⇒ Object 



351
352
353
354
 
# File 'ec2/cfn_ipam.rb', line 351

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



408
409
410
411
 
# File 'ec2/cfn_ipam.rb', line 408

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) 


168
169
170
 
# File 'ec2/cfn_ipam.rb', line 168

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:



626
627
628
629
 
# File 'ec2/cfn_ipam.rb', line 626

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


633
634
635
636
 
# File 'ec2/cfn_ipam.rb', line 633

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:



643
644
645
646
647
 
# File 'ec2/cfn_ipam.rb', line 643

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.



652
653
654
 
# File 'ec2/cfn_ipam.rb', line 652

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:



158
159
160
 
# File 'ec2/cfn_ipam.rb', line 158

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



292
293
294
 
# File 'ec2/cfn_ipam.rb', line 292

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The key/value combination of a tag assigned to the resource.

Returns:



359
360
361
 
# File 'ec2/cfn_ipam.rb', line 359

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



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

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

#tier ⇒ String?

IPAM is offered in a Free Tier and an Advanced Tier.

Returns:

  • (String, nil) 


372
373
374
 
# File 'ec2/cfn_ipam.rb', line 372

def tier()
  jsii_get_property("tier")
end

#tier=(value) ⇒ Object 



376
377
378
379
 
# File 'ec2/cfn_ipam.rb', line 376

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



384
385
386
 
# File 'ec2/cfn_ipam.rb', line 384

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


205
206
207
 
# File 'ec2/cfn_ipam.rb', line 205

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


215
216
217
 
# File 'ec2/cfn_ipam.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


658
659
660
661
 
# File 'ec2/cfn_ipam.rb', line 658

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) 


397
398
399
400
401
402
 
# File 'ec2/cfn_ipam.rb', line 397

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