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

Interface MaintenanceWindowRunCommandParameters.Builder

    • Method Detail

      • comment

        MaintenanceWindowRunCommandParameters.Builder comment​(String comment)

        Information about the commands to run.

        Parameters:
        comment - Information about the commands to run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • cloudWatchOutputConfig

        MaintenanceWindowRunCommandParameters.Builder cloudWatchOutputConfig​(CloudWatchOutputConfig cloudWatchOutputConfig)
        Sets the value of the CloudWatchOutputConfig property for this object.
        Parameters:
        cloudWatchOutputConfig - The new value for the CloudWatchOutputConfig property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentHash

        MaintenanceWindowRunCommandParameters.Builder documentHash​(String documentHash)

        The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.

        Parameters:
        documentHash - The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • documentVersion

        MaintenanceWindowRunCommandParameters.Builder documentVersion​(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"

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • notificationConfig

        MaintenanceWindowRunCommandParameters.Builder notificationConfig​(NotificationConfig notificationConfig)

        Configurations for sending notifications about command status changes on a per-managed node basis.

        Parameters:
        notificationConfig - Configurations for sending notifications about command status changes on a per-managed node basis.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputS3BucketName

        MaintenanceWindowRunCommandParameters.Builder outputS3BucketName​(String outputS3BucketName)

        The name of the Amazon Simple Storage Service (Amazon S3) bucket.

        Parameters:
        outputS3BucketName - The name of the Amazon Simple Storage Service (Amazon S3) bucket.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • outputS3KeyPrefix

        MaintenanceWindowRunCommandParameters.Builder outputS3KeyPrefix​(String outputS3KeyPrefix)

        The S3 bucket subfolder.

        Parameters:
        outputS3KeyPrefix - The S3 bucket subfolder.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • serviceRoleArn

        MaintenanceWindowRunCommandParameters.Builder serviceRoleArn​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • timeoutSeconds

        MaintenanceWindowRunCommandParameters.Builder timeoutSeconds​(Integer timeoutSeconds)

        If this time is reached and the command hasn't already started running, it doesn't run.

        Parameters:
        timeoutSeconds - If this time is reached and the command hasn't already started running, it doesn't run.
        Returns:
        Returns a reference to this object so that method calls can be chained together.