Class Parameter
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.Parameter
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Parameter.Builder,Parameter>
@Generated("software.amazon.awssdk:codegen") public final class Parameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Parameter.Builder,Parameter>
An Amazon Web Services Systems Manager parameter in Parameter Store.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Parameter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
arn()
The Amazon Resource Name (ARN) of the parameter.static Parameter.Builder
builder()
String
dataType()
The data type of the parameter, such astext
oraws:ec2:image
.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
Instant
lastModifiedDate()
Date the parameter was last changed or updated and the parameter version was created.String
name()
The name of the parameter.List<SdkField<?>>
sdkFields()
String
selector()
Either the version number or the label used to retrieve the parameter value.static Class<? extends Parameter.Builder>
serializableBuilderClass()
String
sourceResult()
Applies to parameters that reference information in other Amazon Web Services services.Parameter.Builder
toBuilder()
String
toString()
Returns a string representation of this object.ParameterType
type()
The type of parameter.String
typeAsString()
The type of parameter.String
value()
The parameter value.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 name of the parameter.
- Returns:
- The name of the parameter.
-
type
public final ParameterType type()
The type of parameter. Valid values include the following:
String
,StringList
, andSecureString
.If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.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. Valid values include the following:
String
,StringList
, andSecureString
.If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field. - See Also:
ParameterType
-
typeAsString
public final String typeAsString()
The type of parameter. Valid values include the following:
String
,StringList
, andSecureString
.If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.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. Valid values include the following:
String
,StringList
, andSecureString
.If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field. - See Also:
ParameterType
-
value
public final String value()
The parameter value.
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.- Returns:
- The parameter value.
If type is
StringList
, the system returns a comma-separated string with no spaces between commas in theValue
field.
-
version
public final Long version()
The parameter version.
- Returns:
- The parameter version.
-
selector
public final String selector()
Either the version number or the label used to retrieve the parameter value. Specify selectors by using one of the following formats:
parameter_name:version
parameter_name:label
- Returns:
- Either the version number or the label used to retrieve the parameter value. Specify selectors by using
one of the following formats:
parameter_name:version
parameter_name:label
-
sourceResult
public final String sourceResult()
Applies to parameters that reference information in other Amazon Web Services services.
SourceResult
is the raw result or response from the source.- Returns:
- Applies to parameters that reference information in other Amazon Web Services services.
SourceResult
is the raw result or response from the source.
-
lastModifiedDate
public final Instant lastModifiedDate()
Date the parameter was last changed or updated and the parameter version was created.
- Returns:
- Date the parameter was last changed or updated and the parameter version was created.
-
arn
public final String arn()
The Amazon Resource Name (ARN) of the parameter.
- Returns:
- The Amazon Resource Name (ARN) of the parameter.
-
dataType
public final String 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
public Parameter.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Parameter.Builder,Parameter>
-
builder
public static Parameter.Builder builder()
-
serializableBuilderClass
public static Class<? extends Parameter.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.
-
-