software.amazon.awssdk.services.ec2.model

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(value="software.amazon.awssdk:codegen")
public final class ModifyIpamRequest
extends Ec2Request
implements ToCopyableBuilder<ModifyIpamRequest.Builder,ModifyIpamRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ModifyIpamRequest.Builder

Method Summary

Modifier and Type	Method and 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	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()
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

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 the isEmpty() 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 the isEmpty() 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.

toBuilder

public ModifyIpamRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ModifyIpamRequest.Builder,ModifyIpamRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ModifyIpamRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ModifyIpamRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo