CfnMaintenanceWindowTaskProps

class aws_cdk.aws_ssm.CfnMaintenanceWindowTaskProps(*, cutoff_behavior=None, description=None, logging_info=None, max_concurrency=None, max_errors=None, name=None, priority, service_role_arn=None, targets=None, task_arn, task_invocation_parameters=None, task_parameters=None, task_type, window_id)

Bases: object

Properties for defining a AWS::SSM::MaintenanceWindowTask.

Parameters
  • cutoff_behavior (Optional[str]) – AWS::SSM::MaintenanceWindowTask.CutoffBehavior.

  • description (Optional[str]) – AWS::SSM::MaintenanceWindowTask.Description.

  • logging_info (Union[IResolvable, LoggingInfoProperty, None]) – AWS::SSM::MaintenanceWindowTask.LoggingInfo.

  • max_concurrency (Optional[str]) – AWS::SSM::MaintenanceWindowTask.MaxConcurrency.

  • max_errors (Optional[str]) – AWS::SSM::MaintenanceWindowTask.MaxErrors.

  • name (Optional[str]) – AWS::SSM::MaintenanceWindowTask.Name.

  • priority (Union[int, float]) – AWS::SSM::MaintenanceWindowTask.Priority.

  • service_role_arn (Optional[str]) – AWS::SSM::MaintenanceWindowTask.ServiceRoleArn.

  • targets (Union[IResolvable, Sequence[Union[IResolvable, TargetProperty]], None]) – AWS::SSM::MaintenanceWindowTask.Targets.

  • task_arn (str) – AWS::SSM::MaintenanceWindowTask.TaskArn.

  • task_invocation_parameters (Union[IResolvable, TaskInvocationParametersProperty, None]) – AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters.

  • task_parameters (Optional[Any]) – AWS::SSM::MaintenanceWindowTask.TaskParameters.

  • task_type (str) – AWS::SSM::MaintenanceWindowTask.TaskType.

  • window_id (str) – AWS::SSM::MaintenanceWindowTask.WindowId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ssm as ssm

# parameters is of type object
# task_parameters is of type object

cfn_maintenance_window_task_props = ssm.CfnMaintenanceWindowTaskProps(
    priority=123,
    task_arn="taskArn",
    task_type="taskType",
    window_id="windowId",

    # the properties below are optional
    cutoff_behavior="cutoffBehavior",
    description="description",
    logging_info=ssm.CfnMaintenanceWindowTask.LoggingInfoProperty(
        region="region",
        s3_bucket="s3Bucket",

        # the properties below are optional
        s3_prefix="s3Prefix"
    ),
    max_concurrency="maxConcurrency",
    max_errors="maxErrors",
    name="name",
    service_role_arn="serviceRoleArn",
    targets=[ssm.CfnMaintenanceWindowTask.TargetProperty(
        key="key",
        values=["values"]
    )],
    task_invocation_parameters=ssm.CfnMaintenanceWindowTask.TaskInvocationParametersProperty(
        maintenance_window_automation_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowAutomationParametersProperty(
            document_version="documentVersion",
            parameters=parameters
        ),
        maintenance_window_lambda_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowLambdaParametersProperty(
            client_context="clientContext",
            payload="payload",
            qualifier="qualifier"
        ),
        maintenance_window_run_command_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty(
            comment="comment",
            document_hash="documentHash",
            document_hash_type="documentHashType",
            notification_config=ssm.CfnMaintenanceWindowTask.NotificationConfigProperty(
                notification_arn="notificationArn",

                # the properties below are optional
                notification_events=["notificationEvents"],
                notification_type="notificationType"
            ),
            output_s3_bucket_name="outputS3BucketName",
            output_s3_key_prefix="outputS3KeyPrefix",
            parameters=parameters,
            service_role_arn="serviceRoleArn",
            timeout_seconds=123
        ),
        maintenance_window_step_functions_parameters=ssm.CfnMaintenanceWindowTask.MaintenanceWindowStepFunctionsParametersProperty(
            input="input",
            name="name"
        )
    ),
    task_parameters=task_parameters
)

Attributes

cutoff_behavior

AWS::SSM::MaintenanceWindowTask.CutoffBehavior.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-cutoffbehavior

Return type

Optional[str]

description

AWS::SSM::MaintenanceWindowTask.Description.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-description

Return type

Optional[str]

logging_info

AWS::SSM::MaintenanceWindowTask.LoggingInfo.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-logginginfo

Return type

Union[IResolvable, LoggingInfoProperty, None]

max_concurrency

AWS::SSM::MaintenanceWindowTask.MaxConcurrency.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxconcurrency

Return type

Optional[str]

max_errors

AWS::SSM::MaintenanceWindowTask.MaxErrors.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-maxerrors

Return type

Optional[str]

name

AWS::SSM::MaintenanceWindowTask.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-name

Return type

Optional[str]

priority

AWS::SSM::MaintenanceWindowTask.Priority.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-priority

Return type

Union[int, float]

service_role_arn

AWS::SSM::MaintenanceWindowTask.ServiceRoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-servicerolearn

Return type

Optional[str]

targets

AWS::SSM::MaintenanceWindowTask.Targets.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-targets

Return type

Union[IResolvable, List[Union[IResolvable, TargetProperty]], None]

task_arn

AWS::SSM::MaintenanceWindowTask.TaskArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskarn

Return type

str

task_invocation_parameters

AWS::SSM::MaintenanceWindowTask.TaskInvocationParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskinvocationparameters

Return type

Union[IResolvable, TaskInvocationParametersProperty, None]

task_parameters

AWS::SSM::MaintenanceWindowTask.TaskParameters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-taskparameters

Return type

Any

task_type

AWS::SSM::MaintenanceWindowTask.TaskType.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-tasktype

Return type

str

window_id

AWS::SSM::MaintenanceWindowTask.WindowId.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#cfn-ssm-maintenancewindowtask-windowid

Return type

str