Class MaintenanceWindowRunCommandParameters
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.MaintenanceWindowRunCommandParameters
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
@Generated("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 Amazon Simple Storage Service (Amazon S3) bucket to contain logs, instead use theOutputS3BucketName
andOutputS3KeyPrefix
options in theTaskInvocationParameters
structure. For information about how Amazon Web Services 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 theParameters
option in theTaskInvocationParameters
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 forTaskParameters
andLoggingInfo
only if no values are specified forTaskInvocationParameters
.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
MaintenanceWindowRunCommandParameters.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static MaintenanceWindowRunCommandParameters.Builder
builder()
CloudWatchOutputConfig
cloudWatchOutputConfig()
Returns the value of the CloudWatchOutputConfig property for this object.String
comment()
Information about the commands to run.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.String
documentVersion()
The Amazon Web Services Systems Manager document (SSM document) version to use in the request.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.NotificationConfig
notificationConfig()
Configurations for sending notifications about command status changes on a per-managed node basis.String
outputS3BucketName()
The name of the Amazon Simple Storage Service (Amazon S3) bucket.String
outputS3KeyPrefix()
The S3 bucket subfolder.Map<String,List<String>>
parameters()
The parameters for theRUN_COMMAND
task execution.List<SdkField<?>>
sdkFields()
static Class<? extends MaintenanceWindowRunCommandParameters.Builder>
serializableBuilderClass()
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.Integer
timeoutSeconds()
If this time is reached and the command hasn't already started running, it doesn't run.MaintenanceWindowRunCommandParameters.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
comment
public final String comment()
Information about the commands to run.
- Returns:
- Information about the commands to run.
-
cloudWatchOutputConfig
public final CloudWatchOutputConfig cloudWatchOutputConfig()
Returns the value of the CloudWatchOutputConfig property for this object.- Returns:
- The value of the CloudWatchOutputConfig property for this object.
-
documentHash
public final 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 final 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 returnDocumentHashType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentHashTypeAsString()
.- Returns:
- SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
- See Also:
DocumentHashType
-
documentHashTypeAsString
public final 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 returnDocumentHashType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdocumentHashTypeAsString()
.- Returns:
- SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
- See Also:
DocumentHashType
-
documentVersion
public final String 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:
- 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"
-
notificationConfig
public final NotificationConfig notificationConfig()
Configurations for sending notifications about command status changes on a per-managed node basis.
- Returns:
- Configurations for sending notifications about command status changes on a per-managed node basis.
-
outputS3BucketName
public final String outputS3BucketName()
The name of the Amazon Simple Storage Service (Amazon S3) bucket.
- Returns:
- The name of the Amazon Simple Storage Service (Amazon S3) bucket.
-
outputS3KeyPrefix
public final String outputS3KeyPrefix()
The S3 bucket subfolder.
- Returns:
- The S3 bucket subfolder.
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
parameters
public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasParameters()
method.- Returns:
- The parameters for the
RUN_COMMAND
task execution.
-
serviceRoleArn
public final 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.
- Returns:
- 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
public final Integer timeoutSeconds()
If this time is reached and the command hasn't already started running, it doesn't run.
- Returns:
- If this time is reached and the command hasn't already started running, it doesn't run.
-
toBuilder
public MaintenanceWindowRunCommandParameters.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
-
builder
public static MaintenanceWindowRunCommandParameters.Builder builder()
-
serializableBuilderClass
public static Class<? extends MaintenanceWindowRunCommandParameters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-