/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes a command request. *
* * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class Command implements Serializable, Cloneable, StructuredPojo { /** ** A unique identifier for this command. *
*/ private String commandId; /** ** The name of the document requested for execution. *
*/ private String documentName; /** ** The Systems Manager document (SSM document) version. *
*/ private String documentVersion; /** ** User-specified information about the command, such as a brief description of what the command should do. *
*/ private String comment; /** *
* If a command expires, it changes status to DeliveryTimedOut
for all invocations that have the status
* InProgress
, Pending
, or Delayed
. ExpiresAfter
is calculated
* based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*
* The parameter values to be inserted in the document when running the command. *
*/ private java.util.Map* The managed node IDs against which this command was requested. *
*/ private com.amazonaws.internal.SdkInternalList* An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is * required if you don't provide one or more managed node IDs in the call. *
*/ private com.amazonaws.internal.SdkInternalList* The date and time the command was requested. *
*/ private java.util.Date requestedDateTime; /** ** The status of the command. *
*/ private String status; /** *
* A detailed status of the command execution. StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these statuses, see
* Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of
* the following values:
*
* Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all * managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This * is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. * This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of * Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries * again. *
** (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. *
*/ private String outputS3Region; /** ** The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the * command. *
*/ private String outputS3BucketName; /** ** The S3 directory path inside the bucket where the responses to the command executions should be stored. This was * requested when issuing the command. *
*/ private String outputS3KeyPrefix; /** *
* The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a
* number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more
* information about how to use MaxConcurrency
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
* The maximum number of errors allowed before the system stops sending the command to additional targets. You can
* specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is
* 0
. For more information about how to use MaxErrors
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
* The number of targets for the command. *
*/ private Integer targetCount; /** ** The number of targets for which the command invocation reached a terminal state. Terminal states include the * following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. *
*/ private Integer completedCount; /** ** The number of targets for which the status is Failed or Execution Timed Out. *
*/ private Integer errorCount; /** ** The number of targets for which the status is Delivery Timed Out. *
*/ private Integer deliveryTimedOutCount; /** ** The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services * Systems Manager, uses to act on your behalf when sending notifications about command status changes. *
*/ private String serviceRole; /** ** Configurations for sending notifications about command status changes. *
*/ private NotificationConfig notificationConfig; /** ** Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output. *
*/ private CloudWatchOutputConfig cloudWatchOutputConfig; /** *
* The TimeoutSeconds
value specified for a command.
*
* The details for the CloudWatch alarm applied to your command. *
*/ private AlarmConfiguration alarmConfiguration; /** ** The CloudWatch alarm that was invoked by the command. *
*/ private com.amazonaws.internal.SdkInternalList* A unique identifier for this command. *
* * @param commandId * A unique identifier for this command. */ public void setCommandId(String commandId) { this.commandId = commandId; } /** ** A unique identifier for this command. *
* * @return A unique identifier for this command. */ public String getCommandId() { return this.commandId; } /** ** A unique identifier for this command. *
* * @param commandId * A unique identifier for this command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withCommandId(String commandId) { setCommandId(commandId); return this; } /** ** The name of the document requested for execution. *
* * @param documentName * The name of the document requested for execution. */ public void setDocumentName(String documentName) { this.documentName = documentName; } /** ** The name of the document requested for execution. *
* * @return The name of the document requested for execution. */ public String getDocumentName() { return this.documentName; } /** ** The name of the document requested for execution. *
* * @param documentName * The name of the document requested for execution. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withDocumentName(String documentName) { setDocumentName(documentName); return this; } /** ** The Systems Manager document (SSM document) version. *
* * @param documentVersion * The Systems Manager document (SSM document) version. */ public void setDocumentVersion(String documentVersion) { this.documentVersion = documentVersion; } /** ** The Systems Manager document (SSM document) version. *
* * @return The Systems Manager document (SSM document) version. */ public String getDocumentVersion() { return this.documentVersion; } /** ** The Systems Manager document (SSM document) version. *
* * @param documentVersion * The Systems Manager document (SSM document) version. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withDocumentVersion(String documentVersion) { setDocumentVersion(documentVersion); return this; } /** ** User-specified information about the command, such as a brief description of what the command should do. *
* * @param comment * User-specified information about the command, such as a brief description of what the command should do. */ public void setComment(String comment) { this.comment = comment; } /** ** User-specified information about the command, such as a brief description of what the command should do. *
* * @return User-specified information about the command, such as a brief description of what the command should do. */ public String getComment() { return this.comment; } /** ** User-specified information about the command, such as a brief description of what the command should do. *
* * @param comment * User-specified information about the command, such as a brief description of what the command should do. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withComment(String comment) { setComment(comment); return this; } /** *
* If a command expires, it changes status to DeliveryTimedOut
for all invocations that have the status
* InProgress
, Pending
, or Delayed
. ExpiresAfter
is calculated
* based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*
DeliveryTimedOut
for all invocations that have the
* status InProgress
, Pending
, or Delayed
. ExpiresAfter
* is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*/
public void setExpiresAfter(java.util.Date expiresAfter) {
this.expiresAfter = expiresAfter;
}
/**
*
* If a command expires, it changes status to DeliveryTimedOut
for all invocations that have the status
* InProgress
, Pending
, or Delayed
. ExpiresAfter
is calculated
* based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*
DeliveryTimedOut
for all invocations that have
* the status InProgress
, Pending
, or Delayed
.
* ExpiresAfter
is calculated based on the total timeout for the overall command. For more
* information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*/
public java.util.Date getExpiresAfter() {
return this.expiresAfter;
}
/**
*
* If a command expires, it changes status to DeliveryTimedOut
for all invocations that have the status
* InProgress
, Pending
, or Delayed
. ExpiresAfter
is calculated
* based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
*
DeliveryTimedOut
for all invocations that have the
* status InProgress
, Pending
, or Delayed
. ExpiresAfter
* is calculated based on the total timeout for the overall command. For more information, see Understanding command timeout values in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Command withExpiresAfter(java.util.Date expiresAfter) {
setExpiresAfter(expiresAfter);
return this;
}
/**
* * The parameter values to be inserted in the document when running the command. *
* * @return The parameter values to be inserted in the document when running the command. */ public java.util.Map* The parameter values to be inserted in the document when running the command. *
* * @param parameters * The parameter values to be inserted in the document when running the command. */ public void setParameters(java.util.Map* The parameter values to be inserted in the document when running the command. *
* * @param parameters * The parameter values to be inserted in the document when running the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withParameters(java.util.Map* The managed node IDs against which this command was requested. *
* * @return The managed node IDs against which this command was requested. */ public java.util.List* The managed node IDs against which this command was requested. *
* * @param instanceIds * The managed node IDs against which this command was requested. */ public void setInstanceIds(java.util.Collection* The managed node IDs against which this command was requested. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setInstanceIds(java.util.Collection)} or {@link #withInstanceIds(java.util.Collection)} if you want to * override the existing values. *
* * @param instanceIds * The managed node IDs against which this command was requested. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withInstanceIds(String... instanceIds) { if (this.instanceIds == null) { setInstanceIds(new com.amazonaws.internal.SdkInternalList* The managed node IDs against which this command was requested. *
* * @param instanceIds * The managed node IDs against which this command was requested. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withInstanceIds(java.util.Collection* An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is * required if you don't provide one or more managed node IDs in the call. *
* * @return An array of search criteria that targets managed nodes using a Key,Value combination that you specify. * Targets is required if you don't provide one or more managed node IDs in the call. */ public java.util.List* An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is * required if you don't provide one or more managed node IDs in the call. *
* * @param targets * An array of search criteria that targets managed nodes using a Key,Value combination that you specify. * Targets is required if you don't provide one or more managed node IDs in the call. */ public void setTargets(java.util.Collection* An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is * required if you don't provide one or more managed node IDs in the call. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTargets(java.util.Collection)} or {@link #withTargets(java.util.Collection)} if you want to override * the existing values. *
* * @param targets * An array of search criteria that targets managed nodes using a Key,Value combination that you specify. * Targets is required if you don't provide one or more managed node IDs in the call. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withTargets(Target... targets) { if (this.targets == null) { setTargets(new com.amazonaws.internal.SdkInternalList* An array of search criteria that targets managed nodes using a Key,Value combination that you specify. Targets is * required if you don't provide one or more managed node IDs in the call. *
* * @param targets * An array of search criteria that targets managed nodes using a Key,Value combination that you specify. * Targets is required if you don't provide one or more managed node IDs in the call. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withTargets(java.util.Collection* The date and time the command was requested. *
* * @param requestedDateTime * The date and time the command was requested. */ public void setRequestedDateTime(java.util.Date requestedDateTime) { this.requestedDateTime = requestedDateTime; } /** ** The date and time the command was requested. *
* * @return The date and time the command was requested. */ public java.util.Date getRequestedDateTime() { return this.requestedDateTime; } /** ** The date and time the command was requested. *
* * @param requestedDateTime * The date and time the command was requested. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withRequestedDateTime(java.util.Date requestedDateTime) { setRequestedDateTime(requestedDateTime); return this; } /** ** The status of the command. *
* * @param status * The status of the command. * @see CommandStatus */ public void setStatus(String status) { this.status = status; } /** ** The status of the command. *
* * @return The status of the command. * @see CommandStatus */ public String getStatus() { return this.status; } /** ** The status of the command. *
* * @param status * The status of the command. * @return Returns a reference to this object so that method calls can be chained together. * @see CommandStatus */ public Command withStatus(String status) { setStatus(status); return this; } /** ** The status of the command. *
* * @param status * The status of the command. * @see CommandStatus */ public void setStatus(CommandStatus status) { withStatus(status); } /** ** The status of the command. *
* * @param status * The status of the command. * @return Returns a reference to this object so that method calls can be chained together. * @see CommandStatus */ public Command withStatus(CommandStatus status) { this.status = status.toString(); return this; } /** *
* A detailed status of the command execution. StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these statuses, see
* Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of
* the following values:
*
* Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all * managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This * is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. * This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of * Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries * again. *
*StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these
* statuses, see Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be
* one of the following values:
* * Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on * all managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed * Out. This is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed * Out. This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal * state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a * value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal * state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system * retries again. *
*
* A detailed status of the command execution. StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these statuses, see
* Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of
* the following values:
*
* Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all * managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This * is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. * This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of * Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries * again. *
*StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these
* statuses, see Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be
* one of the following values:
* * Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on * all managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed * Out. This is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed * Out. This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal * state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a * value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a * terminal state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system * retries again. *
*
* A detailed status of the command execution. StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these statuses, see
* Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of
* the following values:
*
* Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on all * managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This * is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. * This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a value of * Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system retries * again. *
*StatusDetails
includes more information than
* Status
because it includes states resulting from error and concurrency control parameters.
* StatusDetails
can show different results than Status. For more information about these
* statuses, see Understanding
* command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be
* one of the following values:
* * Pending: The command hasn't been sent to any managed nodes. *
** In Progress: The command has been sent to at least one managed node but hasn't reached a final state on * all managed nodes. *
** Success: The command successfully ran on all invocations. This is a terminal state. *
** Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed * Out. This is a terminal state. *
** Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed * Out. This is a terminal state. *
** Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal * state. *
** Incomplete: The command was attempted on all managed nodes and one or more invocations doesn't have a * value of Success but not enough invocations failed for the status to be Failed. This is a terminal state. *
** Cancelled: The command was terminated before it was completed. This is a terminal state. *
** Rate Exceeded: The number of managed nodes targeted by the command exceeded the account limit for pending * invocations. The system has canceled the command before running it on any managed node. This is a terminal * state. *
** Delayed: The system attempted to send the command to the managed node but wasn't successful. The system * retries again. *
** (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. *
* * @param outputS3Region * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. */ public void setOutputS3Region(String outputS3Region) { this.outputS3Region = outputS3Region; } /** ** (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. *
* * @return (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. */ public String getOutputS3Region() { return this.outputS3Region; } /** ** (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. *
* * @param outputS3Region * (Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager * automatically determines the Amazon Web Services Region of the S3 bucket. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withOutputS3Region(String outputS3Region) { setOutputS3Region(outputS3Region); return this; } /** ** The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the * command. *
* * @param outputS3BucketName * The S3 bucket where the responses to the command executions should be stored. This was requested when * issuing the command. */ public void setOutputS3BucketName(String outputS3BucketName) { this.outputS3BucketName = outputS3BucketName; } /** ** The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the * command. *
* * @return The S3 bucket where the responses to the command executions should be stored. This was requested when * issuing the command. */ public String getOutputS3BucketName() { return this.outputS3BucketName; } /** ** The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the * command. *
* * @param outputS3BucketName * The S3 bucket where the responses to the command executions should be stored. This was requested when * issuing the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withOutputS3BucketName(String outputS3BucketName) { setOutputS3BucketName(outputS3BucketName); return this; } /** ** The S3 directory path inside the bucket where the responses to the command executions should be stored. This was * requested when issuing the command. *
* * @param outputS3KeyPrefix * The S3 directory path inside the bucket where the responses to the command executions should be stored. * This was requested when issuing the command. */ public void setOutputS3KeyPrefix(String outputS3KeyPrefix) { this.outputS3KeyPrefix = outputS3KeyPrefix; } /** ** The S3 directory path inside the bucket where the responses to the command executions should be stored. This was * requested when issuing the command. *
* * @return The S3 directory path inside the bucket where the responses to the command executions should be stored. * This was requested when issuing the command. */ public String getOutputS3KeyPrefix() { return this.outputS3KeyPrefix; } /** ** The S3 directory path inside the bucket where the responses to the command executions should be stored. This was * requested when issuing the command. *
* * @param outputS3KeyPrefix * The S3 directory path inside the bucket where the responses to the command executions should be stored. * This was requested when issuing the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withOutputS3KeyPrefix(String outputS3KeyPrefix) { setOutputS3KeyPrefix(outputS3KeyPrefix); return this; } /** *
* The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a
* number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more
* information about how to use MaxConcurrency
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
MaxConcurrency
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*/
public void setMaxConcurrency(String maxConcurrency) {
this.maxConcurrency = maxConcurrency;
}
/**
*
* The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a
* number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more
* information about how to use MaxConcurrency
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
MaxConcurrency
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*/
public String getMaxConcurrency() {
return this.maxConcurrency;
}
/**
*
* The maximum number of managed nodes that are allowed to run the command at the same time. You can specify a
* number of managed nodes, such as 10, or a percentage of nodes, such as 10%. The default value is 50. For more
* information about how to use MaxConcurrency
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
MaxConcurrency
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Command withMaxConcurrency(String maxConcurrency) {
setMaxConcurrency(maxConcurrency);
return this;
}
/**
*
* The maximum number of errors allowed before the system stops sending the command to additional targets. You can
* specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is
* 0
. For more information about how to use MaxErrors
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
0
. For more information about how to use MaxErrors
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*/
public void setMaxErrors(String maxErrors) {
this.maxErrors = maxErrors;
}
/**
*
* The maximum number of errors allowed before the system stops sending the command to additional targets. You can
* specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is
* 0
. For more information about how to use MaxErrors
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
0
. For more information about how to use MaxErrors
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*/
public String getMaxErrors() {
return this.maxErrors;
}
/**
*
* The maximum number of errors allowed before the system stops sending the command to additional targets. You can
* specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is
* 0
. For more information about how to use MaxErrors
, see Running commands using
* Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
*
0
. For more information about how to use MaxErrors
, see Running commands
* using Systems Manager Run Command in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Command withMaxErrors(String maxErrors) {
setMaxErrors(maxErrors);
return this;
}
/**
* * The number of targets for the command. *
* * @param targetCount * The number of targets for the command. */ public void setTargetCount(Integer targetCount) { this.targetCount = targetCount; } /** ** The number of targets for the command. *
* * @return The number of targets for the command. */ public Integer getTargetCount() { return this.targetCount; } /** ** The number of targets for the command. *
* * @param targetCount * The number of targets for the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withTargetCount(Integer targetCount) { setTargetCount(targetCount); return this; } /** ** The number of targets for which the command invocation reached a terminal state. Terminal states include the * following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. *
* * @param completedCount * The number of targets for which the command invocation reached a terminal state. Terminal states include * the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or * Undeliverable. */ public void setCompletedCount(Integer completedCount) { this.completedCount = completedCount; } /** ** The number of targets for which the command invocation reached a terminal state. Terminal states include the * following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. *
* * @return The number of targets for which the command invocation reached a terminal state. Terminal states include * the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or * Undeliverable. */ public Integer getCompletedCount() { return this.completedCount; } /** ** The number of targets for which the command invocation reached a terminal state. Terminal states include the * following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or Undeliverable. *
* * @param completedCount * The number of targets for which the command invocation reached a terminal state. Terminal states include * the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Cancelled, Terminated, or * Undeliverable. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withCompletedCount(Integer completedCount) { setCompletedCount(completedCount); return this; } /** ** The number of targets for which the status is Failed or Execution Timed Out. *
* * @param errorCount * The number of targets for which the status is Failed or Execution Timed Out. */ public void setErrorCount(Integer errorCount) { this.errorCount = errorCount; } /** ** The number of targets for which the status is Failed or Execution Timed Out. *
* * @return The number of targets for which the status is Failed or Execution Timed Out. */ public Integer getErrorCount() { return this.errorCount; } /** ** The number of targets for which the status is Failed or Execution Timed Out. *
* * @param errorCount * The number of targets for which the status is Failed or Execution Timed Out. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withErrorCount(Integer errorCount) { setErrorCount(errorCount); return this; } /** ** The number of targets for which the status is Delivery Timed Out. *
* * @param deliveryTimedOutCount * The number of targets for which the status is Delivery Timed Out. */ public void setDeliveryTimedOutCount(Integer deliveryTimedOutCount) { this.deliveryTimedOutCount = deliveryTimedOutCount; } /** ** The number of targets for which the status is Delivery Timed Out. *
* * @return The number of targets for which the status is Delivery Timed Out. */ public Integer getDeliveryTimedOutCount() { return this.deliveryTimedOutCount; } /** ** The number of targets for which the status is Delivery Timed Out. *
* * @param deliveryTimedOutCount * The number of targets for which the status is Delivery Timed Out. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withDeliveryTimedOutCount(Integer deliveryTimedOutCount) { setDeliveryTimedOutCount(deliveryTimedOutCount); return this; } /** ** The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services * Systems Manager, uses to act on your behalf when sending notifications about command status changes. *
* * @param serviceRole * The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web * Services Systems Manager, uses to act on your behalf when sending notifications about command status * changes. */ public void setServiceRole(String serviceRole) { this.serviceRole = serviceRole; } /** ** The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services * Systems Manager, uses to act on your behalf when sending notifications about command status changes. *
* * @return The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web * Services Systems Manager, uses to act on your behalf when sending notifications about command status * changes. */ public String getServiceRole() { return this.serviceRole; } /** ** The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services * Systems Manager, uses to act on your behalf when sending notifications about command status changes. *
* * @param serviceRole * The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web * Services Systems Manager, uses to act on your behalf when sending notifications about command status * changes. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withServiceRole(String serviceRole) { setServiceRole(serviceRole); return this; } /** ** Configurations for sending notifications about command status changes. *
* * @param notificationConfig * Configurations for sending notifications about command status changes. */ public void setNotificationConfig(NotificationConfig notificationConfig) { this.notificationConfig = notificationConfig; } /** ** Configurations for sending notifications about command status changes. *
* * @return Configurations for sending notifications about command status changes. */ public NotificationConfig getNotificationConfig() { return this.notificationConfig; } /** ** Configurations for sending notifications about command status changes. *
* * @param notificationConfig * Configurations for sending notifications about command status changes. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withNotificationConfig(NotificationConfig notificationConfig) { setNotificationConfig(notificationConfig); return this; } /** ** Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output. *
* * @param cloudWatchOutputConfig * Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command * output. */ public void setCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig) { this.cloudWatchOutputConfig = cloudWatchOutputConfig; } /** ** Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output. *
* * @return Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command * output. */ public CloudWatchOutputConfig getCloudWatchOutputConfig() { return this.cloudWatchOutputConfig; } /** ** Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output. *
* * @param cloudWatchOutputConfig * Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command * output. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig) { setCloudWatchOutputConfig(cloudWatchOutputConfig); return this; } /** *
* The TimeoutSeconds
value specified for a command.
*
TimeoutSeconds
value specified for a command.
*/
public void setTimeoutSeconds(Integer timeoutSeconds) {
this.timeoutSeconds = timeoutSeconds;
}
/**
*
* The TimeoutSeconds
value specified for a command.
*
TimeoutSeconds
value specified for a command.
*/
public Integer getTimeoutSeconds() {
return this.timeoutSeconds;
}
/**
*
* The TimeoutSeconds
value specified for a command.
*
TimeoutSeconds
value specified for a command.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Command withTimeoutSeconds(Integer timeoutSeconds) {
setTimeoutSeconds(timeoutSeconds);
return this;
}
/**
* * The details for the CloudWatch alarm applied to your command. *
* * @param alarmConfiguration * The details for the CloudWatch alarm applied to your command. */ public void setAlarmConfiguration(AlarmConfiguration alarmConfiguration) { this.alarmConfiguration = alarmConfiguration; } /** ** The details for the CloudWatch alarm applied to your command. *
* * @return The details for the CloudWatch alarm applied to your command. */ public AlarmConfiguration getAlarmConfiguration() { return this.alarmConfiguration; } /** ** The details for the CloudWatch alarm applied to your command. *
* * @param alarmConfiguration * The details for the CloudWatch alarm applied to your command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withAlarmConfiguration(AlarmConfiguration alarmConfiguration) { setAlarmConfiguration(alarmConfiguration); return this; } /** ** The CloudWatch alarm that was invoked by the command. *
* * @return The CloudWatch alarm that was invoked by the command. */ public java.util.List* The CloudWatch alarm that was invoked by the command. *
* * @param triggeredAlarms * The CloudWatch alarm that was invoked by the command. */ public void setTriggeredAlarms(java.util.Collection* The CloudWatch alarm that was invoked by the command. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTriggeredAlarms(java.util.Collection)} or {@link #withTriggeredAlarms(java.util.Collection)} if you * want to override the existing values. *
* * @param triggeredAlarms * The CloudWatch alarm that was invoked by the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withTriggeredAlarms(AlarmStateInformation... triggeredAlarms) { if (this.triggeredAlarms == null) { setTriggeredAlarms(new com.amazonaws.internal.SdkInternalList* The CloudWatch alarm that was invoked by the command. *
* * @param triggeredAlarms * The CloudWatch alarm that was invoked by the command. * @return Returns a reference to this object so that method calls can be chained together. */ public Command withTriggeredAlarms(java.util.Collection