Class SsmDocument
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<SsmDocument.Builder,
SsmDocument>
AWS Systems Manager Document.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
User-friendly name for the AWS Systems Manager Document.static SsmDocument.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Map
<String, SsmExternalParameter> AWS Systems Manager Document external parameters.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExternalParameters property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Parameters property.final Boolean
If true, Cutover will not be enabled if the document has failed.final Map
<String, List<SsmParameterStoreParameter>> AWS Systems Manager Document parameters.static Class
<? extends SsmDocument.Builder> final String
AWS Systems Manager Document name or full ARN.final Integer
AWS Systems Manager Document timeout seconds.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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
AWS Systems Manager Document name or full ARN.
- Returns:
- AWS Systems Manager Document name or full ARN.
-
timeoutSeconds
AWS Systems Manager Document timeout seconds.
- Returns:
- AWS Systems Manager Document timeout seconds.
-
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 interfaceToCopyableBuilder<SsmDocument.Builder,
SsmDocument> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-