Class Parameter

java.lang.Object
software.amazon.awssdk.services.cloudformation.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>

The Parameter data type.

See Also:

  • Method Details

    • parameterKey

      public final String parameterKey()

      The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

      Returns:
      The key associated with the parameter. If you don't specify a key and value for a particular parameter, CloudFormation uses the default value that's specified in your template.

    • parameterValue

      public final String parameterValue()

      The input value associated with the parameter.

      Returns:
      The input value associated with the parameter.

    • usePreviousValue

      public final Boolean usePreviousValue()

      During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

      Returns:
      During a stack update, use the existing parameter value that the stack is using for a given parameter key. If you specify true, do not specify a parameter value.

    • resolvedValue

      public final String resolvedValue()

      Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Use CloudFormation-supplied parameter types in the CloudFormation User Guide.

      Returns:
      Read-only. The value that corresponds to a Systems Manager parameter key. This field is returned only for Systems Manager parameter types in the template. For more information, see Use CloudFormation-supplied parameter types in the CloudFormation User Guide.

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