MaintenanceWindowRunCommandParameters ¶

class MaintenanceWindowRunCommandParameters(TypedDict, closed=True):
    comment: NotRequired["capo_ssm.types.comment.Comment"]
    """<p>Information about the commands to run.</p>"""
    cloud_watch_output_config: NotRequired[
        "capo_ssm.types.cloud_watch_output_config.CloudWatchOutputConfig"
    ]
    document_hash: NotRequired["capo_ssm.types.document_hash.DocumentHash"]
    """<p>The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.</p>"""
    document_hash_type: NotRequired[
        "capo_ssm.types.document_hash_type.DocumentHashType"
    ]
    """<p>SHA-256 or SHA-1. SHA-1 hashes have been deprecated.</p>"""
    document_version: NotRequired["capo_ssm.types.document_version.DocumentVersion"]
    r"""<p>The Amazon Web Services Systems Manager document (SSM document) version to use in the request. You can specify <code>$DEFAULT</code>, <code>$LATEST</code>, 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:</p> <p> <code>--document-version "\$DEFAULT"</code> </p> <p> <code>--document-version "\$LATEST"</code> </p> <p> <code>--document-version "3"</code> </p>"""
    notification_config: NotRequired[
        "capo_ssm.types.notification_config.NotificationConfig"
    ]
    """<p>Configurations for sending notifications about command status changes on a per-managed node basis.</p>"""
    output_s3_bucket_name: NotRequired["capo_ssm.types.s3_bucket_name.S3BucketName"]
    """<p>The name of the Amazon Simple Storage Service (Amazon S3) bucket.</p>"""
    output_s3_key_prefix: NotRequired["capo_ssm.types.s3_key_prefix.S3KeyPrefix"]
    """<p>The S3 bucket subfolder.</p>"""
    parameters: NotRequired["capo_ssm.types.parameters.Parameters"]
    """<p>The parameters for the <code>RUN_COMMAND</code> task execution.</p>"""
    service_role_arn: NotRequired["capo_ssm.types.service_role.ServiceRole"]
    """<p>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 <code>RegisterTaskWithMaintenanceWindow</code>.</p> <p>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 <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/sysman-maintenance-permissions.html">Setting up Maintenance Windows</a> in the in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>"""
    timeout_seconds: NotRequired["capo_ssm.types.timeout_seconds.TimeoutSeconds"]
    """<p>If this time is reached and the command hasn't already started running, it doesn't run.</p>"""