Class ModifyIpamPoolRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.ModifyIpamPoolRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyIpamPoolRequest extends Ec2Request implements ToCopyableBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyIpamPoolRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<RequestIpamResourceTag>
addAllocationResourceTags()
Add tag allocation rules to a pool.Integer
allocationDefaultNetmaskLength()
The default netmask length for allocations added to this pool.Integer
allocationMaxNetmaskLength()
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant.Integer
allocationMinNetmaskLength()
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant.Boolean
autoImport()
If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM.static ModifyIpamPoolRequest.Builder
builder()
Boolean
clearAllocationDefaultNetmaskLength()
Clear the default netmask length allocation rule for this pool.String
description()
The description of the IPAM pool you want to modify.Boolean
dryRun()
A check for whether you have the required permissions for the action without actually making the request and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAddAllocationResourceTags()
For responses, this returns true if the service returned a value for the AddAllocationResourceTags property.int
hashCode()
boolean
hasRemoveAllocationResourceTags()
For responses, this returns true if the service returned a value for the RemoveAllocationResourceTags property.String
ipamPoolId()
The ID of the IPAM pool you want to modify.List<RequestIpamResourceTag>
removeAllocationResourceTags()
Remove tag allocation rules from a pool.List<SdkField<?>>
sdkFields()
static Class<? extends ModifyIpamPoolRequest.Builder>
serializableBuilderClass()
ModifyIpamPoolRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
dryRun
public final Boolean dryRun()
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- A check for whether you have the required permissions for the action without actually making the request
and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
ipamPoolId
public final String ipamPoolId()
The ID of the IPAM pool you want to modify.
- Returns:
- The ID of the IPAM pool you want to modify.
-
description
public final String description()
The description of the IPAM pool you want to modify.
- Returns:
- The description of the IPAM pool you want to modify.
-
autoImport
public final Boolean autoImport()
If true, 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 true, 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.
-
allocationMinNetmaskLength
public final Integer allocationMinNetmaskLength()
The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
- Returns:
- The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length.
-
allocationMaxNetmaskLength
public final Integer allocationMaxNetmaskLength()
The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
- Returns:
- The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length.
-
allocationDefaultNetmaskLength
public final 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.
- 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.
-
clearAllocationDefaultNetmaskLength
public final Boolean clearAllocationDefaultNetmaskLength()
Clear the default netmask length allocation rule for this pool.
- Returns:
- Clear the default netmask length allocation rule for this pool.
-
hasAddAllocationResourceTags
public final boolean hasAddAllocationResourceTags()
For responses, this returns true if the service returned a value for the AddAllocationResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
addAllocationResourceTags
public final List<RequestIpamResourceTag> addAllocationResourceTags()
Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAddAllocationResourceTags()
method.- Returns:
- Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.
-
hasRemoveAllocationResourceTags
public final boolean hasRemoveAllocationResourceTags()
For responses, this returns true if the service returned a value for the RemoveAllocationResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
removeAllocationResourceTags
public final List<RequestIpamResourceTag> removeAllocationResourceTags()
Remove tag allocation rules from a pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRemoveAllocationResourceTags()
method.- Returns:
- Remove tag allocation rules from a pool.
-
toBuilder
public ModifyIpamPoolRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyIpamPoolRequest.Builder,ModifyIpamPoolRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ModifyIpamPoolRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyIpamPoolRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-