software.amazon.awssdk.services.ssm.model

Interface MaintenanceWindowRunCommandParameters.Builder

All Superinterfaces:

Buildable, CopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>, SdkBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>, SdkPojo

Enclosing class:

MaintenanceWindowRunCommandParameters

public static interface MaintenanceWindowRunCommandParameters.Builder
extends SdkPojo, CopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>

Method Summary

Modifier and Type	Method and Description
MaintenanceWindowRunCommandParameters.Builder	cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig) Sets the value of the CloudWatchOutputConfig property for this object.
default MaintenanceWindowRunCommandParameters.Builder	cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Sets the value of the CloudWatchOutputConfig property for this object.
MaintenanceWindowRunCommandParameters.Builder	comment(String comment) Information about the commands to run.
MaintenanceWindowRunCommandParameters.Builder	documentHash(String documentHash) The SHA-256 or SHA-1 hash created by the system when the document was created.
MaintenanceWindowRunCommandParameters.Builder	documentHashType(DocumentHashType documentHashType) SHA-256 or SHA-1.
MaintenanceWindowRunCommandParameters.Builder	documentHashType(String documentHashType) SHA-256 or SHA-1.
MaintenanceWindowRunCommandParameters.Builder	documentVersion(String documentVersion) The SSM document version to use in the request.
default MaintenanceWindowRunCommandParameters.Builder	notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications about command status changes on a per-instance basis.
MaintenanceWindowRunCommandParameters.Builder	notificationConfig(NotificationConfig notificationConfig) Configurations for sending notifications about command status changes on a per-instance basis.
MaintenanceWindowRunCommandParameters.Builder	outputS3BucketName(String outputS3BucketName) The name of the S3 bucket.
MaintenanceWindowRunCommandParameters.Builder	outputS3KeyPrefix(String outputS3KeyPrefix) The S3 bucket subfolder.
MaintenanceWindowRunCommandParameters.Builder	parameters(Map<String,? extends Collection<String>> parameters) The parameters for the RUN_COMMAND task execution.
MaintenanceWindowRunCommandParameters.Builder	serviceRoleArn(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.Builder	timeoutSeconds(Integer timeoutSeconds) If this time is reached and the command has not already started running, it doesn't run.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

comment

MaintenanceWindowRunCommandParameters.Builder comment(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.

cloudWatchOutputConfig

MaintenanceWindowRunCommandParameters.Builder cloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)

Sets the value of the CloudWatchOutputConfig property for this object.

Parameters:

cloudWatchOutputConfig - The new value for the CloudWatchOutputConfig property for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchOutputConfig

default MaintenanceWindowRunCommandParameters.Builder cloudWatchOutputConfig(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig)

Sets the value of the CloudWatchOutputConfig property for this object. This is a convenience that creates an instance of the CloudWatchOutputConfig.Builder avoiding the need to create one manually via CloudWatchOutputConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchOutputConfig(CloudWatchOutputConfig).

Parameters:

cloudWatchOutputConfig - a consumer that will call methods on CloudWatchOutputConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

cloudWatchOutputConfig(CloudWatchOutputConfig)

documentHash

MaintenanceWindowRunCommandParameters.Builder documentHash(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.

documentHashType

MaintenanceWindowRunCommandParameters.Builder documentHashType(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, DocumentHashType

documentHashType

MaintenanceWindowRunCommandParameters.Builder documentHashType(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, DocumentHashType

documentVersion

MaintenanceWindowRunCommandParameters.Builder documentVersion(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.

notificationConfig

MaintenanceWindowRunCommandParameters.Builder notificationConfig(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.

notificationConfig

default MaintenanceWindowRunCommandParameters.Builder notificationConfig(Consumer<NotificationConfig.Builder> notificationConfig)

Configurations for sending notifications about command status changes on a per-instance basis.

This is a convenience that creates an instance of the NotificationConfig.Builder avoiding the need to create one manually via NotificationConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to notificationConfig(NotificationConfig).

Parameters:

notificationConfig - a consumer that will call methods on NotificationConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

notificationConfig(NotificationConfig)

outputS3BucketName

MaintenanceWindowRunCommandParameters.Builder outputS3BucketName(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.

outputS3KeyPrefix

MaintenanceWindowRunCommandParameters.Builder outputS3KeyPrefix(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.

parameters

MaintenanceWindowRunCommandParameters.Builder parameters(Map<String,? extends Collection<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.

serviceRoleArn

MaintenanceWindowRunCommandParameters.Builder serviceRoleArn(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.

timeoutSeconds

MaintenanceWindowRunCommandParameters.Builder timeoutSeconds(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.