SsmDocument (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.mgn.model.SsmDocument

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SsmDocument
extends Object
implements Serializable, Cloneable, StructuredPojo

AWS Systems Manager Document.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SsmDocument()

Constructors
Constructor and Description
`SsmDocument()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SsmDocument`	`addExternalParametersEntry(String key, SsmExternalParameter value)` Add a single ExternalParameters entry
`SsmDocument`	`addParametersEntry(String key, List<SsmParameterStoreParameter> value)` Add a single Parameters entry
`SsmDocument`	`clearExternalParametersEntries()` Removes all the entries added into ExternalParameters.
`SsmDocument`	`clearParametersEntries()` Removes all the entries added into Parameters.
`SsmDocument`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getActionName()` User-friendly name for the AWS Systems Manager Document.
`Map<String,SsmExternalParameter>`	`getExternalParameters()` AWS Systems Manager Document external parameters.
`Boolean`	`getMustSucceedForCutover()` If true, Cutover will not be enabled if the document has failed.
`Map<String,List<SsmParameterStoreParameter>>`	`getParameters()` AWS Systems Manager Document parameters.
`String`	`getSsmDocumentName()` AWS Systems Manager Document name or full ARN.
`Integer`	`getTimeoutSeconds()` AWS Systems Manager Document timeout seconds.
`int`	`hashCode()`
`Boolean`	`isMustSucceedForCutover()` If true, Cutover will not be enabled if the document has failed.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActionName(String actionName)` User-friendly name for the AWS Systems Manager Document.
`void`	`setExternalParameters(Map<String,SsmExternalParameter> externalParameters)` AWS Systems Manager Document external parameters.
`void`	`setMustSucceedForCutover(Boolean mustSucceedForCutover)` If true, Cutover will not be enabled if the document has failed.
`void`	`setParameters(Map<String,List<SsmParameterStoreParameter>> parameters)` AWS Systems Manager Document parameters.
`void`	`setSsmDocumentName(String ssmDocumentName)` AWS Systems Manager Document name or full ARN.
`void`	`setTimeoutSeconds(Integer timeoutSeconds)` AWS Systems Manager Document timeout seconds.
`String`	`toString()` Returns a string representation of this object.
`SsmDocument`	`withActionName(String actionName)` User-friendly name for the AWS Systems Manager Document.
`SsmDocument`	`withExternalParameters(Map<String,SsmExternalParameter> externalParameters)` AWS Systems Manager Document external parameters.
`SsmDocument`	`withMustSucceedForCutover(Boolean mustSucceedForCutover)` If true, Cutover will not be enabled if the document has failed.
`SsmDocument`	`withParameters(Map<String,List<SsmParameterStoreParameter>> parameters)` AWS Systems Manager Document parameters.
`SsmDocument`	`withSsmDocumentName(String ssmDocumentName)` AWS Systems Manager Document name or full ARN.
`SsmDocument`	`withTimeoutSeconds(Integer timeoutSeconds)` AWS Systems Manager Document timeout seconds.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SsmDocument
```
public SsmDocument()
```
- Method Detail
  - setActionName
```
public void setActionName(String actionName)
```
    User-friendly name for the AWS Systems Manager Document.
    
    Parameters:
    
    actionName - User-friendly name for the AWS Systems Manager Document.
  - getActionName
```
public String getActionName()
```
    User-friendly name for the AWS Systems Manager Document.
    
    Returns:
    
    User-friendly name for the AWS Systems Manager Document.
  - withActionName
```
public SsmDocument withActionName(String actionName)
```
    User-friendly name for the AWS Systems Manager Document.
    
    Parameters:
    
    actionName - User-friendly name for the AWS Systems Manager Document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExternalParameters
```
public Map<String,SsmExternalParameter> getExternalParameters()
```
    AWS Systems Manager Document external parameters.
    
    Returns:
    
    AWS Systems Manager Document external parameters.
  - setExternalParameters
```
public void setExternalParameters(Map<String,SsmExternalParameter> externalParameters)
```
    AWS Systems Manager Document external parameters.
    
    Parameters:
    
    externalParameters - AWS Systems Manager Document external parameters.
  - withExternalParameters
```
public SsmDocument withExternalParameters(Map<String,SsmExternalParameter> externalParameters)
```
    AWS Systems Manager Document external parameters.
    
    Parameters:
    
    externalParameters - AWS Systems Manager Document external parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExternalParametersEntry
```
public SsmDocument addExternalParametersEntry(String key,
                                              SsmExternalParameter value)
```
    Add a single ExternalParameters entry
    
    See Also:
    
    withExternalParameters(java.util.Map<java.lang.String, com.amazonaws.services.mgn.model.SsmExternalParameter>)
  - clearExternalParametersEntries
```
public SsmDocument clearExternalParametersEntries()
```
    Removes all the entries added into ExternalParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMustSucceedForCutover
```
public void setMustSucceedForCutover(Boolean mustSucceedForCutover)
```
    If true, Cutover will not be enabled if the document has failed.
    
    Parameters:
    
    mustSucceedForCutover - If true, Cutover will not be enabled if the document has failed.
  - getMustSucceedForCutover
```
public Boolean getMustSucceedForCutover()
```
    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.
  - withMustSucceedForCutover
```
public SsmDocument withMustSucceedForCutover(Boolean mustSucceedForCutover)
```
    If true, Cutover will not be enabled if the document has failed.
    
    Parameters:
    
    mustSucceedForCutover - If true, Cutover will not be enabled if the document has failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isMustSucceedForCutover
```
public Boolean isMustSucceedForCutover()
```
    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.
  - getParameters
```
public Map<String,List<SsmParameterStoreParameter>> getParameters()
```
    AWS Systems Manager Document parameters.
    
    Returns:
    
    AWS Systems Manager Document parameters.
  - setParameters
```
public void setParameters(Map<String,List<SsmParameterStoreParameter>> parameters)
```
    AWS Systems Manager Document parameters.
    
    Parameters:
    
    parameters - AWS Systems Manager Document parameters.
  - withParameters
```
public SsmDocument withParameters(Map<String,List<SsmParameterStoreParameter>> parameters)
```
    AWS Systems Manager Document parameters.
    
    Parameters:
    
    parameters - AWS Systems Manager Document parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public SsmDocument addParametersEntry(String key,
                                      List<SsmParameterStoreParameter> value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.util.List<com.amazonaws.services.mgn.model.SsmParameterStoreParameter>>)
  - clearParametersEntries
```
public SsmDocument clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSsmDocumentName
```
public void setSsmDocumentName(String ssmDocumentName)
```
    AWS Systems Manager Document name or full ARN.
    
    Parameters:
    
    ssmDocumentName - AWS Systems Manager Document name or full ARN.
  - getSsmDocumentName
```
public String getSsmDocumentName()
```
    AWS Systems Manager Document name or full ARN.
    
    Returns:
    
    AWS Systems Manager Document name or full ARN.
  - withSsmDocumentName
```
public SsmDocument withSsmDocumentName(String ssmDocumentName)
```
    AWS Systems Manager Document name or full ARN.
    
    Parameters:
    
    ssmDocumentName - AWS Systems Manager Document name or full ARN.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Integer timeoutSeconds)
```
    AWS Systems Manager Document timeout seconds.
    
    Parameters:
    
    timeoutSeconds - AWS Systems Manager Document timeout seconds.
  - getTimeoutSeconds
```
public Integer getTimeoutSeconds()
```
    AWS Systems Manager Document timeout seconds.
    
    Returns:
    
    AWS Systems Manager Document timeout seconds.
  - withTimeoutSeconds
```
public SsmDocument withTimeoutSeconds(Integer timeoutSeconds)
```
    AWS Systems Manager Document timeout seconds.
    
    Parameters:
    
    timeoutSeconds - AWS Systems Manager Document timeout seconds.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public SsmDocument clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class SsmDocument

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SsmDocument

Method Detail

setActionName

getActionName

withActionName

getExternalParameters

setExternalParameters

withExternalParameters

addExternalParametersEntry

clearExternalParametersEntries

setMustSucceedForCutover

getMustSucceedForCutover

withMustSucceedForCutover

isMustSucceedForCutover

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setSsmDocumentName

getSsmDocumentName

withSsmDocumentName

setTimeoutSeconds

getTimeoutSeconds

withTimeoutSeconds

toString

equals

hashCode

clone

marshall