Package software.amazon.awssdk.services.ssm.model

Class ParameterMetadata

java.lang.Object

software.amazon.awssdk.services.ssm.model.ParameterMetadata

All Implemented Interfaces:

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

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

Metadata includes information like the ARN of the last user and the date/time the parameter was last used.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ParameterMetadata.Builder

Method Summary

Modifier and Type	Method	Description
String	allowedPattern()	A parameter name can include only the following letters and symbols.
static ParameterMetadata.Builder	builder()
String	dataType()	The data type of the parameter, such as text or aws:ec2:image.
String	description()	Description of the parameter actions.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPolicies()	For responses, this returns true if the service returned a value for the Policies property.
String	keyId()	The alias of the Key Management Service (KMS) key used to encrypt the parameter.
Instant	lastModifiedDate()	Date the parameter was last changed or updated.
String	lastModifiedUser()	Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.
String	name()	The parameter name.
List<ParameterInlinePolicy>	policies()	A list of policies associated with a parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends ParameterMetadata.Builder>	serializableBuilderClass()
ParameterTier	tier()	The parameter tier.
String	tierAsString()	The parameter tier.
ParameterMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ParameterType	type()	The type of parameter.
String	typeAsString()	The type of parameter.
Long	version()	The parameter version.

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

name

public final String name()

The parameter name.

Returns:

The parameter name.

type

public final ParameterType type()

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

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

Returns:

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

See Also:

ParameterType

typeAsString

public final String typeAsString()

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

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

Returns:

The type of parameter. Valid parameter types include the following: String, StringList, and SecureString.

See Also:

ParameterType

keyId

public final String keyId()

The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only.

Returns:

The alias of the Key Management Service (KMS) key used to encrypt the parameter. Applies to SecureString parameters only.

lastModifiedDate

public final Instant lastModifiedDate()

Date the parameter was last changed or updated.

Returns:

Date the parameter was last changed or updated.

lastModifiedUser

public final String lastModifiedUser()

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

Returns:

Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.

description

public final String description()

Description of the parameter actions.

Returns:

Description of the parameter actions.

allowedPattern

public final String allowedPattern()

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

Returns:

A parameter name can include only the following letters and symbols.

a-zA-Z0-9_.-

version

public final Long version()

The parameter version.

Returns:

The parameter version.

tier

public final ParameterTier tier()

The parameter tier.

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

Returns:

The parameter tier.

See Also:

ParameterTier

tierAsString

public final String tierAsString()

The parameter tier.

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

Returns:

The parameter tier.

See Also:

ParameterTier

hasPolicies

public final boolean hasPolicies()

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

policies

public final List<ParameterInlinePolicy> policies()

A list of policies associated with a 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 hasPolicies() method.

Returns:

A list of policies associated with a parameter.

dataType

public final String dataType()

The data type of the parameter, such as text or aws:ec2:image. The default is text.

Returns:

The data type of the parameter, such as text or aws:ec2:image. The default is text.

toBuilder

public ParameterMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ParameterMetadata.Builder,ParameterMetadata>

builder

public static ParameterMetadata.Builder builder()

serializableBuilderClass

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