Ipam (AWS Java SDK for Amazon EC2 1.12.558 API)

java.lang.Object
- com.amazonaws.services.ec2.model.Ipam

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Ipam
extends Object
implements Serializable, Cloneable
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Ipam()

Constructors
Constructor and Description
`Ipam()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Ipam`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDefaultResourceDiscoveryAssociationId()` The IPAM's default resource discovery association ID.
`String`	`getDefaultResourceDiscoveryId()` The IPAM's default resource discovery ID.
`String`	`getDescription()` The description for the IPAM.
`String`	`getIpamArn()` The Amazon Resource Name (ARN) of the IPAM.
`String`	`getIpamId()` The ID of the IPAM.
`String`	`getIpamRegion()` The Amazon Web Services Region of the IPAM.
`List<IpamOperatingRegion>`	`getOperatingRegions()` The operating Regions for an IPAM.
`String`	`getOwnerId()` The Amazon Web Services account ID of the owner of the IPAM.
`String`	`getPrivateDefaultScopeId()` The ID of the IPAM's default private scope.
`String`	`getPublicDefaultScopeId()` The ID of the IPAM's default public scope.
`Integer`	`getResourceDiscoveryAssociationCount()` The IPAM's resource discovery association count.
`Integer`	`getScopeCount()` The number of scopes in the IPAM.
`String`	`getState()` The state of the IPAM.
`List<Tag>`	`getTags()` The key/value combination of a tag assigned to the resource.
`int`	`hashCode()`
`void`	`setDefaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)` The IPAM's default resource discovery association ID.
`void`	`setDefaultResourceDiscoveryId(String defaultResourceDiscoveryId)` The IPAM's default resource discovery ID.
`void`	`setDescription(String description)` The description for the IPAM.
`void`	`setIpamArn(String ipamArn)` The Amazon Resource Name (ARN) of the IPAM.
`void`	`setIpamId(String ipamId)` The ID of the IPAM.
`void`	`setIpamRegion(String ipamRegion)` The Amazon Web Services Region of the IPAM.
`void`	`setOperatingRegions(Collection<IpamOperatingRegion> operatingRegions)` The operating Regions for an IPAM.
`void`	`setOwnerId(String ownerId)` The Amazon Web Services account ID of the owner of the IPAM.
`void`	`setPrivateDefaultScopeId(String privateDefaultScopeId)` The ID of the IPAM's default private scope.
`void`	`setPublicDefaultScopeId(String publicDefaultScopeId)` The ID of the IPAM's default public scope.
`void`	`setResourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)` The IPAM's resource discovery association count.
`void`	`setScopeCount(Integer scopeCount)` The number of scopes in the IPAM.
`void`	`setState(String state)` The state of the IPAM.
`void`	`setTags(Collection<Tag> tags)` The key/value combination of a tag assigned to the resource.
`String`	`toString()` Returns a string representation of this object.
`Ipam`	`withDefaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)` The IPAM's default resource discovery association ID.
`Ipam`	`withDefaultResourceDiscoveryId(String defaultResourceDiscoveryId)` The IPAM's default resource discovery ID.
`Ipam`	`withDescription(String description)` The description for the IPAM.
`Ipam`	`withIpamArn(String ipamArn)` The Amazon Resource Name (ARN) of the IPAM.
`Ipam`	`withIpamId(String ipamId)` The ID of the IPAM.
`Ipam`	`withIpamRegion(String ipamRegion)` The Amazon Web Services Region of the IPAM.
`Ipam`	`withOperatingRegions(Collection<IpamOperatingRegion> operatingRegions)` The operating Regions for an IPAM.
`Ipam`	`withOperatingRegions(IpamOperatingRegion... operatingRegions)` The operating Regions for an IPAM.
`Ipam`	`withOwnerId(String ownerId)` The Amazon Web Services account ID of the owner of the IPAM.
`Ipam`	`withPrivateDefaultScopeId(String privateDefaultScopeId)` The ID of the IPAM's default private scope.
`Ipam`	`withPublicDefaultScopeId(String publicDefaultScopeId)` The ID of the IPAM's default public scope.
`Ipam`	`withResourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)` The IPAM's resource discovery association count.
`Ipam`	`withScopeCount(Integer scopeCount)` The number of scopes in the IPAM.
`Ipam`	`withState(IpamState state)` The state of the IPAM.
`Ipam`	`withState(String state)` The state of the IPAM.
`Ipam`	`withTags(Collection<Tag> tags)` The key/value combination of a tag assigned to the resource.
`Ipam`	`withTags(Tag... tags)` The key/value combination of a tag assigned to the resource.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Ipam
```
public Ipam()
```
- Method Detail
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    The Amazon Web Services account ID of the owner of the IPAM.
    
    Parameters:
    
    ownerId - The Amazon Web Services account ID of the owner of the IPAM.
  - getOwnerId
```
public String getOwnerId()
```
    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.
  - withOwnerId
```
public Ipam withOwnerId(String ownerId)
```
    The Amazon Web Services account ID of the owner of the IPAM.
    
    Parameters:
    
    ownerId - The Amazon Web Services account ID of the owner of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamId
```
public void setIpamId(String ipamId)
```
    The ID of the IPAM.
    
    Parameters:
    
    ipamId - The ID of the IPAM.
  - getIpamId
```
public String getIpamId()
```
    The ID of the IPAM.
    
    Returns:
    
    The ID of the IPAM.
  - withIpamId
```
public Ipam withIpamId(String ipamId)
```
    The ID of the IPAM.
    
    Parameters:
    
    ipamId - The ID of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamArn
```
public void setIpamArn(String ipamArn)
```
    The Amazon Resource Name (ARN) of the IPAM.
    
    Parameters:
    
    ipamArn - The Amazon Resource Name (ARN) of the IPAM.
  - getIpamArn
```
public String getIpamArn()
```
    The Amazon Resource Name (ARN) of the IPAM.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the IPAM.
  - withIpamArn
```
public Ipam withIpamArn(String ipamArn)
```
    The Amazon Resource Name (ARN) of the IPAM.
    
    Parameters:
    
    ipamArn - The Amazon Resource Name (ARN) of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamRegion
```
public void setIpamRegion(String ipamRegion)
```
    The Amazon Web Services Region of the IPAM.
    
    Parameters:
    
    ipamRegion - The Amazon Web Services Region of the IPAM.
  - getIpamRegion
```
public String getIpamRegion()
```
    The Amazon Web Services Region of the IPAM.
    
    Returns:
    
    The Amazon Web Services Region of the IPAM.
  - withIpamRegion
```
public Ipam withIpamRegion(String ipamRegion)
```
    The Amazon Web Services Region of the IPAM.
    
    Parameters:
    
    ipamRegion - The Amazon Web Services Region of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicDefaultScopeId
```
public void setPublicDefaultScopeId(String publicDefaultScopeId)
```
    The ID of the IPAM's default public scope.
    
    Parameters:
    
    publicDefaultScopeId - The ID of the IPAM's default public scope.
  - getPublicDefaultScopeId
```
public String getPublicDefaultScopeId()
```
    The ID of the IPAM's default public scope.
    
    Returns:
    
    The ID of the IPAM's default public scope.
  - withPublicDefaultScopeId
```
public Ipam withPublicDefaultScopeId(String publicDefaultScopeId)
```
    The ID of the IPAM's default public scope.
    
    Parameters:
    
    publicDefaultScopeId - The ID of the IPAM's default public scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPrivateDefaultScopeId
```
public void setPrivateDefaultScopeId(String privateDefaultScopeId)
```
    The ID of the IPAM's default private scope.
    
    Parameters:
    
    privateDefaultScopeId - The ID of the IPAM's default private scope.
  - getPrivateDefaultScopeId
```
public String getPrivateDefaultScopeId()
```
    The ID of the IPAM's default private scope.
    
    Returns:
    
    The ID of the IPAM's default private scope.
  - withPrivateDefaultScopeId
```
public Ipam withPrivateDefaultScopeId(String privateDefaultScopeId)
```
    The ID of the IPAM's default private scope.
    
    Parameters:
    
    privateDefaultScopeId - The ID of the IPAM's default private scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScopeCount
```
public void setScopeCount(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.
    
    Parameters:
    
    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.
  - getScopeCount
```
public Integer getScopeCount()
```
    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.
  - withScopeCount
```
public Ipam withScopeCount(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description for the IPAM.
    
    Parameters:
    
    description - The description for the IPAM.
  - getDescription
```
public String getDescription()
```
    The description for the IPAM.
    
    Returns:
    
    The description for the IPAM.
  - withDescription
```
public Ipam withDescription(String description)
```
    The description for the IPAM.
    
    Parameters:
    
    description - The description for the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOperatingRegions
```
public List<IpamOperatingRegion> getOperatingRegions()
```
    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.
    
    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.
  - setOperatingRegions
```
public void setOperatingRegions(Collection<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.
    
    Parameters:
    
    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.
  - withOperatingRegions
```
public Ipam withOperatingRegions(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setOperatingRegions(java.util.Collection) or withOperatingRegions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withOperatingRegions
```
public Ipam withOperatingRegions(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the IPAM.
    
    Parameters:
    
    state - The state of the IPAM.
    
    See Also:
    
    IpamState
  - getState
```
public String getState()
```
    The state of the IPAM.
    
    Returns:
    
    The state of the IPAM.
    
    See Also:
    
    IpamState
  - withState
```
public Ipam withState(String state)
```
    The state of the IPAM.
    
    Parameters:
    
    state - The state of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamState
  - withState
```
public Ipam withState(IpamState state)
```
    The state of the IPAM.
    
    Parameters:
    
    state - The state of the IPAM.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamState
  - getTags
```
public List<Tag> getTags()
```
    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.
  - setTags
```
public void setTags(Collection<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.
    
    Parameters:
    
    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.
  - withTags
```
public Ipam withTags(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public Ipam withTags(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultResourceDiscoveryId
```
public void setDefaultResourceDiscoveryId(String defaultResourceDiscoveryId)
```
    The IPAM's default resource discovery ID.
    
    Parameters:
    
    defaultResourceDiscoveryId - The IPAM's default resource discovery ID.
  - getDefaultResourceDiscoveryId
```
public String getDefaultResourceDiscoveryId()
```
    The IPAM's default resource discovery ID.
    
    Returns:
    
    The IPAM's default resource discovery ID.
  - withDefaultResourceDiscoveryId
```
public Ipam withDefaultResourceDiscoveryId(String defaultResourceDiscoveryId)
```
    The IPAM's default resource discovery ID.
    
    Parameters:
    
    defaultResourceDiscoveryId - The IPAM's default resource discovery ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultResourceDiscoveryAssociationId
```
public void setDefaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)
```
    The IPAM's default resource discovery association ID.
    
    Parameters:
    
    defaultResourceDiscoveryAssociationId - The IPAM's default resource discovery association ID.
  - getDefaultResourceDiscoveryAssociationId
```
public String getDefaultResourceDiscoveryAssociationId()
```
    The IPAM's default resource discovery association ID.
    
    Returns:
    
    The IPAM's default resource discovery association ID.
  - withDefaultResourceDiscoveryAssociationId
```
public Ipam withDefaultResourceDiscoveryAssociationId(String defaultResourceDiscoveryAssociationId)
```
    The IPAM's default resource discovery association ID.
    
    Parameters:
    
    defaultResourceDiscoveryAssociationId - The IPAM's default resource discovery association ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceDiscoveryAssociationCount
```
public void setResourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)
```
    The IPAM's resource discovery association count.
    
    Parameters:
    
    resourceDiscoveryAssociationCount - The IPAM's resource discovery association count.
  - getResourceDiscoveryAssociationCount
```
public Integer getResourceDiscoveryAssociationCount()
```
    The IPAM's resource discovery association count.
    
    Returns:
    
    The IPAM's resource discovery association count.
  - withResourceDiscoveryAssociationCount
```
public Ipam withResourceDiscoveryAssociationCount(Integer resourceDiscoveryAssociationCount)
```
    The IPAM's resource discovery association count.
    
    Parameters:
    
    resourceDiscoveryAssociationCount - The IPAM's resource discovery association count.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 Ipam clone()
```
    Overrides:
    
    clone in class Object

Class Ipam

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ipam

Method Detail

setOwnerId

getOwnerId

withOwnerId

setIpamId

getIpamId

withIpamId

setIpamArn

getIpamArn

withIpamArn

setIpamRegion

getIpamRegion

withIpamRegion

setPublicDefaultScopeId

getPublicDefaultScopeId

withPublicDefaultScopeId

setPrivateDefaultScopeId

getPrivateDefaultScopeId

withPrivateDefaultScopeId

setScopeCount

getScopeCount

withScopeCount

setDescription

getDescription

withDescription

getOperatingRegions

setOperatingRegions

withOperatingRegions

withOperatingRegions

setState

getState

withState

withState

getTags

setTags

withTags

withTags

setDefaultResourceDiscoveryId

getDefaultResourceDiscoveryId

withDefaultResourceDiscoveryId

setDefaultResourceDiscoveryAssociationId

getDefaultResourceDiscoveryAssociationId

withDefaultResourceDiscoveryAssociationId

setResourceDiscoveryAssociationCount

getResourceDiscoveryAssociationCount

withResourceDiscoveryAssociationCount

toString

equals

hashCode

clone