CfnMaintenanceWindowTaskPropsMixin

class aws_cdk.mixins_preview.aws_ssm.mixins.CfnMaintenanceWindowTaskPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::SSM::MaintenanceWindowTask resource defines information about a task for an AWS Systems Manager maintenance window.

For more information, see RegisterTaskWithMaintenanceWindow in the AWS Systems Manager API Reference .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html
CloudformationResource:: AWS::SSM::MaintenanceWindowTask
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# parameters: Any
# task_parameters: Any

cfn_maintenance_window_task_props_mixin = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin(ssm_mixins.CfnMaintenanceWindowTaskMixinProps(
    cutoff_behavior="cutoffBehavior",
    description="description",
    logging_info=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.LoggingInfoProperty(
        region="region",
        s3_bucket="s3Bucket",
        s3_prefix="s3Prefix"
    ),
    max_concurrency="maxConcurrency",
    max_errors="maxErrors",
    name="name",
    priority=123,
    service_role_arn="serviceRoleArn",
    targets=[ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty(
        key="key",
        values=["values"]
    )],
    task_arn="taskArn",
    task_invocation_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.TaskInvocationParametersProperty(
        maintenance_window_automation_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowAutomationParametersProperty(
            document_version="documentVersion",
            parameters=parameters
        ),
        maintenance_window_lambda_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowLambdaParametersProperty(
            client_context="clientContext",
            payload="payload",
            qualifier="qualifier"
        ),
        maintenance_window_run_command_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty(
            cloud_watch_output_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty(
                cloud_watch_log_group_name="cloudWatchLogGroupName",
                cloud_watch_output_enabled=False
            ),
            comment="comment",
            document_hash="documentHash",
            document_hash_type="documentHashType",
            document_version="documentVersion",
            notification_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty(
                notification_arn="notificationArn",
                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_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowStepFunctionsParametersProperty(
            input="input",
            name="name"
        )
    ),
    task_parameters=task_parameters,
    task_type="taskType",
    window_id="windowId"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::SSM::MaintenanceWindowTask.

Parameters:

props (Union[CfnMaintenanceWindowTaskMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['cutoffBehavior', 'description', 'loggingInfo', 'maxConcurrency', 'maxErrors', 'name', 'priority', 'serviceRoleArn', 'targets', 'taskArn', 'taskInvocationParameters', 'taskParameters', 'taskType', 'windowId']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

CloudWatchOutputConfigProperty

class CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty(*, cloud_watch_log_group_name=None, cloud_watch_output_enabled=None)

Bases: object

Configuration options for sending command output to Amazon CloudWatch Logs.

Parameters:

cloud_watch_log_group_name (Optional[str]) – The name of the CloudWatch Logs log group where you want to send command output. If you don’t specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format: aws/ssm/ *SystemsManagerDocumentName*
cloud_watch_output_enabled (Union[bool, IResolvable, None]) – Enables Systems Manager to send command output to CloudWatch Logs.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

cloud_watch_output_config_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty(
    cloud_watch_log_group_name="cloudWatchLogGroupName",
    cloud_watch_output_enabled=False
)

Attributes

cloud_watch_log_group_name

The name of the CloudWatch Logs log group where you want to send command output.

If you don’t specify a group name, AWS Systems Manager automatically creates a log group for you. The log group uses the following naming format:

aws/ssm/ *SystemsManagerDocumentName*

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchloggroupname

cloud_watch_output_enabled

Enables Systems Manager to send command output to CloudWatch Logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-cloudwatchoutputconfig.html#cfn-ssm-maintenancewindowtask-cloudwatchoutputconfig-cloudwatchoutputenabled

LoggingInfoProperty

class CfnMaintenanceWindowTaskPropsMixin.LoggingInfoProperty(*, region=None, s3_bucket=None, s3_prefix=None)

Bases: object

LoggingInfo has been deprecated.

To specify an Amazon S3 bucket to contain logs, instead use the OutputS3BucketName and OutputS3KeyPrefix options in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see AWS ::SSM::MaintenanceWindowTask MaintenanceWindowRunCommandParameters .

The LoggingInfo property type specifies information about the Amazon S3 bucket to write instance-level logs to.

LoggingInfo is a property of the AWS::SSM::MaintenanceWindowTask resource.

Attributes

region

The AWS Region where the S3 bucket is located.

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

s3_bucket

The name of an S3 bucket where execution logs are stored.

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

s3_prefix

The Amazon S3 bucket subfolder.

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

MaintenanceWindowAutomationParametersProperty

class CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowAutomationParametersProperty(*, document_version=None, parameters=None)

Bases: object

The MaintenanceWindowAutomationParameters property type specifies the parameters for an AUTOMATION task type for a maintenance window task in AWS Systems Manager .

MaintenanceWindowAutomationParameters is a property of the TaskInvocationParameters property type.

For information about available parameters in Automation runbooks, you can view the content of the runbook itself in the Systems Manager console. For information, see View runbook content in the AWS Systems Manager User Guide .

Parameters:

document_version (Optional[str]) – The version of an Automation runbook to use during task execution.
parameters (Any) – The parameters for the AUTOMATION type task.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# parameters: Any

maintenance_window_automation_parameters_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowAutomationParametersProperty(
    document_version="documentVersion",
    parameters=parameters
)

Attributes

document_version

The version of an Automation runbook to use during task execution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-documentversion

parameters

The parameters for the AUTOMATION type task.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowautomationparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowautomationparameters-parameters

MaintenanceWindowLambdaParametersProperty

class CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowLambdaParametersProperty(*, client_context=None, payload=None, qualifier=None)

Bases: object

The MaintenanceWindowLambdaParameters property type specifies the parameters for a LAMBDA task type for a maintenance window task in AWS Systems Manager .

MaintenanceWindowLambdaParameters is a property of the TaskInvocationParameters property type.

Parameters:

client_context (Optional[str]) – Client-specific information to pass to the AWS Lambda function that you’re invoking. You can then use the context variable to process the client information in your AWS Lambda function.
payload (Optional[str]) – JSON to provide to your AWS Lambda function as input. .. epigraph:: Although Type is listed as “String” for this property, the payload content must be formatted as a Base64-encoded binary data object. Length Constraint: 4096
qualifier (Optional[str]) – An AWS Lambda function version or alias name. If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

maintenance_window_lambda_parameters_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowLambdaParametersProperty(
    client_context="clientContext",
    payload="payload",
    qualifier="qualifier"
)

Attributes

client_context

Client-specific information to pass to the AWS Lambda function that you’re invoking.

You can then use the context variable to process the client information in your AWS Lambda function.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-clientcontext

payload

JSON to provide to your AWS Lambda function as input.

Although Type is listed as “String” for this property, the payload content must be formatted as a Base64-encoded binary data object.

Length Constraint: 4096

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-payload

qualifier

An AWS Lambda function version or alias name.

If you specify a function version, the action uses the qualified function Amazon Resource Name (ARN) to invoke a specific Lambda function. If you specify an alias name, the action uses the alias ARN to invoke the Lambda function version that the alias points to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowlambdaparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowlambdaparameters-qualifier

MaintenanceWindowRunCommandParametersProperty

class CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty(*, cloud_watch_output_config=None, comment=None, document_hash=None, document_hash_type=None, document_version=None, notification_config=None, output_s3_bucket_name=None, output_s3_key_prefix=None, parameters=None, service_role_arn=None, timeout_seconds=None)

Bases: object

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.

Parameters:

cloud_watch_output_config (Union[IResolvable, CloudWatchOutputConfigProperty, Dict[str, Any], None]) – Configuration options for sending command output to Amazon CloudWatch Logs.
comment (Optional[str]) – Information about the command or commands to run.
document_hash (Optional[str]) – The SHA-256 or SHA-1 hash created by the system when the document was created. SHA-1 hashes have been deprecated.
document_hash_type (Optional[str]) – The SHA-256 or SHA-1 hash type. SHA-1 hashes are deprecated.
document_version (Optional[str]) – 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"
notification_config (Union[IResolvable, NotificationConfigProperty, Dict[str, Any], None]) – Configurations for sending notifications about command status changes on a per-managed node basis.
output_s3_bucket_name (Optional[str]) – The name of the Amazon Simple Storage Service (Amazon S3) bucket.
output_s3_key_prefix (Optional[str]) – The S3 bucket subfolder.
parameters (Any) –
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 .
service_role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM service role for AWS 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 AWS Systems Manager User Guide .
timeout_seconds (Union[int, float, None]) – If this time is reached and the command hasn’t already started running, it doesn’t run.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# parameters: Any

maintenance_window_run_command_parameters_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty(
    cloud_watch_output_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty(
        cloud_watch_log_group_name="cloudWatchLogGroupName",
        cloud_watch_output_enabled=False
    ),
    comment="comment",
    document_hash="documentHash",
    document_hash_type="documentHashType",
    document_version="documentVersion",
    notification_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty(
        notification_arn="notificationArn",
        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
)

Attributes

cloud_watch_output_config

Configuration options for sending command output to Amazon CloudWatch Logs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-cloudwatchoutputconfig

comment

Information about the command or commands to run.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-comment

document_hash

The SHA-256 or SHA-1 hash created by the system when the document was created.

SHA-1 hashes have been deprecated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthash

document_hash_type

The SHA-256 or SHA-1 hash type.

SHA-1 hashes are deprecated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documenthashtype

document_version

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"

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-documentversion

notification_config

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-notificationconfig

output_s3_bucket_name

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3bucketname

output_s3_key_prefix

The S3 bucket subfolder.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-outputs3keyprefix

parameters

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 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-parameters

service_role_arn

The Amazon Resource Name (ARN) of the IAM service role for AWS 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 AWS Systems Manager User Guide .

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

timeout_seconds

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowruncommandparameters-timeoutseconds

MaintenanceWindowStepFunctionsParametersProperty

class CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowStepFunctionsParametersProperty(*, input=None, name=None)

Bases: object

The MaintenanceWindowStepFunctionsParameters property type specifies the parameters for the execution of a STEP_FUNCTIONS task in a Systems Manager maintenance window.

MaintenanceWindowStepFunctionsParameters is a property of the TaskInvocationParameters property type.

Parameters:

input (Optional[str]) – The inputs for the STEP_FUNCTIONS task.
name (Optional[str]) – The name of the STEP_FUNCTIONS task.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

maintenance_window_step_functions_parameters_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowStepFunctionsParametersProperty(
    input="input",
    name="name"
)

Attributes

input

The inputs for the STEP_FUNCTIONS task.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters.html#cfn-ssm-maintenancewindowtask-maintenancewindowstepfunctionsparameters-input

name

The name of the STEP_FUNCTIONS task.

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

NotificationConfigProperty

class CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty(*, notification_arn=None, notification_events=None, notification_type=None)

Bases: object

The NotificationConfig property type specifies configurations for sending notifications for a maintenance window task in AWS Systems Manager .

NotificationConfig is a property of the MaintenanceWindowRunCommandParameters property type.

Parameters:

notification_arn (Optional[str]) – An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.
notification_events (Optional[Sequence[str]]) – The different events that you can receive notifications for. These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .
notification_type (Optional[str]) – The notification type. - Command : Receive notification when the status of a command changes. - Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

notification_config_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty(
    notification_arn="notificationArn",
    notification_events=["notificationEvents"],
    notification_type="notificationType"
)

Attributes

notification_arn

An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.

Run Command pushes notifications about command status changes to this topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationarn

notification_events

The different events that you can receive notifications for.

These events include the following: All (events), InProgress , Success , TimedOut , Cancelled , Failed . To learn more about these events, see Configuring Amazon SNS Notifications for AWS Systems Manager in the AWS Systems Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationevents

notification_type

The notification type.

Command : Receive notification when the status of a command changes.
Invocation : For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-notificationconfig.html#cfn-ssm-maintenancewindowtask-notificationconfig-notificationtype

TargetProperty

class CfnMaintenanceWindowTaskPropsMixin.TargetProperty(*, key=None, values=None)

Bases: object

The Target property type specifies targets (either instances or window target IDs).

You specify instances by using Key=InstanceIds,Values=< *instanceid1* >,< *instanceid2* > . You specify window target IDs using Key=WindowTargetIds,Values=< *window-target-id-1* >,< *window-target-id-2* > for a maintenance window task in AWS Systems Manager .

Target is a property of the AWS::SSM::MaintenanceWindowTask property type. .. epigraph:

To use ``resource-groups:Name`` as the key for a maintenance window target, specify the resource group as a ``AWS::SSM::MaintenanceWindowTarget`` type, and use the ``Ref`` function to specify the target for ``AWS::SSM::MaintenanceWindowTask`` . For an example, see *Create a Run Command task that targets instances using a resource group name* in `AWS::SSM::MaintenanceWindowTask Examples <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtask.html#aws-resource-ssm-maintenancewindowtask--examples>`_ .

Parameters:

key (Optional[str]) – User-defined criteria for sending commands that target instances that meet the criteria. Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About ‘register-task-with-maintenance-window’ Options and Values in the AWS Systems Manager User Guide .
values (Optional[Sequence[str]]) –
User-defined criteria that maps to Key . For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About ‘register-task-with-maintenance-window’ Options and Values in the AWS Systems Manager User Guide .

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

target_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty(
    key="key",
    values=["values"]
)

Attributes

key

User-defined criteria for sending commands that target instances that meet the criteria.

Key can be InstanceIds or WindowTargetIds . For more information about how to target instances within a maintenance window task, see About ‘register-task-with-maintenance-window’ Options and Values in the AWS Systems Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key

values

User-defined criteria that maps to Key .

For example, if you specify InstanceIds , you can specify i-1234567890abcdef0,i-9876543210abcdef0 to run a command on two EC2 instances. For more information about how to target instances within a maintenance window task, see About ‘register-task-with-maintenance-window’ Options and Values in the AWS Systems Manager User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values

TaskInvocationParametersProperty

class CfnMaintenanceWindowTaskPropsMixin.TaskInvocationParametersProperty(*, maintenance_window_automation_parameters=None, maintenance_window_lambda_parameters=None, maintenance_window_run_command_parameters=None, maintenance_window_step_functions_parameters=None)

Bases: object

The TaskInvocationParameters property type specifies the task execution parameters for a maintenance window task in AWS Systems Manager .

TaskInvocationParameters is a property of the AWS::SSM::MaintenanceWindowTask property type.

Parameters:

maintenance_window_automation_parameters (Union[IResolvable, MaintenanceWindowAutomationParametersProperty, Dict[str, Any], None]) – The parameters for an AUTOMATION task type.
maintenance_window_lambda_parameters (Union[IResolvable, MaintenanceWindowLambdaParametersProperty, Dict[str, Any], None]) – The parameters for a LAMBDA task type.
maintenance_window_run_command_parameters (Union[IResolvable, MaintenanceWindowRunCommandParametersProperty, Dict[str, Any], None]) – The parameters for a RUN_COMMAND task type.
maintenance_window_step_functions_parameters (Union[IResolvable, MaintenanceWindowStepFunctionsParametersProperty, Dict[str, Any], None]) – The parameters for a STEP_FUNCTIONS task type.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

# parameters: Any

task_invocation_parameters_property = ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.TaskInvocationParametersProperty(
    maintenance_window_automation_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowAutomationParametersProperty(
        document_version="documentVersion",
        parameters=parameters
    ),
    maintenance_window_lambda_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowLambdaParametersProperty(
        client_context="clientContext",
        payload="payload",
        qualifier="qualifier"
    ),
    maintenance_window_run_command_parameters=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowRunCommandParametersProperty(
        cloud_watch_output_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.CloudWatchOutputConfigProperty(
            cloud_watch_log_group_name="cloudWatchLogGroupName",
            cloud_watch_output_enabled=False
        ),
        comment="comment",
        document_hash="documentHash",
        document_hash_type="documentHashType",
        document_version="documentVersion",
        notification_config=ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.NotificationConfigProperty(
            notification_arn="notificationArn",
            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_mixins.CfnMaintenanceWindowTaskPropsMixin.MaintenanceWindowStepFunctionsParametersProperty(
        input="input",
        name="name"
    )
)

Attributes

maintenance_window_automation_parameters

The parameters for an AUTOMATION task type.

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

maintenance_window_lambda_parameters

The parameters for a LAMBDA task type.

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

maintenance_window_run_command_parameters

The parameters for a RUN_COMMAND task type.

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

maintenance_window_step_functions_parameters

The parameters for a STEP_FUNCTIONS task type.

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