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(value="software.amazon.awssdk:codegen")
public final class ParameterMetadata
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ParameterMetadata.Builder,ParameterMetadata>

Metada 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 and Description
static interface	ParameterMetadata.Builder

Method Summary

Modifier and Type	Method and Description
String	allowedPattern() A parameter name can include only the following letters and symbols.
static ParameterMetadata.Builder	builder()
String	description() Description of the parameter actions.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	keyId() The ID of the query key used for this parameter.
Instant	lastModifiedDate() Date the parameter was last changed or updated.
String	lastModifiedUser() Amazon Resource Name (ARN) of the AWS 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 String name()

The parameter name.

Returns:

The parameter name.

type

public ParameterType type()

The type of parameter. Valid parameter types include the following: String, String list, Secure string.

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, String list, Secure string.

See Also:

ParameterType

typeAsString

public String typeAsString()

The type of parameter. Valid parameter types include the following: String, String list, Secure string.

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, String list, Secure string.

See Also:

ParameterType

keyId

public String keyId()

The ID of the query key used for this parameter.

Returns:

The ID of the query key used for this parameter.

lastModifiedDate

public Instant lastModifiedDate()

Date the parameter was last changed or updated.

Returns:

Date the parameter was last changed or updated.

lastModifiedUser

public String lastModifiedUser()

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

Returns:

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

description

public String description()

Description of the parameter actions.

Returns:

Description of the parameter actions.

allowedPattern

public 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 Long version()

The parameter version.

Returns:

The parameter version.

tier

public 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 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

policies

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

Returns:

A list of policies associated with a parameter.

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo