@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)", date="2022-05-13T01:13:32.344Z") public class CfnIPAMAllocation extends CfnResource implements IInspectable
In IPAM, an allocation is a CIDR assignment from an IPAM pool to another resource or IPAM pool.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; CfnIPAMAllocation cfnIPAMAllocation = CfnIPAMAllocation.Builder.create(this, "MyCfnIPAMAllocation") .ipamPoolId("ipamPoolId") // the properties below are optional .cidr("cidr") .description("description") .netmaskLength(123) .build();
Modifier and Type | Class and Description |
---|---|
static class |
CfnIPAMAllocation.Builder
A fluent builder for
CfnIPAMAllocation . |
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnIPAMAllocation(Construct scope,
java.lang.String id,
CfnIPAMAllocationProps props)
Create a new `AWS::EC2::IPAMAllocation`.
|
protected |
CfnIPAMAllocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnIPAMAllocation(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrIpamPoolAllocationId()
The ID of an allocation.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getCidr()
The CIDR you would like to allocate from the IPAM pool.
|
java.lang.String |
getDescription()
A description for the allocation.
|
java.lang.String |
getIpamPoolId()
The ID of the IPAM pool from which you would like to allocate a CIDR.
|
java.lang.Number |
getNetmaskLength()
The netmask length of the CIDR you would like to allocate from the IPAM pool.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setCidr(java.lang.String value)
The CIDR you would like to allocate from the IPAM pool.
|
void |
setDescription(java.lang.String value)
A description for the allocation.
|
void |
setIpamPoolId(java.lang.String value)
The ID of the IPAM pool from which you would like to allocate a CIDR.
|
void |
setNetmaskLength(java.lang.Number value)
The netmask length of the CIDR you would like to allocate from the IPAM pool.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnIPAMAllocation(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnIPAMAllocation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnIPAMAllocation(Construct scope, java.lang.String id, CfnIPAMAllocationProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrIpamPoolAllocationId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getIpamPoolId()
public void setIpamPoolId(java.lang.String value)
public java.lang.String getCidr()
Possible values: Any available IPv4 or IPv6 CIDR.
public void setCidr(java.lang.String value)
Possible values: Any available IPv4 or IPv6 CIDR.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Number getNetmaskLength()
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.
public void setNetmaskLength(java.lang.Number value)
Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.