MaintenanceWindowRunCommandParameters (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.MaintenanceWindowRunCommandParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MaintenanceWindowRunCommandParameters
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The parameters for a RUN_COMMAND task type.

For information about specifying and updating task parameters, see RegisterTaskWithMaintenanceWindow and UpdateMaintenanceWindowTask.

LoggingInfo has been deprecated. To specify an S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters.

For Run Command tasks, Systems Manager uses specified values for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MaintenanceWindowRunCommandParameters()

Constructors
Constructor and Description
`MaintenanceWindowRunCommandParameters()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MaintenanceWindowRunCommandParameters`	`addParametersEntry(String key, List<String> value)` Add a single Parameters entry
`MaintenanceWindowRunCommandParameters`	`clearParametersEntries()` Removes all the entries added into Parameters.
`MaintenanceWindowRunCommandParameters`	`clone()`
`boolean`	`equals(Object obj)`
`CloudWatchOutputConfig`	`getCloudWatchOutputConfig()`
`String`	`getComment()` Information about the commands to run.
`String`	`getDocumentHash()` The SHA-256 or SHA-1 hash created by the system when the document was created.
`String`	`getDocumentHashType()` SHA-256 or SHA-1.
`String`	`getDocumentVersion()` The SSM document version to use in the request.
`NotificationConfig`	`getNotificationConfig()` Configurations for sending notifications about command status changes on a per-instance basis.
`String`	`getOutputS3BucketName()` The name of the S3 bucket.
`String`	`getOutputS3KeyPrefix()` The S3 bucket subfolder.
`Map<String,List<String>>`	`getParameters()` The parameters for the RUN_COMMAND task execution.
`String`	`getServiceRoleArn()` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`Integer`	`getTimeoutSeconds()` If this time is reached and the command has not already started running, it doesn't run.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)`
`void`	`setComment(String comment)` Information about the commands to run.
`void`	`setDocumentHash(String documentHash)` The SHA-256 or SHA-1 hash created by the system when the document was created.
`void`	`setDocumentHashType(String documentHashType)` SHA-256 or SHA-1.
`void`	`setDocumentVersion(String documentVersion)` The SSM document version to use in the request.
`void`	`setNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications about command status changes on a per-instance basis.
`void`	`setOutputS3BucketName(String outputS3BucketName)` The name of the S3 bucket.
`void`	`setOutputS3KeyPrefix(String outputS3KeyPrefix)` The S3 bucket subfolder.
`void`	`setParameters(Map<String,List<String>> parameters)` The parameters for the RUN_COMMAND task execution.
`void`	`setServiceRoleArn(String serviceRoleArn)` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`void`	`setTimeoutSeconds(Integer timeoutSeconds)` If this time is reached and the command has not already started running, it doesn't run.
`String`	`toString()` Returns a string representation of this object.
`MaintenanceWindowRunCommandParameters`	`withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)`
`MaintenanceWindowRunCommandParameters`	`withComment(String comment)` Information about the commands to run.
`MaintenanceWindowRunCommandParameters`	`withDocumentHash(String documentHash)` The SHA-256 or SHA-1 hash created by the system when the document was created.
`MaintenanceWindowRunCommandParameters`	`withDocumentHashType(DocumentHashType documentHashType)` SHA-256 or SHA-1.
`MaintenanceWindowRunCommandParameters`	`withDocumentHashType(String documentHashType)` SHA-256 or SHA-1.
`MaintenanceWindowRunCommandParameters`	`withDocumentVersion(String documentVersion)` The SSM document version to use in the request.
`MaintenanceWindowRunCommandParameters`	`withNotificationConfig(NotificationConfig notificationConfig)` Configurations for sending notifications about command status changes on a per-instance basis.
`MaintenanceWindowRunCommandParameters`	`withOutputS3BucketName(String outputS3BucketName)` The name of the S3 bucket.
`MaintenanceWindowRunCommandParameters`	`withOutputS3KeyPrefix(String outputS3KeyPrefix)` The S3 bucket subfolder.
`MaintenanceWindowRunCommandParameters`	`withParameters(Map<String,List<String>> parameters)` The parameters for the RUN_COMMAND task execution.
`MaintenanceWindowRunCommandParameters`	`withServiceRoleArn(String serviceRoleArn)` The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
`MaintenanceWindowRunCommandParameters`	`withTimeoutSeconds(Integer timeoutSeconds)` If this time is reached and the command has not already started running, it doesn't run.

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

- Constructor Detail
  - MaintenanceWindowRunCommandParameters
```
public MaintenanceWindowRunCommandParameters()
```
- Method Detail
  - setComment
```
public void setComment(String comment)
```
    Information about the commands to run.
    
    Parameters:
    
    comment - Information about the commands to run.
  - getComment
```
public String getComment()
```
    Information about the commands to run.
    
    Returns:
    
    Information about the commands to run.
  - withComment
```
public MaintenanceWindowRunCommandParameters withComment(String comment)
```
    Information about the commands to run.
    
    Parameters:
    
    comment - Information about the commands to run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCloudWatchOutputConfig
```
public void setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    Parameters:
    
    cloudWatchOutputConfig -
  - getCloudWatchOutputConfig
