Class: AWSCDK::EC2::CfnIPAMPool

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

Overview

In IPAM, a pool is a collection of contiguous IP addresses CIDRs.

Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnIPAMPool

Create a new AWS::EC2::IPAMPool.

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::CfnIPAMPoolProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_ipam_pool(resource) ⇒ String

Parameters:

Returns:

  • (String) 


96
97
98
99
 
# File 'ec2/cfn_ipam_pool.rb', line 96

def self.arn_for_ipam_pool(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lYzIuSUlQQU1Qb29sUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMPool", "arnForIPAMPool", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_ipam_pool_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMPoolRef

Creates a new IIPAMPoolRef from an ARN.

Parameters:

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

Returns:



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

def self.from_ipam_pool_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.CfnIPAMPool", "fromIPAMPoolArn", [scope, id, arn])
end

.from_ipam_pool_id(scope, id, ipam_pool_id) ⇒ AWSCDK::Interfaces::AWSEC2::IIPAMPoolRef

Creates a new IIPAMPoolRef from a ipamPoolId.

Parameters:

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

Returns:



120
121
122
123
124
125
 
# File 'ec2/cfn_ipam_pool.rb', line 120

def self.from_ipam_pool_id(scope, id, ipam_pool_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_pool_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "ipamPoolId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_ec2.CfnIPAMPool", "fromIpamPoolId", [scope, id, ipam_pool_id])
end

.is_cfn_ipam_pool(x) ⇒ Boolean

Checks whether the given object is a CfnIPAMPool.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'ec2/cfn_ipam_pool.rb', line 28

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_ipam_arn => { kind: :property, name: "attrIpamArn", is_optional: false },
    :attr_ipam_pool_id => { kind: :property, name: "attrIpamPoolId", is_optional: false },
    :attr_ipam_scope_arn => { kind: :property, name: "attrIpamScopeArn", is_optional: false },
    :attr_ipam_scope_type => { kind: :property, name: "attrIpamScopeType", is_optional: false },
    :attr_pool_depth => { kind: :property, name: "attrPoolDepth", is_optional: false },
    :attr_state => { kind: :property, name: "attrState", is_optional: false },
    :attr_state_message => { kind: :property, name: "attrStateMessage", is_optional: false },
    :ipam_pool_ref => { kind: :property, name: "ipamPoolRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :address_family => { kind: :property, name: "addressFamily", is_optional: false },
    :ipam_scope_id => { kind: :property, name: "ipamScopeId", is_optional: false },
    :allocation_default_netmask_length => { kind: :property, name: "allocationDefaultNetmaskLength", is_optional: true },
    :allocation_max_netmask_length => { kind: :property, name: "allocationMaxNetmaskLength", is_optional: true },
    :allocation_min_netmask_length => { kind: :property, name: "allocationMinNetmaskLength", is_optional: true },
    :allocation_resource_tags => { kind: :property, name: "allocationResourceTags", is_optional: true },
    :auto_import => { kind: :property, name: "autoImport", is_optional: true },
    :aws_service => { kind: :property, name: "awsService", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :locale => { kind: :property, name: "locale", is_optional: true },
    :provisioned_cidrs => { kind: :property, name: "provisionedCidrs", is_optional: true },
    :public_ip_source => { kind: :property, name: "publicIpSource", is_optional: true },
    :publicly_advertisable => { kind: :property, name: "publiclyAdvertisable", is_optional: true },
    :source_ipam_pool_id => { kind: :property, name: "sourceIpamPoolId", is_optional: true },
    :source_resource => { kind: :property, name: "sourceResource", 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.



535
536
537
538
 
# File 'ec2/cfn_ipam_pool.rb', line 535

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:



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

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:



557
558
559
560
 
# File 'ec2/cfn_ipam_pool.rb', line 557

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:



568
569
570
571
572
 
# File 'ec2/cfn_ipam_pool.rb', line 568

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.


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

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.



635
636
637
638
 
# File 'ec2/cfn_ipam_pool.rb', line 635

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.



647
648
649
650
651
 
# File 'ec2/cfn_ipam_pool.rb', line 647

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

#address_family ⇒ String

The address family of the pool.

Returns:

  • (String) 


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

def address_family()
  jsii_get_property("addressFamily")
end

#address_family=(value) ⇒ Object 



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

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

#allocation_default_netmask_length ⇒ Numeric?

The default netmask length for allocations added to this pool.

Returns:

  • (Numeric, nil) 


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

def allocation_default_netmask_length()
  jsii_get_property("allocationDefaultNetmaskLength")
end

#allocation_default_netmask_length=(value) ⇒ Object 



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

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

#allocation_max_netmask_length ⇒ Numeric?

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.

Returns:

  • (Numeric, nil) 


344
345
346
 
# File 'ec2/cfn_ipam_pool.rb', line 344

def allocation_max_netmask_length()
  jsii_get_property("allocationMaxNetmaskLength")
end

#allocation_max_netmask_length=(value) ⇒ Object 



348
349
350
351
 
# File 'ec2/cfn_ipam_pool.rb', line 348

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

#allocation_min_netmask_length ⇒ Numeric?

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.

Returns:

  • (Numeric, nil) 


356
357
358
 
# File 'ec2/cfn_ipam_pool.rb', line 356

def allocation_min_netmask_length()
  jsii_get_property("allocationMinNetmaskLength")
end

#allocation_min_netmask_length=(value) ⇒ Object 



360
361
362
363
 
# File 'ec2/cfn_ipam_pool.rb', line 360

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

#allocation_resource_tags ⇒ AWSCDK::IResolvable, ...

Tags that are required for resources that use CIDRs from this IPAM pool.

Returns:



368
369
370
 
# File 'ec2/cfn_ipam_pool.rb', line 368

def allocation_resource_tags()
  jsii_get_property("allocationResourceTags")
end

#allocation_resource_tags=(value) ⇒ Object 



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

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



660
661
662
663
 
# File 'ec2/cfn_ipam_pool.rb', line 660

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:



682
683
684
685
686
687
 
# File 'ec2/cfn_ipam_pool.rb', line 682

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 pool.

Returns:

  • (String) 


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

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_ipam_arn ⇒ String

The ARN of the IPAM.

Returns:

  • (String) 


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

def attr_ipam_arn()
  jsii_get_property("attrIpamArn")
end

#attr_ipam_pool_id ⇒ String

The ID of the IPAM pool.

Returns:

  • (String) 


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

def attr_ipam_pool_id()
  jsii_get_property("attrIpamPoolId")
end

#attr_ipam_scope_arn ⇒ String

The ARN of the scope of the IPAM pool.

Returns:

  • (String) 


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

def attr_ipam_scope_arn()
  jsii_get_property("attrIpamScopeArn")
end

#attr_ipam_scope_type ⇒ String

The scope of the IPAM.

Returns:

  • (String) 


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

def attr_ipam_scope_type()
  jsii_get_property("attrIpamScopeType")
end

#attr_pool_depth ⇒ Numeric

The depth of pools in your IPAM pool.

The pool depth quota is 10.

Returns:

  • (Numeric) 


273
274
275
 
# File 'ec2/cfn_ipam_pool.rb', line 273

def attr_pool_depth()
  jsii_get_property("attrPoolDepth")
end

#attr_state ⇒ String

The state of the IPAM pool.

Returns:

  • (String) 


280
281
282
 
# File 'ec2/cfn_ipam_pool.rb', line 280

def attr_state()
  jsii_get_property("attrState")
end

#attr_state_message ⇒ String

A message related to the failed creation of an IPAM pool.

Returns:

  • (String) 


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

def attr_state_message()
  jsii_get_property("attrStateMessage")
end

#auto_import ⇒ Boolean, ...

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.

Returns:



380
381
382
 
# File 'ec2/cfn_ipam_pool.rb', line 380

def auto_import()
  jsii_get_property("autoImport")
end

#auto_import=(value) ⇒ Object 



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

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

#aws_service ⇒ String?

Limits which service in AWS that the pool can be used in.

Returns:

  • (String, nil) 


392
393
394
 
# File 'ec2/cfn_ipam_pool.rb', line 392

def aws_service()
  jsii_get_property("awsService")
end

#aws_service=(value) ⇒ Object 



396
397
398
399
 
# File 'ec2/cfn_ipam_pool.rb', line 396

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



182
183
184
 
# File 'ec2/cfn_ipam_pool.rb', line 182

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


187
188
189
 
# File 'ec2/cfn_ipam_pool.rb', line 187

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


691
692
693
694
 
# File 'ec2/cfn_ipam_pool.rb', line 691

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


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


144
145
146
 
# File 'ec2/cfn_ipam_pool.rb', line 144

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the IPAM pool.

Returns:

  • (String, nil) 


404
405
406
 
# File 'ec2/cfn_ipam_pool.rb', line 404

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



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

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:



204
205
206
 
# File 'ec2/cfn_ipam_pool.rb', line 204

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:



704
705
706
707
708
 
# File 'ec2/cfn_ipam_pool.rb', line 704

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:



715
716
717
718
 
# File 'ec2/cfn_ipam_pool.rb', line 715

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:



785
786
787
788
 
# File 'ec2/cfn_ipam_pool.rb', line 785

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

#ipam_pool_ref ⇒ AWSCDK::Interfaces::AWSEC2::IPAMPoolReference

A reference to a IPAMPool resource.

Returns:



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

def ipam_pool_ref()
  jsii_get_property("ipamPoolRef")
end

#ipam_scope_id ⇒ String

The ID of the scope in which you would like to create the IPAM pool.

Returns:

  • (String) 


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

def ipam_scope_id()
  jsii_get_property("ipamScopeId")
end

#ipam_scope_id=(value) ⇒ Object 



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

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

#locale ⇒ String?

The locale of the IPAM pool.

Returns:

  • (String, nil) 


416
417
418
 
# File 'ec2/cfn_ipam_pool.rb', line 416

def locale()
  jsii_get_property("locale")
end

#locale=(value) ⇒ Object 



420
421
422
423
 
# File 'ec2/cfn_ipam_pool.rb', line 420

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


156
157
158
 
# File 'ec2/cfn_ipam_pool.rb', line 156

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


139
140
141
 
# File 'ec2/cfn_ipam_pool.rb', line 139

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:



726
727
728
 
# File 'ec2/cfn_ipam_pool.rb', line 726

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:



733
734
735
 
# File 'ec2/cfn_ipam_pool.rb', line 733

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.



526
527
528
529
 
# File 'ec2/cfn_ipam_pool.rb', line 526

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

#provisioned_cidrs ⇒ AWSCDK::IResolvable, ...

Information about the CIDRs provisioned to an IPAM pool.

Returns:



428
429
430
 
# File 'ec2/cfn_ipam_pool.rb', line 428

def provisioned_cidrs()
  jsii_get_property("provisionedCidrs")
end

#provisioned_cidrs=(value) ⇒ Object 



432
433
434
435
 
# File 'ec2/cfn_ipam_pool.rb', line 432

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

#public_ip_source ⇒ String?

The IP address source for pools in the public scope.

Returns:

  • (String, nil) 


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

def public_ip_source()
  jsii_get_property("publicIpSource")
end

#public_ip_source=(value) ⇒ Object 



444
445
446
447
 
# File 'ec2/cfn_ipam_pool.rb', line 444

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

#publicly_advertisable ⇒ Boolean, ...

Determines if a pool is publicly advertisable.

Returns:



452
453
454
 
# File 'ec2/cfn_ipam_pool.rb', line 452

def publicly_advertisable()
  jsii_get_property("publiclyAdvertisable")
end

#publicly_advertisable=(value) ⇒ Object 



456
457
458
459
 
# File 'ec2/cfn_ipam_pool.rb', line 456

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

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


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

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:



744
745
746
747
 
# File 'ec2/cfn_ipam_pool.rb', line 744

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


751
752
753
754
 
# File 'ec2/cfn_ipam_pool.rb', line 751

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:



761
762
763
764
765
 
# File 'ec2/cfn_ipam_pool.rb', line 761

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.



770
771
772
 
# File 'ec2/cfn_ipam_pool.rb', line 770

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_ipam_pool_id ⇒ String?

The ID of the source IPAM pool.

Returns:

  • (String, nil) 


464
465
466
 
# File 'ec2/cfn_ipam_pool.rb', line 464

def source_ipam_pool_id()
  jsii_get_property("sourceIpamPoolId")
end

#source_ipam_pool_id=(value) ⇒ Object 



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

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

#source_resource ⇒ AWSCDK::IResolvable, ...

The resource used to provision CIDRs to a resource planning pool.

Returns:



476
477
478
 
# File 'ec2/cfn_ipam_pool.rb', line 476

def source_resource()
  jsii_get_property("sourceResource")
end

#source_resource=(value) ⇒ Object 



480
481
482
483
484
 
# File 'ec2/cfn_ipam_pool.rb', line 480

def source_resource=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EC2::CfnIPAMPool::SourceResourceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuQ2ZuSVBBTVBvb2wuU291cmNlUmVzb3VyY2VQcm9wZXJ0eSJ9XX19")), "sourceResource") unless value.nil?
  jsii_set_property("sourceResource", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



165
166
167
 
# File 'ec2/cfn_ipam_pool.rb', line 165

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_pool.rb', line 301

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



489
490
491
 
# File 'ec2/cfn_ipam_pool.rb', line 489

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



493
494
495
496
497
 
# File 'ec2/cfn_ipam_pool.rb', line 493

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



502
503
504
 
# File 'ec2/cfn_ipam_pool.rb', line 502

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


212
213
214
 
# File 'ec2/cfn_ipam_pool.rb', line 212

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


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


776
777
778
779
 
# File 'ec2/cfn_ipam_pool.rb', line 776

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) 


515
516
517
518
519
520
 
# File 'ec2/cfn_ipam_pool.rb', line 515

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