Class SsmParameterConfiguration

java.lang.Object
software.amazon.awssdk.services.imagebuilder.model.SsmParameterConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SsmParameterConfiguration.Builder,SsmParameterConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class SsmParameterConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SsmParameterConfiguration.Builder,SsmParameterConfiguration>

Configuration for a single Parameter in the Amazon Web Services Systems Manager (SSM) Parameter Store in a given Region.

See Also:

  • Method Details

    • amiAccountId

      public final String amiAccountId()

      Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.

      Returns:
      Specify the account that will own the Parameter in a given Region. During distribution, this account must be specified in distribution settings as a target account for the Region.

    • parameterName

      public final String parameterName()

      This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.

      Returns:
      This is the name of the Parameter in the target Region or account. The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.

    • dataType

      public final SsmParameterDataType dataType()

      The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.

      If the service returns an enum value that is not available in the current SDK version, dataType will return SsmParameterDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.

      If the service returns an enum value that is not available in the current SDK version, dataType will return SsmParameterDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The data type specifies what type of value the Parameter contains. We recommend that you use data type aws:ec2:image.
      See Also:

    • toBuilder

      public SsmParameterConfiguration.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<SsmParameterConfiguration.Builder,SsmParameterConfiguration>
      Returns:
      a builder for type T

    • builder

      public static SsmParameterConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SsmParameterConfiguration.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.