```
public CloudWatchOutputConfig getCloudWatchOutputConfig()
```
    Returns:
  - withCloudWatchOutputConfig
```
public MaintenanceWindowRunCommandParameters withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
```
    Parameters:
    
    cloudWatchOutputConfig -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentHash
```
public void setDocumentHash(String documentHash)
```
    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
    
    Parameters:
    
    documentHash - The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
  - getDocumentHash
```
public String getDocumentHash()
```
    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
    
    Returns:
    
    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
  - withDocumentHash
```
public MaintenanceWindowRunCommandParameters withDocumentHash(String documentHash)
```
    The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
    
    Parameters:
    
    documentHash - The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDocumentHashType
```
public void setDocumentHashType(String documentHashType)
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - getDocumentHashType
```
public String getDocumentHashType()
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Returns:
    
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - withDocumentHashType
```
public MaintenanceWindowRunCommandParameters withDocumentHashType(String documentHashType)
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - withDocumentHashType
```
public MaintenanceWindowRunCommandParameters withDocumentHashType(DocumentHashType documentHashType)
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Parameters:
    
    documentHashType - SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    DocumentHashType
  - setDocumentVersion
```
public void setDocumentVersion(String documentVersion)
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Parameters:
    
    documentVersion - The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
  - getDocumentVersion
```
public String getDocumentVersion()
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Returns:
    
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
  - withDocumentVersion
```
public MaintenanceWindowRunCommandParameters withDocumentVersion(String documentVersion)
```
    The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Parameters:
    
    documentVersion - The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the AWS CLI, then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:
    
    --document-version "\$DEFAULT"
    
    --document-version "\$LATEST"
    
    --document-version "3"
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotificationConfig
```
public void setNotificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications about command status changes on a per-instance basis.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications about command status changes on a per-instance basis.
  - getNotificationConfig
```
public NotificationConfig getNotificationConfig()
```
    Configurations for sending notifications about command status changes on a per-instance basis.
    
    Returns:
    
    Configurations for sending notifications about command status changes on a per-instance basis.
  - withNotificationConfig
```
public MaintenanceWindowRunCommandParameters withNotificationConfig(NotificationConfig notificationConfig)
```
    Configurations for sending notifications about command status changes on a per-instance basis.
    
    Parameters:
    
    notificationConfig - Configurations for sending notifications about command status changes on a per-instance basis.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3BucketName
```
public void setOutputS3BucketName(String outputS3BucketName)
```
    The name of the S3 bucket.
    
    Parameters:
    
    outputS3BucketName - The name of the S3 bucket.
  - getOutputS3BucketName
```
public String getOutputS3BucketName()
```
    The name of the S3 bucket.
    
    Returns:
    
    The name of the S3 bucket.
  - withOutputS3BucketName
```
public MaintenanceWindowRunCommandParameters withOutputS3BucketName(String outputS3BucketName)
```
    The name of the S3 bucket.
    
    Parameters:
    
    outputS3BucketName - The name of the S3 bucket.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputS3KeyPrefix
```
public void setOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The S3 bucket subfolder.
    
    Parameters:
    
    outputS3KeyPrefix - The S3 bucket subfolder.
  - getOutputS3KeyPrefix
