software.amazon.awssdk.services.ssm.model

Class MaintenanceWindowRunCommandParameters

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

Method Summary

Modifier and Type	Method and Description
static MaintenanceWindowRunCommandParameters.Builder	builder()
String	comment() Information about the command(s) to execute.
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.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
NotificationConfig	notificationConfig() Configurations for sending notifications about command status changes on a per-instance basis.
String	outputS3BucketName() The name of the Amazon S3 bucket.
String	outputS3KeyPrefix() The Amazon 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 IAM service role to assume during task execution.
Integer	timeoutSeconds() If this time is reached and the command has not already started executing, it doesn't run.
MaintenanceWindowRunCommandParameters.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

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 command(s) to execute.

Returns:

Information about the command(s) to execute.

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

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 Amazon S3 bucket.

Returns:

The name of the Amazon S3 bucket.

outputS3KeyPrefix

public String outputS3KeyPrefix()

The Amazon S3 bucket subfolder.

Returns:

The Amazon S3 bucket subfolder.

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.

Returns:

The parameters for the RUN_COMMAND task execution.

serviceRoleArn

public String serviceRoleArn()

The IAM service role to assume during task execution.

Returns:

The IAM service role to assume during task execution.

timeoutSeconds

public Integer timeoutSeconds()

If this time is reached and the command has not already started executing, it doesn't run.

Returns:

If this time is reached and the command has not already started executing, it doesn't run.

toBuilder

public MaintenanceWindowRunCommandParameters.Builder 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 interface ToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>

Returns:

a builder for type T

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

toString

public String toString()

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.