Class IpamResourceDiscovery
- java.lang.Object
-
- software.amazon.awssdk.services.ec2.model.IpamResourceDiscovery
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IpamResourceDiscovery.Builder,IpamResourceDiscovery>
@Generated("software.amazon.awssdk:codegen") public final class IpamResourceDiscovery extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamResourceDiscovery.Builder,IpamResourceDiscovery>
A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
IpamResourceDiscovery.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IpamResourceDiscovery.Builder
builder()
String
description()
The resource discovery description.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
ipamResourceDiscoveryArn()
The resource discovery Amazon Resource Name (ARN).String
ipamResourceDiscoveryId()
The resource discovery ID.String
ipamResourceDiscoveryRegion()
The resource discovery Region.Boolean
isDefault()
Defines if the resource discovery is the default.List<IpamOperatingRegion>
operatingRegions()
The operating Regions for the resource discovery.String
ownerId()
The ID of the owner.List<SdkField<?>>
sdkFields()
static Class<? extends IpamResourceDiscovery.Builder>
serializableBuilderClass()
IpamResourceDiscoveryState
state()
The lifecycle state of the resource discovery.String
stateAsString()
The lifecycle state of the resource discovery.List<Tag>
tags()
A tag is a label that you assign to an Amazon Web Services resource.IpamResourceDiscovery.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 ID of the owner.
- Returns:
- The ID of the owner.
-
ipamResourceDiscoveryId
public final String ipamResourceDiscoveryId()
The resource discovery ID.
- Returns:
- The resource discovery ID.
-
ipamResourceDiscoveryArn
public final String ipamResourceDiscoveryArn()
The resource discovery Amazon Resource Name (ARN).
- Returns:
- The resource discovery Amazon Resource Name (ARN).
-
ipamResourceDiscoveryRegion
public final String ipamResourceDiscoveryRegion()
The resource discovery Region.
- Returns:
- The resource discovery Region.
-
description
public final String description()
The resource discovery description.
- Returns:
- The resource discovery description.
-
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 theisEmpty()
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 the resource discovery. 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.
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 the resource discovery. 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.
-
isDefault
public final Boolean isDefault()
Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
- Returns:
- Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
-
state
public final IpamResourceDiscoveryState state()
The lifecycle state of the resource discovery.
-
create-in-progress
- Resource discovery is being created. -
create-complete
- Resource discovery creation is complete. -
create-failed
- Resource discovery creation has failed. -
modify-in-progress
- Resource discovery is being modified. -
modify-complete
- Resource discovery modification is complete. -
modify-failed
- Resource discovery modification has failed. -
delete-in-progress
- Resource discovery is being deleted. -
delete-complete
- Resource discovery deletion is complete. -
delete-failed
- Resource discovery deletion has failed. -
isolate-in-progress
- Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. -
isolate-complete
- Resource discovery isolation is complete. -
restore-in-progress
- Amazon Web Services account that created the resource discovery and was isolated has been restored.
If the service returns an enum value that is not available in the current SDK version,
state
will returnIpamResourceDiscoveryState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The lifecycle state of the resource discovery.
-
create-in-progress
- Resource discovery is being created. -
create-complete
- Resource discovery creation is complete. -
create-failed
- Resource discovery creation has failed. -
modify-in-progress
- Resource discovery is being modified. -
modify-complete
- Resource discovery modification is complete. -
modify-failed
- Resource discovery modification has failed. -
delete-in-progress
- Resource discovery is being deleted. -
delete-complete
- Resource discovery deletion is complete. -
delete-failed
- Resource discovery deletion has failed. -
isolate-in-progress
- Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. -
isolate-complete
- Resource discovery isolation is complete. -
restore-in-progress
- Amazon Web Services account that created the resource discovery and was isolated has been restored.
-
- See Also:
IpamResourceDiscoveryState
-
-
stateAsString
public final String stateAsString()
The lifecycle state of the resource discovery.
-
create-in-progress
- Resource discovery is being created. -
create-complete
- Resource discovery creation is complete. -
create-failed
- Resource discovery creation has failed. -
modify-in-progress
- Resource discovery is being modified. -
modify-complete
- Resource discovery modification is complete. -
modify-failed
- Resource discovery modification has failed. -
delete-in-progress
- Resource discovery is being deleted. -
delete-complete
- Resource discovery deletion is complete. -
delete-failed
- Resource discovery deletion has failed. -
isolate-in-progress
- Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. -
isolate-complete
- Resource discovery isolation is complete. -
restore-in-progress
- Amazon Web Services account that created the resource discovery and was isolated has been restored.
If the service returns an enum value that is not available in the current SDK version,
state
will returnIpamResourceDiscoveryState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The lifecycle state of the resource discovery.
-
create-in-progress
- Resource discovery is being created. -
create-complete
- Resource discovery creation is complete. -
create-failed
- Resource discovery creation has failed. -
modify-in-progress
- Resource discovery is being modified. -
modify-complete
- Resource discovery modification is complete. -
modify-failed
- Resource discovery modification has failed. -
delete-in-progress
- Resource discovery is being deleted. -
delete-complete
- Resource discovery deletion is complete. -
delete-failed
- Resource discovery deletion has failed. -
isolate-in-progress
- Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated. -
isolate-complete
- Resource discovery isolation is complete. -
restore-in-progress
- Amazon Web Services account that created the resource discovery and was isolated has been restored.
-
- See Also:
IpamResourceDiscoveryState
-
-
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 theisEmpty()
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()
A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
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:
- A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your Amazon Web Services costs.
-
toBuilder
public IpamResourceDiscovery.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<IpamResourceDiscovery.Builder,IpamResourceDiscovery>
-
builder
public static IpamResourceDiscovery.Builder builder()
-
serializableBuilderClass
public static Class<? extends IpamResourceDiscovery.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-