```
public String getOutputS3KeyPrefix()
```
    The S3 bucket subfolder.
    
    Returns:
    
    The S3 bucket subfolder.
  - withOutputS3KeyPrefix
```
public MaintenanceWindowRunCommandParameters withOutputS3KeyPrefix(String outputS3KeyPrefix)
```
    The S3 bucket subfolder.
    
    Parameters:
    
    outputS3KeyPrefix - The S3 bucket subfolder.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,List<String>> getParameters()
```
    The parameters for the RUN_COMMAND task execution.
    
    Returns:
    
    The parameters for the RUN_COMMAND task execution.
  - setParameters
```
public void setParameters(Map<String,List<String>> parameters)
```
    The parameters for the RUN_COMMAND task execution.
    
    Parameters:
    
    parameters - The parameters for the RUN_COMMAND task execution.
  - withParameters
```
public MaintenanceWindowRunCommandParameters withParameters(Map<String,List<String>> parameters)
```
    The parameters for the RUN_COMMAND task execution.
    
    Parameters:
    
    parameters - The parameters for the RUN_COMMAND task execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public MaintenanceWindowRunCommandParameters 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 MaintenanceWindowRunCommandParameters clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setServiceRoleArn
```
public void setServiceRoleArn(String serviceRoleArn)
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Parameters:
    
    serviceRoleArn - The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
  - getServiceRoleArn
```
public String getServiceRoleArn()
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Returns:
    
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
  - withServiceRoleArn
```
public MaintenanceWindowRunCommandParameters withServiceRoleArn(String serviceRoleArn)
```
    The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Parameters:
    
    serviceRoleArn - The ARN of the IAM service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimeoutSeconds
```
public void setTimeoutSeconds(Integer timeoutSeconds)
```
    If this time is reached and the command has not already started running, it doesn't run.
    
    Parameters:
    
    timeoutSeconds - If this time is reached and the command has not already started running, it doesn't run.
  - getTimeoutSeconds
```
public Integer getTimeoutSeconds()
```
    If this time is reached and the command has not already started running, it doesn't run.
    
    Returns:
    
    If this time is reached and the command has not already started running, it doesn't run.
  - withTimeoutSeconds
```
public MaintenanceWindowRunCommandParameters withTimeoutSeconds(Integer timeoutSeconds)
```
    If this time is reached and the command has not already started running, it doesn't run.
    
    Parameters:
    
    timeoutSeconds - If this time is reached and the command has not already started running, it doesn't run.
    
    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 MaintenanceWindowRunCommandParameters 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.

Did this page help you?

Class MaintenanceWindowRunCommandParameters

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MaintenanceWindowRunCommandParameters

Method Detail

setComment

getComment

withComment

setCloudWatchOutputConfig

getCloudWatchOutputConfig

withCloudWatchOutputConfig

setDocumentHash

getDocumentHash

withDocumentHash

setDocumentHashType

getDocumentHashType

withDocumentHashType

withDocumentHashType

setDocumentVersion

getDocumentVersion

withDocumentVersion

setNotificationConfig

getNotificationConfig

withNotificationConfig

setOutputS3BucketName

getOutputS3BucketName

withOutputS3BucketName

setOutputS3KeyPrefix

getOutputS3KeyPrefix

withOutputS3KeyPrefix

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

setServiceRoleArn

getServiceRoleArn

withServiceRoleArn

setTimeoutSeconds

getTimeoutSeconds

withTimeoutSeconds

toString

equals

hashCode

clone

marshall