MaintenanceWindowRunCommandParameters (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.15.40 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.MaintenanceWindowRunCommandParameters

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class MaintenanceWindowRunCommandParameters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
```
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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MaintenanceWindowRunCommandParameters.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MaintenanceWindowRunCommandParameters.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MaintenanceWindowRunCommandParameters.Builder`	`builder()`
`CloudWatchOutputConfig`	`cloudWatchOutputConfig()` Returns the value of the CloudWatchOutputConfig property for this object.
`String`	`comment()` Information about the commands to run.
`String`	`documentHash()` The SHA-256 or SHA-1 hash created by the system when the document was created.
`DocumentHashType`	`documentHashType()` SHA-256 or SHA-1.
`String`	`documentHashTypeAsString()` SHA-256 or SHA-1.
`String`	`documentVersion()` The SSM document version to use in the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasParameters()` Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`NotificationConfig`	`notificationConfig()` Configurations for sending notifications about command status changes on a per-instance basis.
`String`	`outputS3BucketName()` The name of the S3 bucket.
`String`	`outputS3KeyPrefix()` The S3 bucket subfolder.
`Map<String,List<String>>`	`parameters()` The parameters for the RUN_COMMAND task execution.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MaintenanceWindowRunCommandParameters.Builder>`	`serializableBuilderClass()`
`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.
`Integer`	`timeoutSeconds()` If this time is reached and the command has not already started running, it doesn't run.
`MaintenanceWindowRunCommandParameters.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
  - comment
```
public String comment()
```
    Information about the commands to run.
    
    Returns:
    
    Information about the commands to run.
  - cloudWatchOutputConfig
```
public CloudWatchOutputConfig cloudWatchOutputConfig()
```
    Returns the value of the CloudWatchOutputConfig property for this object.
    
    Returns:
    
    The value of the CloudWatchOutputConfig property for this object.
  - documentHash
```
public String documentHash()
```
    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.
  - documentHashType
```
public DocumentHashType documentHashType()
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, documentHashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().
    
    Returns:
    
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - documentHashTypeAsString
```
public String documentHashTypeAsString()
```
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    If the service returns an enum value that is not available in the current SDK version, documentHashType will return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().
    
    Returns:
    
    SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
    
    See Also:
    
    DocumentHashType
  - documentVersion
```
public 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"
    
    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"
  - notificationConfig
```
public NotificationConfig notificationConfig()
```
    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.
  - outputS3BucketName
```
public String outputS3BucketName()
```
    The name of the S3 bucket.
    
    Returns:
    
    The name of the S3 bucket.
  - outputS3KeyPrefix
```
public String outputS3KeyPrefix()
```
    The S3 bucket subfolder.
    
    Returns:
    
    The S3 bucket subfolder.
  - hasParameters
```
public boolean hasParameters()
```
    Returns true if the Parameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - parameters
```
public Map<String,List<String>> parameters()
```
    The parameters for the RUN_COMMAND task execution.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasParameters() to see if a value was sent in this field.
    
    Returns:
    
    The parameters for the RUN_COMMAND task execution.
  - serviceRoleArn
```
public 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.
    
    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.
  - timeoutSeconds
```
public Integer timeoutSeconds()
```
    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.
  - toBuilder
```
public MaintenanceWindowRunCommandParameters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
  - builder
```
public static MaintenanceWindowRunCommandParameters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MaintenanceWindowRunCommandParameters.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class MaintenanceWindowRunCommandParameters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

comment

cloudWatchOutputConfig

documentHash

documentHashType

documentHashTypeAsString

documentVersion

notificationConfig

outputS3BucketName

outputS3KeyPrefix

hasParameters

parameters

serviceRoleArn

timeoutSeconds

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields