IpamScope (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class IpamScope
extends Object
implements Serializable, Cloneable
```
In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.

For more information, see How IPAM works in the Amazon VPC IPAM User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

IpamScope()

Constructors
Constructor and Description
`IpamScope()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IpamScope`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDescription()` The description of the scope.
`String`	`getIpamArn()` The ARN of the IPAM.
`String`	`getIpamRegion()` The Amazon Web Services Region of the IPAM scope.
`String`	`getIpamScopeArn()` The Amazon Resource Name (ARN) of the scope.
`String`	`getIpamScopeId()` The ID of the scope.
`String`	`getIpamScopeType()` The type of the scope.
`Boolean`	`getIsDefault()` Defines if the scope is the default scope or not.
`String`	`getOwnerId()` The Amazon Web Services account ID of the owner of the scope.
`Integer`	`getPoolCount()` The number of pools in the scope.
`String`	`getState()` The state of the IPAM scope.
`List<Tag>`	`getTags()` The key/value combination of a tag assigned to the resource.
`int`	`hashCode()`
`Boolean`	`isDefault()` Defines if the scope is the default scope or not.
`void`	`setDescription(String description)` The description of the scope.
`void`	`setIpamArn(String ipamArn)` The ARN of the IPAM.
`void`	`setIpamRegion(String ipamRegion)` The Amazon Web Services Region of the IPAM scope.
`void`	`setIpamScopeArn(String ipamScopeArn)` The Amazon Resource Name (ARN) of the scope.
`void`	`setIpamScopeId(String ipamScopeId)` The ID of the scope.
`void`	`setIpamScopeType(String ipamScopeType)` The type of the scope.
`void`	`setIsDefault(Boolean isDefault)` Defines if the scope is the default scope or not.
`void`	`setOwnerId(String ownerId)` The Amazon Web Services account ID of the owner of the scope.
`void`	`setPoolCount(Integer poolCount)` The number of pools in the scope.
`void`	`setState(String state)` The state of the IPAM scope.
`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.
`IpamScope`	`withDescription(String description)` The description of the scope.
`IpamScope`	`withIpamArn(String ipamArn)` The ARN of the IPAM.
`IpamScope`	`withIpamRegion(String ipamRegion)` The Amazon Web Services Region of the IPAM scope.
`IpamScope`	`withIpamScopeArn(String ipamScopeArn)` The Amazon Resource Name (ARN) of the scope.
`IpamScope`	`withIpamScopeId(String ipamScopeId)` The ID of the scope.
`IpamScope`	`withIpamScopeType(IpamScopeType ipamScopeType)` The type of the scope.
`IpamScope`	`withIpamScopeType(String ipamScopeType)` The type of the scope.
`IpamScope`	`withIsDefault(Boolean isDefault)` Defines if the scope is the default scope or not.
`IpamScope`	`withOwnerId(String ownerId)` The Amazon Web Services account ID of the owner of the scope.
`IpamScope`	`withPoolCount(Integer poolCount)` The number of pools in the scope.
`IpamScope`	`withState(IpamScopeState state)` The state of the IPAM scope.
`IpamScope`	`withState(String state)` The state of the IPAM scope.
`IpamScope`	`withTags(Collection<Tag> tags)` The key/value combination of a tag assigned to the resource.
`IpamScope`	`withTags(Tag... tags)` The key/value combination of a tag assigned to the resource.

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

- Constructor Detail
  - IpamScope
```
public IpamScope()
```
- Method Detail
  - setOwnerId
```
public void setOwnerId(String ownerId)
```
    The Amazon Web Services account ID of the owner of the scope.
    
    Parameters:
    
    ownerId - The Amazon Web Services account ID of the owner of the scope.
  - getOwnerId
```
public String getOwnerId()
```
    The Amazon Web Services account ID of the owner of the scope.
    
    Returns:
    
    The Amazon Web Services account ID of the owner of the scope.
  - withOwnerId
```
public IpamScope withOwnerId(String ownerId)
```
    The Amazon Web Services account ID of the owner of the scope.
    
    Parameters:
    
    ownerId - The Amazon Web Services account ID of the owner of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamScopeId
```
public void setIpamScopeId(String ipamScopeId)
```
    The ID of the scope.
    
    Parameters:
    
    ipamScopeId - The ID of the scope.
  - getIpamScopeId
```
public String getIpamScopeId()
```
    The ID of the scope.
    
    Returns:
    
    The ID of the scope.
  - withIpamScopeId
```
public IpamScope withIpamScopeId(String ipamScopeId)
```
    The ID of the scope.
    
    Parameters:
    
    ipamScopeId - The ID of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamScopeArn
```
public void setIpamScopeArn(String ipamScopeArn)
```
    The Amazon Resource Name (ARN) of the scope.
    
    Parameters:
    
    ipamScopeArn - The Amazon Resource Name (ARN) of the scope.
  - getIpamScopeArn
```
public String getIpamScopeArn()
```
    The Amazon Resource Name (ARN) of the scope.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the scope.
  - withIpamScopeArn
```
public IpamScope withIpamScopeArn(String ipamScopeArn)
```
    The Amazon Resource Name (ARN) of the scope.
    
    Parameters:
    
    ipamScopeArn - The Amazon Resource Name (ARN) of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamArn
```
public void setIpamArn(String ipamArn)
```
    The ARN of the IPAM.
    
    Parameters:
    
    ipamArn - The ARN of the IPAM.
  - getIpamArn
```
public String getIpamArn()
```
    The ARN of the IPAM.
    
    Returns:
    
    The ARN of the IPAM.
  - withIpamArn
```
public IpamScope withIpamArn(String ipamArn)
```
    The ARN of the IPAM.
    
    Parameters:
    
    ipamArn - The 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 scope.
    
    Parameters:
    
    ipamRegion - The Amazon Web Services Region of the IPAM scope.
  - getIpamRegion
```
public String getIpamRegion()
```
    The Amazon Web Services Region of the IPAM scope.
    
    Returns:
    
    The Amazon Web Services Region of the IPAM scope.
  - withIpamRegion
```
public IpamScope withIpamRegion(String ipamRegion)
```
    The Amazon Web Services Region of the IPAM scope.
    
    Parameters:
    
    ipamRegion - The Amazon Web Services Region of the IPAM scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpamScopeType
```
public void setIpamScopeType(String ipamScopeType)
```
    The type of the scope.
    
    Parameters:
    
    ipamScopeType - The type of the scope.
    
    See Also:
    
    IpamScopeType
  - getIpamScopeType
```
public String getIpamScopeType()
```
    The type of the scope.
    
    Returns:
    
    The type of the scope.
    
    See Also:
    
    IpamScopeType
  - withIpamScopeType
```
public IpamScope withIpamScopeType(String ipamScopeType)
```
    The type of the scope.
    
    Parameters:
    
    ipamScopeType - The type of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamScopeType
  - withIpamScopeType
```
public IpamScope withIpamScopeType(IpamScopeType ipamScopeType)
```
    The type of the scope.
    
    Parameters:
    
    ipamScopeType - The type of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamScopeType
  - setIsDefault
```
public void setIsDefault(Boolean isDefault)
```
    Defines if the scope is the default scope or not.
    
    Parameters:
    
    isDefault - Defines if the scope is the default scope or not.
  - getIsDefault
```
public Boolean getIsDefault()
```
    Defines if the scope is the default scope or not.
    
    Returns:
    
    Defines if the scope is the default scope or not.
  - withIsDefault
```
public IpamScope withIsDefault(Boolean isDefault)
```
    Defines if the scope is the default scope or not.
    
    Parameters:
    
    isDefault - Defines if the scope is the default scope or not.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDefault
```
public Boolean isDefault()
```
    Defines if the scope is the default scope or not.
    
    Returns:
    
    Defines if the scope is the default scope or not.
  - setDescription
```
public void setDescription(String description)
```
    The description of the scope.
    
    Parameters:
    
    description - The description of the scope.
  - getDescription
```
public String getDescription()
```
    The description of the scope.
    
    Returns:
    
    The description of the scope.
  - withDescription
```
public IpamScope withDescription(String description)
```
    The description of the scope.
    
    Parameters:
    
    description - The description of the scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolCount
```
public void setPoolCount(Integer poolCount)
```
    The number of pools in the scope.
    
    Parameters:
    
    poolCount - The number of pools in the scope.
  - getPoolCount
```
public Integer getPoolCount()
```
    The number of pools in the scope.
    
    Returns:
    
    The number of pools in the scope.
  - withPoolCount
```
public IpamScope withPoolCount(Integer poolCount)
```
    The number of pools in the scope.
    
    Parameters:
    
    poolCount - The number of pools in the scope.
    
    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 scope.
    
    Parameters:
    
    state - The state of the IPAM scope.
    
    See Also:
    
    IpamScopeState
  - getState
```
public String getState()
```
    The state of the IPAM scope.
    
    Returns:
    
    The state of the IPAM scope.
    
    See Also:
    
    IpamScopeState
  - withState
```
public IpamScope withState(String state)
```
    The state of the IPAM scope.
    
    Parameters:
    
    state - The state of the IPAM scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamScopeState
  - withState
```
public IpamScope withState(IpamScopeState state)
```
    The state of the IPAM scope.
    
    Parameters:
    
    state - The state of the IPAM scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IpamScopeState
  - 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 IpamScope 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 IpamScope 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.
  - 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 IpamScope clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.777

Class IpamScope

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IpamScope

Method Detail

setOwnerId

getOwnerId

withOwnerId

setIpamScopeId

getIpamScopeId

withIpamScopeId

setIpamScopeArn

getIpamScopeArn

withIpamScopeArn

setIpamArn

getIpamArn

withIpamArn

setIpamRegion

getIpamRegion

withIpamRegion

setIpamScopeType

getIpamScopeType

withIpamScopeType

withIpamScopeType

setIsDefault

getIsDefault

withIsDefault

isDefault

setDescription

getDescription

withDescription

setPoolCount

getPoolCount

withPoolCount

setState

getState

withState

withState

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone