Class TemplateSSMDocumentDetails

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

This API allows you to create a conformance pack template with an Amazon Web Services Systems Manager document (SSM document). To deploy a conformance pack using an SSM document, first create an SSM document with conformance pack content, and then provide the DocumentName in the PutConformancePack API. You can also provide the DocumentVersion.

The TemplateSSMDocumentDetails object contains the name of the SSM document and the version of the SSM document.

See Also:

  • Method Details

    • documentName

      public final String documentName()

      The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document.

      Returns:
      The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document.

    • documentVersion

      public final String documentVersion()

      The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

      This field is optional.

      Returns:
      The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

      This field is optional.

    • toBuilder

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

    • builder

      public static TemplateSSMDocumentDetails.Builder builder()

    • serializableBuilderClass

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