Package software.amazon.awssdk.services.ssm.model

Class SendCommandRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.ssm.model.SendCommandRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>

@Generated("software.amazon.awssdk:codegen")
public class SendCommandRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<SendCommandRequest.Builder,SendCommandRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendCommandRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static SendCommandRequest.Builder	builder()
String	comment()	User-specified information about the command, such as a brief description of what the command should do.
String	documentHash()	The Sha256 or Sha1 hash created by the system when the document was created.
String	documentHashType()	Sha256 or Sha1.
String	documentName()	Required.
boolean	equals(Object obj)
int	hashCode()
List<String>	instanceIds()	The instance IDs where the command should execute.
String	maxConcurrency()	(Optional) The maximum number of instances that are allowed to execute the command at the same time.
String	maxErrors()	The maximum number of errors allowed without the command failing.
NotificationConfig	notificationConfig()	Configurations for sending notifications.
String	outputS3BucketName()	The name of the S3 bucket where command execution responses should be stored.
String	outputS3KeyPrefix()	The directory structure within the S3 bucket where the responses should be stored.
String	outputS3Region()	(Deprecated) You can no longer specify this parameter.
Map<String,List<String>>	parameters()	The required and optional parameters specified in the document being executed.
static Class<? extends SendCommandRequest.Builder>	serializableBuilderClass()
String	serviceRoleArn()	The IAM role that Systems Manager uses to send notifications.
List<Target>	targets()	(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify.
Integer	timeoutSeconds()	If this time is reached and the command has not already started executing, it will not execute.
SendCommandRequest.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 software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

instanceIds

public List<String> instanceIds()

The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.

Returns:

The instance IDs where the command should execute. You can specify a maximum of 50 IDs. If you prefer not to list individual instance IDs, you can instead send commands to a fleet of instances using the Targets parameter, which accepts EC2 tags. For more information about how to use Targets, see Sending Commands to a Fleet.

targets

public List<Target> targets()

(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.

Returns:

(Optional) An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call. For more information about how to use Targets, see Sending Commands to a Fleet.

documentName

public String documentName()

Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

Returns:

Required. The name of the Systems Manager document to execute. This can be a public document or a custom document.

documentHash

public String documentHash()

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Returns:

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

documentHashType

public String documentHashType()

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Returns:

Sha256 or Sha1.

Sha1 hashes have been deprecated.

See Also:

DocumentHashType

timeoutSeconds

public Integer timeoutSeconds()

If this time is reached and the command has not already started executing, it will not execute.

Returns:

If this time is reached and the command has not already started executing, it will not execute.

comment

public String comment()

User-specified information about the command, such as a brief description of what the command should do.

Returns:

User-specified information about the command, such as a brief description of what the command should do.

parameters

public Map<String,List<String>> parameters()

The required and optional parameters specified in the document being executed.

Returns:

The required and optional parameters specified in the document being executed.

outputS3Region

public String outputS3Region()

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

Returns:

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon S3 bucket region.

outputS3BucketName

public String outputS3BucketName()

The name of the S3 bucket where command execution responses should be stored.

Returns:

The name of the S3 bucket where command execution responses should be stored.

outputS3KeyPrefix

public String outputS3KeyPrefix()

The directory structure within the S3 bucket where the responses should be stored.

Returns:

The directory structure within the S3 bucket where the responses should be stored.

maxConcurrency

public String maxConcurrency()

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.

Returns:

(Optional) The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls.

maxErrors

public String maxErrors()

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls.

Returns:

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls.

serviceRoleArn

public String serviceRoleArn()

The IAM role that Systems Manager uses to send notifications.

Returns:

The IAM role that Systems Manager uses to send notifications.

notificationConfig

public NotificationConfig notificationConfig()

Configurations for sending notifications.

Returns:

Configurations for sending notifications.

toBuilder

public SendCommandRequest.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<SendCommandRequest.Builder,SendCommandRequest>

Returns:

a builder for type T

builder

public static SendCommandRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SendCommandRequest.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