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 the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters 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 the Parameters option in the TaskInvocationParameters 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 for TaskParameters and LoggingInfo only if no values are specified for TaskInvocationParameters.

See Also:

  • Method Details

    • 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 return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().

      Returns:
      SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
      See Also:

    • 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 return DocumentHashType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from documentHashTypeAsString().

      Returns:
      SHA-256 or SHA-1. SHA-1 hashes have been deprecated.
      See Also:

    • 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 the isEmpty() 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 IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

      Returns:
      The Amazon Resource Name (ARN) of the IAM service role for Amazon Web Services Systems Manager to assume when running a maintenance window task. If you do not specify a service role ARN, Systems Manager uses a service-linked role in your account. If no appropriate service-linked role for Systems Manager exists in your account, it is created when you run RegisterTaskWithMaintenanceWindow.

      However, for an improved security posture, we strongly recommend creating a custom policy and custom service role for running your maintenance window tasks. The policy can be crafted to provide only the permissions needed for your particular maintenance window tasks. For more information, see Setting up Maintenance Windows in the in the Amazon Web Services Systems Manager User Guide.

    • 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()
      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<MaintenanceWindowRunCommandParameters.Builder,MaintenanceWindowRunCommandParameters>
      Returns:
      a builder for type T

    • builder

      public static MaintenanceWindowRunCommandParameters.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MaintenanceWindowRunCommandParameters.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.