com.amazonaws.services.ec2.model

Class CreateIpamPoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateIpamPoolRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<CreateIpamPoolRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateIpamPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<CreateIpamPoolRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateIpamPoolRequest()

Method Summary

Modifier and Type	Method and Description
CreateIpamPoolRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAddressFamily() The IP protocol assigned to this IPAM pool.
Integer	getAllocationDefaultNetmaskLength() The default netmask length for allocations added to this pool.
Integer	getAllocationMaxNetmaskLength() The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
Integer	getAllocationMinNetmaskLength() The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
List<RequestIpamResourceTag>	getAllocationResourceTags() Tags that are required for resources that use CIDRs from this IPAM pool.
Boolean	getAutoImport() If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
String	getAwsService() Limits which service in Amazon Web Services that the pool can be used in.
String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
String	getDescription() A description for the IPAM pool.
Request<CreateIpamPoolRequest>	getDryRunRequest() This method is intended for internal use only.
String	getIpamScopeId() The ID of the scope in which you would like to create the IPAM pool.
String	getLocale() The locale for the pool should be one of the following:
String	getPublicIpSource() The IP address source for pools in the public scope.
Boolean	getPubliclyAdvertisable() Determines if the pool is publicly advertisable.
String	getSourceIpamPoolId() The ID of the source IPAM pool.
IpamPoolSourceResourceRequest	getSourceResource() The resource used to provision CIDRs to a resource planning pool.
List<TagSpecification>	getTagSpecifications() The key/value combination of a tag assigned to the resource.
int	hashCode()
Boolean	isAutoImport() If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
Boolean	isPubliclyAdvertisable() Determines if the pool is publicly advertisable.
void	setAddressFamily(String addressFamily) The IP protocol assigned to this IPAM pool.
void	setAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength) The default netmask length for allocations added to this pool.
void	setAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength) The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
void	setAllocationMinNetmaskLength(Integer allocationMinNetmaskLength) The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
void	setAllocationResourceTags(Collection<RequestIpamResourceTag> allocationResourceTags) Tags that are required for resources that use CIDRs from this IPAM pool.
void	setAutoImport(Boolean autoImport) If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
void	setAwsService(String awsService) Limits which service in Amazon Web Services that the pool can be used in.
void	setClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDescription(String description) A description for the IPAM pool.
void	setIpamScopeId(String ipamScopeId) The ID of the scope in which you would like to create the IPAM pool.
void	setLocale(String locale) The locale for the pool should be one of the following:
void	setPublicIpSource(String publicIpSource) The IP address source for pools in the public scope.
void	setPubliclyAdvertisable(Boolean publiclyAdvertisable) Determines if the pool is publicly advertisable.
void	setSourceIpamPoolId(String sourceIpamPoolId) The ID of the source IPAM pool.
void	setSourceResource(IpamPoolSourceResourceRequest sourceResource) The resource used to provision CIDRs to a resource planning pool.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The key/value combination of a tag assigned to the resource.
String	toString() Returns a string representation of this object.
CreateIpamPoolRequest	withAddressFamily(AddressFamily addressFamily) The IP protocol assigned to this IPAM pool.
CreateIpamPoolRequest	withAddressFamily(String addressFamily) The IP protocol assigned to this IPAM pool.
CreateIpamPoolRequest	withAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength) The default netmask length for allocations added to this pool.
CreateIpamPoolRequest	withAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength) The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.
CreateIpamPoolRequest	withAllocationMinNetmaskLength(Integer allocationMinNetmaskLength) The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.
CreateIpamPoolRequest	withAllocationResourceTags(Collection<RequestIpamResourceTag> allocationResourceTags) Tags that are required for resources that use CIDRs from this IPAM pool.
CreateIpamPoolRequest	withAllocationResourceTags(RequestIpamResourceTag... allocationResourceTags) Tags that are required for resources that use CIDRs from this IPAM pool.
CreateIpamPoolRequest	withAutoImport(Boolean autoImport) If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.
CreateIpamPoolRequest	withAwsService(IpamPoolAwsService awsService) Limits which service in Amazon Web Services that the pool can be used in.
CreateIpamPoolRequest	withAwsService(String awsService) Limits which service in Amazon Web Services that the pool can be used in.
CreateIpamPoolRequest	withClientToken(String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateIpamPoolRequest	withDescription(String description) A description for the IPAM pool.
CreateIpamPoolRequest	withIpamScopeId(String ipamScopeId) The ID of the scope in which you would like to create the IPAM pool.
CreateIpamPoolRequest	withLocale(String locale) The locale for the pool should be one of the following:
CreateIpamPoolRequest	withPublicIpSource(IpamPoolPublicIpSource publicIpSource) The IP address source for pools in the public scope.
CreateIpamPoolRequest	withPublicIpSource(String publicIpSource) The IP address source for pools in the public scope.
CreateIpamPoolRequest	withPubliclyAdvertisable(Boolean publiclyAdvertisable) Determines if the pool is publicly advertisable.
CreateIpamPoolRequest	withSourceIpamPoolId(String sourceIpamPoolId) The ID of the source IPAM pool.
CreateIpamPoolRequest	withSourceResource(IpamPoolSourceResourceRequest sourceResource) The resource used to provision CIDRs to a resource planning pool.
CreateIpamPoolRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The key/value combination of a tag assigned to the resource.
CreateIpamPoolRequest	withTagSpecifications(TagSpecification... tagSpecifications) The key/value combination of a tag assigned to the resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateIpamPoolRequest

public CreateIpamPoolRequest()

Method Detail

setIpamScopeId

public void setIpamScopeId(String ipamScopeId)

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

Parameters:

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

getIpamScopeId

public String getIpamScopeId()

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

Returns:

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

withIpamScopeId

public CreateIpamPoolRequest withIpamScopeId(String ipamScopeId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setLocale

public void setLocale(String locale)

The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

Parameters:

locale - The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

getLocale

public String getLocale()

The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

Returns:

The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

withLocale

public CreateIpamPoolRequest withLocale(String locale)

The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

Parameters:

locale - The locale for the pool should be one of the following:

• An Amazon Web Services Region where you want this IPAM pool to be available for allocations.

• The network border group for an Amazon Web Services Local Zone where you want this IPAM pool to be available for allocations (supported Local Zones). This option is only available for IPAM IPv4 pools in the public scope.

If you do not choose a locale, resources in Regions others than the IPAM's home region cannot use CIDRs from this pool.

Possible values: Any Amazon Web Services Region or supported Amazon Web Services Local Zone.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceIpamPoolId

public void setSourceIpamPoolId(String sourceIpamPoolId)

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

Parameters:

sourceIpamPoolId - The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

getSourceIpamPoolId

public String getSourceIpamPoolId()

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

Returns:

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

withSourceIpamPoolId

public CreateIpamPoolRequest withSourceIpamPoolId(String sourceIpamPoolId)

The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

Parameters:

sourceIpamPoolId - The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description for the IPAM pool.

Parameters:

description - A description for the IPAM pool.

getDescription

public String getDescription()

A description for the IPAM pool.

Returns:

A description for the IPAM pool.

withDescription

public CreateIpamPoolRequest withDescription(String description)

A description for the IPAM pool.

Parameters:

description - A description for the IPAM pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAddressFamily

public void setAddressFamily(String addressFamily)

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Parameters:

addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

See Also:

AddressFamily

getAddressFamily

public String getAddressFamily()

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Returns:

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

See Also:

AddressFamily

withAddressFamily

public CreateIpamPoolRequest withAddressFamily(String addressFamily)

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Parameters:

addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AddressFamily

withAddressFamily

public CreateIpamPoolRequest withAddressFamily(AddressFamily addressFamily)

The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Parameters:

addressFamily - The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AddressFamily

setAutoImport

public void setAutoImport(Boolean autoImport)

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Parameters:

autoImport - If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

getAutoImport

public Boolean getAutoImport()

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

withAutoImport

public CreateIpamPoolRequest withAutoImport(Boolean autoImport)

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Parameters:

autoImport - If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAutoImport

public Boolean isAutoImport()

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

Returns:

If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.

A locale must be set on the pool for this feature to work.

setPubliclyAdvertisable

public void setPubliclyAdvertisable(Boolean publiclyAdvertisable)

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Parameters:

publiclyAdvertisable - Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

getPubliclyAdvertisable

public Boolean getPubliclyAdvertisable()

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Returns:

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

withPubliclyAdvertisable

public CreateIpamPoolRequest withPubliclyAdvertisable(Boolean publiclyAdvertisable)

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Parameters:

publiclyAdvertisable - Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Returns:

Returns a reference to this object so that method calls can be chained together.

isPubliclyAdvertisable

public Boolean isPubliclyAdvertisable()

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

Returns:

Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set to ipv4.

setAllocationMinNetmaskLength

public void setAllocationMinNetmaskLength(Integer allocationMinNetmaskLength)

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Parameters:

allocationMinNetmaskLength - The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

getAllocationMinNetmaskLength

public Integer getAllocationMinNetmaskLength()

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

withAllocationMinNetmaskLength

public CreateIpamPoolRequest withAllocationMinNetmaskLength(Integer allocationMinNetmaskLength)

The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Parameters:

allocationMinNetmaskLength - The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllocationMaxNetmaskLength

public void setAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Parameters:

allocationMaxNetmaskLength - The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

getAllocationMaxNetmaskLength

public Integer getAllocationMaxNetmaskLength()

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

withAllocationMaxNetmaskLength

public CreateIpamPoolRequest withAllocationMaxNetmaskLength(Integer allocationMaxNetmaskLength)

The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Parameters:

allocationMaxNetmaskLength - The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAllocationDefaultNetmaskLength

public void setAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Parameters:

allocationDefaultNetmaskLength - The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

getAllocationDefaultNetmaskLength

public Integer getAllocationDefaultNetmaskLength()

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Returns:

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

withAllocationDefaultNetmaskLength

public CreateIpamPoolRequest withAllocationDefaultNetmaskLength(Integer allocationDefaultNetmaskLength)

The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Parameters:

allocationDefaultNetmaskLength - The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.

Returns:

Returns a reference to this object so that method calls can be chained together.

getAllocationResourceTags

public List<RequestIpamResourceTag> getAllocationResourceTags()

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Returns:

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

setAllocationResourceTags

public void setAllocationResourceTags(Collection<RequestIpamResourceTag> allocationResourceTags)

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Parameters:

allocationResourceTags - Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

withAllocationResourceTags

public CreateIpamPoolRequest withAllocationResourceTags(RequestIpamResourceTag... allocationResourceTags)

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

NOTE: This method appends the values to the existing list (if any). Use setAllocationResourceTags(java.util.Collection) or withAllocationResourceTags(java.util.Collection) if you want to override the existing values.

Parameters:

allocationResourceTags - Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAllocationResourceTags

public CreateIpamPoolRequest withAllocationResourceTags(Collection<RequestIpamResourceTag> allocationResourceTags)

Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Parameters:

allocationResourceTags - Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

setTagSpecifications

public void setTagSpecifications(Collection<TagSpecification> tagSpecifications)

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Parameters:

tagSpecifications - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

withTagSpecifications

public CreateIpamPoolRequest withTagSpecifications(TagSpecification... tagSpecifications)

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

NOTE: This method appends the values to the existing list (if any). Use setTagSpecifications(java.util.Collection) or withTagSpecifications(java.util.Collection) if you want to override the existing values.

Parameters:

tagSpecifications - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTagSpecifications

public CreateIpamPoolRequest withTagSpecifications(Collection<TagSpecification> tagSpecifications)

The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Parameters:

tagSpecifications - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

getClientToken

public String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

withClientToken

public CreateIpamPoolRequest withClientToken(String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Parameters:

clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAwsService

public void setAwsService(String awsService)

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Parameters:

awsService - Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

See Also:

IpamPoolAwsService

getAwsService

public String getAwsService()

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Returns:

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

See Also:

IpamPoolAwsService

withAwsService

public CreateIpamPoolRequest withAwsService(String awsService)

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Parameters:

awsService - Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IpamPoolAwsService

withAwsService

public CreateIpamPoolRequest withAwsService(IpamPoolAwsService awsService)

Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Parameters:

awsService - Limits which service in Amazon Web Services that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IpamPoolAwsService

setPublicIpSource

public void setPublicIpSource(String publicIpSource)

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Parameters:

publicIpSource - The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

See Also:

IpamPoolPublicIpSource

getPublicIpSource

public String getPublicIpSource()

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Returns:

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

See Also:

IpamPoolPublicIpSource

withPublicIpSource

public CreateIpamPoolRequest withPublicIpSource(String publicIpSource)

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Parameters:

publicIpSource - The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IpamPoolPublicIpSource

withPublicIpSource

public CreateIpamPoolRequest withPublicIpSource(IpamPoolPublicIpSource publicIpSource)

The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Parameters:

publicIpSource - The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is byoip. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is amazon. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IpamPoolPublicIpSource

setSourceResource

public void setSourceResource(IpamPoolSourceResourceRequest sourceResource)

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

Parameters:

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

getSourceResource

public IpamPoolSourceResourceRequest getSourceResource()

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

Returns:

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

withSourceResource

public CreateIpamPoolRequest withSourceResource(IpamPoolSourceResourceRequest sourceResource)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<CreateIpamPoolRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<CreateIpamPoolRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateIpamPoolRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()