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

Class ParameterHistory

    • Method Detail

      • name

        public final String name()

        The name of the parameter.

        Returns:
        The name of the parameter.

      • typeAsString

        public final String typeAsString()

        The type of parameter used.

        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 used.
        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()

        Information about the parameter.

        Returns:
        Information about the parameter.

      • value

        public final String value()

        The parameter value.

        Returns:
        The parameter value.

      • allowedPattern

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

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

      • labels

        public final List<String> 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.

      • 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()

        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

        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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

      • 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)