Package software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Jsii$Proxy
Enclosing class:
CfnMaintenanceWindowTask
@Stability(Stable) public static interface CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty extends software.amazon.jsii.JsiiSerializable
The MaintenanceWindowRunCommandParameters property type specifies the parameters for a RUN_COMMAND task type for a maintenance window task in AWS Systems Manager .

This means that these parameters are the same as those for the SendCommand API call. For more information about SendCommand parameters, see SendCommand in the AWS Systems Manager API Reference .

For information about available parameters in SSM Command documents, you can view the content of the document itself in the Systems Manager console. For information, see Viewing SSM command document content in the AWS Systems Manager User Guide .

MaintenanceWindowRunCommandParameters is a property of the TaskInvocationParameters property type.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 Object parameters;
 MaintenanceWindowRunCommandParametersProperty maintenanceWindowRunCommandParametersProperty = MaintenanceWindowRunCommandParametersProperty.builder()
         .cloudWatchOutputConfig(CloudWatchOutputConfigProperty.builder()
                 .cloudWatchLogGroupName("cloudWatchLogGroupName")
                 .cloudWatchOutputEnabled(false)
                 .build())
         .comment("comment")
         .documentHash("documentHash")
         .documentHashType("documentHashType")
         .documentVersion("documentVersion")
         .notificationConfig(NotificationConfigProperty.builder()
                 .notificationArn("notificationArn")
                 // the properties below are optional
                 .notificationEvents(List.of("notificationEvents"))
                 .notificationType("notificationType")
                 .build())
         .outputS3BucketName("outputS3BucketName")
         .outputS3KeyPrefix("outputS3KeyPrefix")
         .parameters(parameters)
         .serviceRoleArn("serviceRoleArn")
         .timeoutSeconds(123)
         .build();

  • Method Details

    • getCloudWatchOutputConfig

      @Stability(Stable) @Nullable default Object getCloudWatchOutputConfig()
      Configuration options for sending command output to Amazon CloudWatch Logs.

    • getComment

      @Stability(Stable) @Nullable default String getComment()
      Information about the command or commands to run.

    • getDocumentHash

      @Stability(Stable) @Nullable default String getDocumentHash()
      The SHA-256 or SHA-1 hash created by the system when the document was created.

      SHA-1 hashes have been deprecated.

    • getDocumentHashType

      @Stability(Stable) @Nullable default String getDocumentHashType()
      The SHA-256 or SHA-1 hash type.

      SHA-1 hashes are deprecated.

    • getDocumentVersion

      @Stability(Stable) @Nullable default String getDocumentVersion()
      The AWS 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 AWS 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"

    • getNotificationConfig

      @Stability(Stable) @Nullable default Object getNotificationConfig()
      Configurations for sending notifications about command status changes on a per-managed node basis.

    • getOutputS3BucketName

      @Stability(Stable) @Nullable default String getOutputS3BucketName()
      The name of the Amazon Simple Storage Service (Amazon S3) bucket.

    • getOutputS3KeyPrefix

      @Stability(Stable) @Nullable default String getOutputS3KeyPrefix()
      The S3 bucket subfolder.

    • getParameters

      @Stability(Stable) @Nullable default Object getParameters()
      The parameters for the RUN_COMMAND task execution.

      The supported parameters are the same as those for the SendCommand API call. For more information, see SendCommand in the AWS Systems Manager API Reference .

    • getServiceRoleArn

      @Stability(Stable) @Nullable default String getServiceRoleArn()
      The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for maintenance window Run Command tasks.

    • getTimeoutSeconds

      @Stability(Stable) @Nullable default Number getTimeoutSeconds()
      If this time is reached and the command hasn't already started running, it doesn't run.

    • builder

      @Stability(Stable) static CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder builder()
      Returns:
      a CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty.Builder of CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty