SsmAutomation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ssmincidents.model.SsmAutomation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SsmAutomation
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Details about the Systems Manager automation document that will be used as a runbook during an incident.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

SsmAutomation()

Constructors
Constructor and Description
`SsmAutomation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SsmAutomation`	`addDynamicParametersEntry(String key, DynamicSsmParameterValue value)` Add a single DynamicParameters entry
`SsmAutomation`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`SsmAutomation`	`clearDynamicParametersEntries()` Removes all the entries added into DynamicParameters.
`SsmAutomation`	`clearParametersEntries()` Removes all the entries added into Parameters.
`SsmAutomation`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getDocumentName()` The automation document's name.
`String`	`getDocumentVersion()` The automation document's version to use when running.
`Map<String,DynamicSsmParameterValue>`	`getDynamicParameters()` The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
`Map<String,List<String>>`	`getParameters()` The key-value pair parameters to use when running the automation document.
`String`	`getRoleArn()` The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
`String`	`getTargetAccount()` The account that the automation document will be run in.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDocumentName(String documentName)` The automation document's name.
`void`	`setDocumentVersion(String documentVersion)` The automation document's version to use when running.
`void`	`setDynamicParameters(Map<String,DynamicSsmParameterValue> dynamicParameters)` The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
`void`	`setParameters(Map<String,List<String>> parameters)` The key-value pair parameters to use when running the automation document.
`void`	`setRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
`void`	`setTargetAccount(String targetAccount)` The account that the automation document will be run in.
`String`	`toString()` Returns a string representation of this object.
`SsmAutomation`	`withDocumentName(String documentName)` The automation document's name.
`SsmAutomation`	`withDocumentVersion(String documentVersion)` The automation document's version to use when running.
`SsmAutomation`	`withDynamicParameters(Map<String,DynamicSsmParameterValue> dynamicParameters)` The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
`SsmAutomation`	`withParameters(Map<String,List<String>> parameters)` The key-value pair parameters to use when running the automation document.
`SsmAutomation`	`withRoleArn(String roleArn)` The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
`SsmAutomation`	`withTargetAccount(SsmTargetAccount targetAccount)` The account that the automation document will be run in.
`SsmAutomation`	`withTargetAccount(String targetAccount)` The account that the automation document will be run in.

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

- Constructor Detail
  - SsmAutomation
```
public SsmAutomation()
```
- Method Detail
  - setDocumentName
```
public void setDocumentName(String documentName)
```
    The automation document's name.
    
    Parameters:
    
    documentName - The automation document's name.
  - getDocumentName
```
public String getDocumentName()
```
    The automation document's name.
    
    Returns:
    
    The automation document's name.
  - withDocumentName
```
public SsmAutomation withDocumentName(String documentName)
```
    The automation document's name.
    
    Parameters:
    
    documentName - The automation document's name.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The automation document's version to use when running.
    
    Parameters:
    
    documentVersion - The automation document's version to use when running.
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The automation document's version to use when running.
    
    Returns:
    
    The automation document's version to use when running.
  - withDocumentVersion
```
public SsmAutomation withDocumentVersion(String documentVersion)
```
    The automation document's version to use when running.
    
    Parameters:
    
    documentVersion - The automation document's version to use when running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDynamicParameters
```
public Map<String,DynamicSsmParameterValue> getDynamicParameters()
```
    The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    
    Returns:
    
    The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
  - setDynamicParameters
```
public void setDynamicParameters(Map<String,DynamicSsmParameterValue> dynamicParameters)
```
    The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    
    Parameters:
    
    dynamicParameters - The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
  - withDynamicParameters
```
public SsmAutomation withDynamicParameters(Map<String,DynamicSsmParameterValue> dynamicParameters)
```
    The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    
    Parameters:
    
    dynamicParameters - The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDynamicParametersEntry
```
public SsmAutomation addDynamicParametersEntry(String key,
                                               DynamicSsmParameterValue value)
```
    Add a single DynamicParameters entry
    
    See Also:
    
    withDynamicParameters(java.util.Map<java.lang.String, com.amazonaws.services.ssmincidents.model.DynamicSsmParameterValue>)
  - clearDynamicParametersEntries
```
public SsmAutomation clearDynamicParametersEntries()
```
    Removes all the entries added into DynamicParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    The key-value pair parameters to use when running the automation document.
    
    Returns:
    
    The key-value pair parameters to use when running the automation document.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The key-value pair parameters to use when running the automation document.
    
    Parameters:
    
    parameters - The key-value pair parameters to use when running the automation document.
  - withParameters
```
public SsmAutomation withParameters(Map<String,List<String>> parameters)
```
    The key-value pair parameters to use when running the automation document.
    
    Parameters:
    
    parameters - The key-value pair parameters to use when running the automation document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public SsmAutomation addParametersEntry(String key,
                                        List<String> value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, java.util.List<java.lang.String>>)
  - clearParametersEntries
```
public SsmAutomation clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
  - withRoleArn
```
public SsmAutomation withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    
    Parameters:
    
    roleArn - The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetAccount
```
public void setTargetAccount(String targetAccount)
```
    The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Parameters:
    
    targetAccount - The account that the automation document will be run in. This can be in either the management account or an application account.
    
    See Also:
    
    SsmTargetAccount
  - getTargetAccount
```
public String getTargetAccount()
```
    The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Returns:
    
    The account that the automation document will be run in. This can be in either the management account or an application account.
    
    See Also:
    
    SsmTargetAccount
  - withTargetAccount
```
public SsmAutomation withTargetAccount(String targetAccount)
```
    The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Parameters:
    
    targetAccount - The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SsmTargetAccount
  - withTargetAccount
```
public SsmAutomation withTargetAccount(SsmTargetAccount targetAccount)
```
    The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Parameters:
    
    targetAccount - The account that the automation document will be run in. This can be in either the management account or an application account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SsmTargetAccount
  - 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 SsmAutomation 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.783

Class SsmAutomation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SsmAutomation

Method Detail

setDocumentName

getDocumentName

withDocumentName

setDocumentVersion

getDocumentVersion

withDocumentVersion

getDynamicParameters

setDynamicParameters

withDynamicParameters

addDynamicParametersEntry

clearDynamicParametersEntries

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setRoleArn

getRoleArn

withRoleArn

setTargetAccount

getTargetAccount

withTargetAccount

withTargetAccount

toString

equals

hashCode

clone

marshall