Package software.amazon.awssdk.services.ec2.model

Class IpamScope

java.lang.Object

software.amazon.awssdk.services.ec2.model.IpamScope

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<IpamScope.Builder,IpamScope>

@Generated("software.amazon.awssdk:codegen")
public final class IpamScope
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<IpamScope.Builder,IpamScope>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IpamScope.Builder

Method Summary

Modifier and Type	Method	Description
static IpamScope.Builder	builder()
String	description()	The description of the scope.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
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	ipamRegion()	The Amazon Web Services Region of the IPAM scope.
String	ipamScopeArn()	The Amazon Resource Name (ARN) of the scope.
String	ipamScopeId()	The ID of the scope.
IpamScopeType	ipamScopeType()	The type of the scope.
String	ipamScopeTypeAsString()	The type of the scope.
Boolean	isDefault()	Defines if the scope is the default scope or not.
String	ownerId()	The Amazon Web Services account ID of the owner of the scope.
Integer	poolCount()	The number of pools in the scope.
List<SdkField<?>>	sdkFields()
static Class<? extends IpamScope.Builder>	serializableBuilderClass()
IpamScopeState	state()	The state of the IPAM scope.
String	stateAsString()	The state of the IPAM scope.
List<Tag>	tags()	The key/value combination of a tag assigned to the resource.
IpamScope.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 scope.

Returns:

The Amazon Web Services account ID of the owner of the scope.

ipamScopeId

public final String ipamScopeId()

The ID of the scope.

Returns:

The ID of the scope.

ipamScopeArn

public final String ipamScopeArn()

The Amazon Resource Name (ARN) of the scope.

Returns:

The Amazon Resource Name (ARN) of the scope.

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 scope.

Returns:

The Amazon Web Services Region of the IPAM scope.

ipamScopeType

public final IpamScopeType ipamScopeType()

The type of the scope.

If the service returns an enum value that is not available in the current SDK version, ipamScopeType will return IpamScopeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipamScopeTypeAsString().

Returns:

The type of the scope.

See Also:

IpamScopeType

ipamScopeTypeAsString

public final String ipamScopeTypeAsString()

The type of the scope.

If the service returns an enum value that is not available in the current SDK version, ipamScopeType will return IpamScopeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ipamScopeTypeAsString().

Returns:

The type of the scope.

See Also:

IpamScopeType

isDefault

public final Boolean isDefault()

Defines if the scope is the default scope or not.

Returns:

Defines if the scope is the default scope or not.

description

public final String description()

The description of the scope.

Returns:

The description of the scope.

poolCount

public final Integer poolCount()

The number of pools in the scope.

Returns:

The number of pools in the scope.

state

public final IpamScopeState state()

The state of the IPAM scope.

If the service returns an enum value that is not available in the current SDK version, state will return IpamScopeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the IPAM scope.

See Also:

IpamScopeState

stateAsString

public final String stateAsString()

The state of the IPAM scope.

If the service returns an enum value that is not available in the current SDK version, state will return IpamScopeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the IPAM scope.

See Also:

IpamScopeState

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 IpamScope.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IpamScope.Builder,IpamScope>

builder

public static IpamScope.Builder builder()

serializableBuilderClass

public static Class<? extends IpamScope.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