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:

  • Method Details

    • 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, and SecureString.

      If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

      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 values include the following: String, StringList, and SecureString.

      If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

      See Also:

    • typeAsString

      public final String typeAsString()

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

      If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

      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 values include the following: String, StringList, and SecureString.

      If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value field.

      See Also:

    • 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 the Value field.

      Returns:
      The parameter value.

      If type is StringList, the system returns a comma-separated string with no spaces between commas in the Value 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 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 Parameter.Builder 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 interface ToCopyableBuilder<Parameter.Builder,Parameter>
      Returns:
      a builder for type T

    • builder

      public static Parameter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Parameter.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.