Interface MaintenanceWindowRunCommandParameters.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,
,MaintenanceWindowRunCommandParameters> SdkBuilder<MaintenanceWindowRunCommandParameters.Builder,
,MaintenanceWindowRunCommandParameters> SdkPojo
- Enclosing class:
MaintenanceWindowRunCommandParameters
-
Method Summary
Modifier and TypeMethodDescriptioncloudWatchOutputConfig
(Consumer<CloudWatchOutputConfig.Builder> cloudWatchOutputConfig) Sets the value of the CloudWatchOutputConfig property for this object.cloudWatchOutputConfig
(CloudWatchOutputConfig cloudWatchOutputConfig) Sets the value of the CloudWatchOutputConfig property for this object.Information about the commands to run.documentHash
(String documentHash) The SHA-256 or SHA-1 hash created by the system when the document was created.documentHashType
(String documentHashType) SHA-256 or SHA-1.documentHashType
(DocumentHashType documentHashType) SHA-256 or SHA-1.documentVersion
(String documentVersion) The Amazon Web Services Systems Manager document (SSM document) version to use in the request.notificationConfig
(Consumer<NotificationConfig.Builder> notificationConfig) Configurations for sending notifications about command status changes on a per-managed node basis.notificationConfig
(NotificationConfig notificationConfig) Configurations for sending notifications about command status changes on a per-managed node basis.outputS3BucketName
(String outputS3BucketName) The name of the Amazon Simple Storage Service (Amazon S3) bucket.outputS3KeyPrefix
(String outputS3KeyPrefix) The S3 bucket subfolder.parameters
(Map<String, ? extends Collection<String>> parameters) The parameters for theRUN_COMMAND
task execution.serviceRoleArn
(String serviceRoleArn) The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.timeoutSeconds
(Integer timeoutSeconds) If this time is reached and the command hasn't already started running, it doesn't run.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 method that creates an instance of theCloudWatchOutputConfig.Builder
avoiding the need to create one manually viaCloudWatchOutputConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocloudWatchOutputConfig(CloudWatchOutputConfig)
.- Parameters:
cloudWatchOutputConfig
- a consumer that will call methods onCloudWatchOutputConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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:
-
documentVersion
The Amazon Web Services Systems Manager document (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 Amazon Web Services 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 Amazon Web Services Systems Manager document (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 Amazon Web Services 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-managed node basis.
- Parameters:
notificationConfig
- Configurations for sending notifications about command status changes on a per-managed node 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-managed node basis.
This is a convenience method that creates an instance of theNotificationConfig.Builder
avoiding the need to create one manually viaNotificationConfig.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonotificationConfig(NotificationConfig)
.- Parameters:
notificationConfig
- a consumer that will call methods onNotificationConfig.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
outputS3BucketName
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
- Parameters:
outputS3BucketName
- The name of the Amazon Simple Storage Service (Amazon S3) bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theRUN_COMMAND
task execution.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serviceRoleArn
The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.
- Parameters:
serviceRoleArn
- The Amazon Resource Name (ARN) of the Identity and Access Management (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
If this time is reached and the command hasn't already started running, it doesn't run.
- Parameters:
timeoutSeconds
- If this time is reached and the command hasn't already started running, it doesn't run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-