Package software.amazon.awssdk.services.config.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TemplateSSMDocumentDetails.Builder

Method Summary

Modifier and Type	Method	Description
static TemplateSSMDocumentDetails.Builder	builder()
String	documentName()	The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack.
String	documentVersion()	The version of the SSM document to use to create a conformance pack.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends TemplateSSMDocumentDetails.Builder>	serializableBuilderClass()
TemplateSSMDocumentDetails.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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. If you want to use an SSM document from another Region or account, you must provide the ARN.

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. If you want to use an SSM document from another Region or account, you must provide the ARN.

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

Specified by:

toBuilder in interface ToCopyableBuilder<TemplateSSMDocumentDetails.Builder,TemplateSSMDocumentDetails>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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