Class ModifyIpamRequest
- 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.ModifyIpamRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ModifyIpamRequest.Builder,ModifyIpamRequest>
@Generated("software.amazon.awssdk:codegen") public final class ModifyIpamRequest extends Ec2Request implements ToCopyableBuilder<ModifyIpamRequest.Builder,ModifyIpamRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ModifyIpamRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<AddIpamOperatingRegion>
addOperatingRegions()
Choose the operating Regions for the IPAM.static ModifyIpamRequest.Builder
builder()
String
description()
The description of the IPAM 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
hasAddOperatingRegions()
For responses, this returns true if the service returned a value for the AddOperatingRegions property.int
hashCode()
boolean
hasRemoveOperatingRegions()
For responses, this returns true if the service returned a value for the RemoveOperatingRegions property.String
ipamId()
The ID of the IPAM you want to modify.List<RemoveIpamOperatingRegion>
removeOperatingRegions()
The operating Regions to remove.List<SdkField<?>>
sdkFields()
static Class<? extends ModifyIpamRequest.Builder>
serializableBuilderClass()
IpamTier
tier()
IPAM is offered in a Free Tier and an Advanced Tier.String
tierAsString()
IPAM is offered in a Free Tier and an Advanced Tier.ModifyIpamRequest.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
.
-
ipamId
public final String ipamId()
The ID of the IPAM you want to modify.
- Returns:
- The ID of the IPAM you want to modify.
-
description
public final String description()
The description of the IPAM you want to modify.
- Returns:
- The description of the IPAM you want to modify.
-
hasAddOperatingRegions
public final boolean hasAddOperatingRegions()
For responses, this returns true if the service returned a value for the AddOperatingRegions 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.
-
addOperatingRegions
public final List<AddIpamOperatingRegion> addOperatingRegions()
Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM 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
hasAddOperatingRegions()
method.- Returns:
- Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the
IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web
Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
-
hasRemoveOperatingRegions
public final boolean hasRemoveOperatingRegions()
For responses, this returns true if the service returned a value for the RemoveOperatingRegions 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.
-
removeOperatingRegions
public final List<RemoveIpamOperatingRegion> removeOperatingRegions()
The operating Regions to remove.
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
hasRemoveOperatingRegions()
method.- Returns:
- The operating Regions to remove.
-
tier
public final IpamTier tier()
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnIpamTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
- See Also:
IpamTier
-
tierAsString
public final String tierAsString()
IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnIpamTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see Amazon VPC pricing > IPAM tab.
- See Also:
IpamTier
-
toBuilder
public ModifyIpamRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ModifyIpamRequest.Builder,ModifyIpamRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ModifyIpamRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ModifyIpamRequest.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
-
-