Ipam (AWS Java SDK :: Services :: Amazon EC2 2.17.100 API)

java.lang.Object
- software.amazon.awssdk.services.ec2.model.Ipam

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Ipam.Builder,Ipam>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Ipam
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Ipam.Builder,Ipam>
```
IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Ipam.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Ipam.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Ipam.Builder`	`builder()`
`String`	`description()` The description for the IPAM.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasOperatingRegions()` For responses, this returns true if the service returned a value for the OperatingRegions property.
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`String`	`ipamArn()` The ARN of the IPAM.
`String`	`ipamId()` The ID of the IPAM.
`String`	`ipamRegion()` The Amazon Web Services Region of the IPAM.
`List<IpamOperatingRegion>`	`operatingRegions()` The operating Regions for an IPAM.
`String`	`ownerId()` The Amazon Web Services account ID of the owner of the IPAM.
`String`	`privateDefaultScopeId()` The ID of the IPAM's default private scope.
`String`	`publicDefaultScopeId()` The ID of the IPAM's default public scope.
`Integer`	`scopeCount()` The number of scopes in the IPAM.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Ipam.Builder>`	`serializableBuilderClass()`
`IpamState`	`state()` The state of the IPAM.
`String`	`stateAsString()` The state of the IPAM.
`List<Tag>`	`tags()` The key/value combination of a tag assigned to the resource.
`Ipam.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - ownerId
```
public final String ownerId()
```
    The Amazon Web Services account ID of the owner of the IPAM.
    
    Returns:
    
    The Amazon Web Services account ID of the owner of the IPAM.
  - ipamId
```
public final String ipamId()
```
    The ID of the IPAM.
    
    Returns:
    
    The ID of the IPAM.
  - ipamArn
```
public final String ipamArn()
```
    The ARN of the IPAM.
    
    Returns:
    
    The ARN of the IPAM.
  - ipamRegion
```
public final String ipamRegion()
```
    The Amazon Web Services Region of the IPAM.
    
    Returns:
    
    The Amazon Web Services Region of the IPAM.
  - publicDefaultScopeId
```
public final String publicDefaultScopeId()
```
    The ID of the IPAM's default public scope.
    
    Returns:
    
    The ID of the IPAM's default public scope.
  - privateDefaultScopeId
```
public final String privateDefaultScopeId()
```
    The ID of the IPAM's default private scope.
    
    Returns:
    
    The ID of the IPAM's default private scope.
  - scopeCount
```
public final Integer scopeCount()
```
    The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
    
    Returns:
    
    The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see Quotas in IPAM in the Amazon VPC IPAM User Guide.
  - description
```
public final String description()
```
    The description for the IPAM.
    
    Returns:
    
    The description for the IPAM.
  - hasOperatingRegions
```
public final boolean hasOperatingRegions()
```
    For responses, this returns true if the service returned a value for the OperatingRegions 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.
  - operatingRegions
```
public final List<IpamOperatingRegion> operatingRegions()
```
    The operating Regions for an 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 hasOperatingRegions() method.
    
    Returns:
    
    The operating Regions for an 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.
  - state
```
public final IpamState state()
```
    The state of the IPAM.
    
    If the service returns an enum value that is not available in the current SDK version, state will return IpamState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the IPAM.
    
    See Also:
    
    IpamState
  - stateAsString
```
public final String stateAsString()
```
    The state of the IPAM.
    
    If the service returns an enum value that is not available in the current SDK version, state will return IpamState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The state of the IPAM.
    
    See Also:
    
    IpamState
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    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.
    
    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 hasTags() method.
    
    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.
  - toBuilder
```
public Ipam.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Ipam.Builder,Ipam>
  - builder
```
public static Ipam.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Ipam.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Ipam

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

ownerId

ipamId

ipamArn

ipamRegion

publicDefaultScopeId

privateDefaultScopeId

scopeCount

description

hasOperatingRegions

operatingRegions

state

stateAsString

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields