Package software.amazon.awssdk.services.mgn.model

Class SsmDocument

java.lang.Object

software.amazon.awssdk.services.mgn.model.SsmDocument

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SsmDocument.Builder,SsmDocument>

@Generated("software.amazon.awssdk:codegen")
public final class SsmDocument
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SsmDocument.Builder,SsmDocument>

AWS Systems Manager Document.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SsmDocument.Builder

Method Summary

Modifier and Type	Method	Description
String	actionName()	User-friendly name for the AWS Systems Manager Document.
static SsmDocument.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Map<String,SsmExternalParameter>	externalParameters()	AWS Systems Manager Document external parameters.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasExternalParameters()	For responses, this returns true if the service returned a value for the ExternalParameters property.
int	hashCode()
boolean	hasParameters()	For responses, this returns true if the service returned a value for the Parameters property.
Boolean	mustSucceedForCutover()	If true, Cutover will not be enabled if the document has failed.
Map<String,List<SsmParameterStoreParameter>>	parameters()	AWS Systems Manager Document parameters.
List<SdkField<?>>	sdkFields()
static Class<? extends SsmDocument.Builder>	serializableBuilderClass()
String	ssmDocumentName()	AWS Systems Manager Document name or full ARN.
Integer	timeoutSeconds()	AWS Systems Manager Document timeout seconds.
SsmDocument.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

actionName

public final String actionName()

User-friendly name for the AWS Systems Manager Document.

Returns:

User-friendly name for the AWS Systems Manager Document.

hasExternalParameters

public final boolean hasExternalParameters()

For responses, this returns true if the service returned a value for the ExternalParameters 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.

externalParameters

public final Map<String,SsmExternalParameter> externalParameters()

AWS Systems Manager Document external parameters.

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 hasExternalParameters() method.

Returns:

AWS Systems Manager Document external parameters.

mustSucceedForCutover

public final Boolean mustSucceedForCutover()

If true, Cutover will not be enabled if the document has failed.

Returns:

If true, Cutover will not be enabled if the document has failed.

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters 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.

parameters

public final Map<String,List<SsmParameterStoreParameter>> parameters()

AWS Systems Manager Document parameters.

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 hasParameters() method.

Returns:

AWS Systems Manager Document parameters.

ssmDocumentName

public final String ssmDocumentName()

AWS Systems Manager Document name or full ARN.

Returns:

AWS Systems Manager Document name or full ARN.

timeoutSeconds

public final Integer timeoutSeconds()

AWS Systems Manager Document timeout seconds.

Returns:

AWS Systems Manager Document timeout seconds.

toBuilder

public SsmDocument.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SsmDocument.Builder,SsmDocument>

builder

public static SsmDocument.Builder builder()

serializableBuilderClass

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