Class ParameterHistory
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ParameterHistory.Builder,
ParameterHistory>
Information about parameter usage.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Parameter names can include the following letters and symbols.static ParameterHistory.Builder
builder()
final String
dataType()
The data type of the parameter, such astext
oraws:ec2:image
.final String
Information about the parameter.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Labels property.final boolean
For responses, this returns true if the service returned a value for the Policies property.final String
keyId()
The alias of the Key Management Service (KMS) key used to encrypt the parameter.labels()
Labels assigned to the parameter version.final Instant
Date the parameter was last changed or updated.final String
Amazon Resource Name (ARN) of the Amazon Web Services user who last changed the parameter.final String
name()
The name of the parameter.final List
<ParameterInlinePolicy> policies()
Information about the policies assigned to a parameter.static Class
<? extends ParameterHistory.Builder> final ParameterTier
tier()
The parameter tier.final String
The parameter tier.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final ParameterType
type()
The type of parameter used.final String
The type of parameter used.final String
value()
The parameter value.final Long
version()
The parameter version.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the parameter.
- Returns:
- The name of the parameter.
-
type
The type of parameter used.
If the service returns an enum value that is not available in the current SDK version,
type
will returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of parameter used.
- See Also:
-
typeAsString
The type of parameter used.
If the service returns an enum value that is not available in the current SDK version,
type
will returnParameterType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- The type of parameter used.
- See Also:
-
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
Date the parameter was last changed or updated.
- Returns:
- Date the parameter was last changed or updated.
-
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
Information about the parameter.
- Returns:
- Information about the parameter.
-
value
The parameter value.
- Returns:
- The parameter value.
-
allowedPattern
Parameter names can include the following letters and symbols.
a-zA-Z0-9_.-
- Returns:
- Parameter names can include the following letters and symbols.
a-zA-Z0-9_.-
-
version
The parameter version.
- Returns:
- The parameter version.
-
hasLabels
public final boolean hasLabels()For responses, this returns true if the service returned a value for the Labels 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. -
labels
Labels assigned to the parameter version.
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
hasLabels()
method.- Returns:
- Labels assigned to the parameter version.
-
tier
The parameter tier.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnParameterTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- The parameter tier.
- See Also:
-
tierAsString
The parameter tier.
If the service returns an enum value that is not available in the current SDK version,
tier
will returnParameterTier.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtierAsString()
.- Returns:
- The parameter tier.
- See Also:
-
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 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. -
policies
Information about the policies assigned to a parameter.
Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
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:
- Information about the policies assigned to a parameter.
Assigning parameter policies in the Amazon Web Services Systems Manager User Guide.
-
dataType
The data type of the parameter, such as
text
oraws:ec2:image
. The default istext
.- Returns:
- The data type of the parameter, such as
text
oraws:ec2:image
. The default istext
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ParameterHistory.Builder,
ParameterHistory> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-