software.amazon.awssdk.services.config.model

Class BaseConfigurationItem

java.lang.Object

software.amazon.awssdk.services.config.model.BaseConfigurationItem

All Implemented Interfaces:

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

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

The detailed configuration of a specified resource.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	BaseConfigurationItem.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The 12-digit Amazon Web Services account ID associated with the resource.
String	arn() The Amazon Resource Name (ARN) of the resource.
String	availabilityZone() The Availability Zone associated with the resource.
String	awsRegion() The region where the resource resides.
static BaseConfigurationItem.Builder	builder()
String	configuration() The description of the resource configuration.
Instant	configurationItemCaptureTime() The time when the configuration recording was initiated.
ConfigurationItemStatus	configurationItemStatus() The configuration item status.
String	configurationItemStatusAsString() The configuration item status.
String	configurationStateId() An identifier that indicates the ordering of the configuration items of a resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSupplementaryConfiguration() For responses, this returns true if the service returned a value for the SupplementaryConfiguration property.
Instant	resourceCreationTime() The time stamp when the resource was created.
String	resourceId() The ID of the resource (for example., sg-xxxxxx).
String	resourceName() The custom name of the resource, if available.
ResourceType	resourceType() The type of Amazon Web Services resource.
String	resourceTypeAsString() The type of Amazon Web Services resource.
List<SdkField<?>>	sdkFields()
static Class<? extends BaseConfigurationItem.Builder>	serializableBuilderClass()
Map<String,String>	supplementaryConfiguration() Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.
BaseConfigurationItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version number of the resource configuration.

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

version

public final String version()

The version number of the resource configuration.

Returns:

The version number of the resource configuration.

accountId

public final String accountId()

The 12-digit Amazon Web Services account ID associated with the resource.

Returns:

The 12-digit Amazon Web Services account ID associated with the resource.

configurationItemCaptureTime

public final Instant configurationItemCaptureTime()

The time when the configuration recording was initiated.

Returns:

The time when the configuration recording was initiated.

configurationItemStatus

public final ConfigurationItemStatus configurationItemStatus()

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

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

Returns:

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

See Also:

ConfigurationItemStatus

configurationItemStatusAsString

public final String configurationItemStatusAsString()

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

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

Returns:

The configuration item status. The valid values are:

• OK – The resource configuration has been updated

• ResourceDiscovered – The resource was newly discovered

• ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type

• ResourceDeleted – The resource was deleted

• ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

See Also:

ConfigurationItemStatus

configurationStateId

public final String configurationStateId()

An identifier that indicates the ordering of the configuration items of a resource.

Returns:

An identifier that indicates the ordering of the configuration items of a resource.

arn

public final String arn()

The Amazon Resource Name (ARN) of the resource.

Returns:

The Amazon Resource Name (ARN) of the resource.

resourceType

public final ResourceType resourceType()

The type of Amazon Web Services resource.

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

Returns:

The type of Amazon Web Services resource.

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The type of Amazon Web Services resource.

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

Returns:

The type of Amazon Web Services resource.

See Also:

ResourceType

resourceId

public final String resourceId()

The ID of the resource (for example., sg-xxxxxx).

Returns:

The ID of the resource (for example., sg-xxxxxx).

resourceName

public final String resourceName()

The custom name of the resource, if available.

Returns:

The custom name of the resource, if available.

awsRegion

public final String awsRegion()

The region where the resource resides.

Returns:

The region where the resource resides.

availabilityZone

public final String availabilityZone()

The Availability Zone associated with the resource.

Returns:

The Availability Zone associated with the resource.

resourceCreationTime

public final Instant resourceCreationTime()

The time stamp when the resource was created.

Returns:

The time stamp when the resource was created.

configuration

public final String configuration()

The description of the resource configuration.

Returns:

The description of the resource configuration.

hasSupplementaryConfiguration

public final boolean hasSupplementaryConfiguration()

For responses, this returns true if the service returned a value for the SupplementaryConfiguration 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.

supplementaryConfiguration

public final Map<String,String> supplementaryConfiguration()

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

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 hasSupplementaryConfiguration() method.

Returns:

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

toBuilder

public BaseConfigurationItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<BaseConfigurationItem.Builder,BaseConfigurationItem>

builder

public static BaseConfigurationItem.Builder builder()

serializableBuilderClass

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