CfnMaintenanceWindowTask

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

Bases: CfnResource

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
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 import aws_ssm as ssm

# parameters: Any
# task_parameters: Any

cfn_maintenance_window_task = ssm.CfnMaintenanceWindowTask(self, "MyCfnMaintenanceWindowTask",
    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(
            cloud_watch_output_config=ssm.CfnMaintenanceWindowTask.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.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
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
priority (Union[int, float]) – The priority of the task in the maintenance window. The lower the number, the higher the priority. Tasks that have the same priority are scheduled in parallel.
task_arn (str) – The resource that the task uses during execution. For RUN_COMMAND and AUTOMATION task types, TaskArn is the SSM document name or Amazon Resource Name (ARN). For LAMBDA tasks, TaskArn is the function name or ARN. For STEP_FUNCTIONS tasks, TaskArn is the state machine ARN.
task_type (str) – The type of task. Valid values: RUN_COMMAND , AUTOMATION , LAMBDA , STEP_FUNCTIONS .
window_id (str) – The ID of the maintenance window where the task is registered.
cutoff_behavior (Optional[str]) – The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.
description (Optional[str]) – A description of the task.
logging_info (Union[IResolvable, LoggingInfoProperty, Dict[str, Any], None]) – Information about an Amazon S3 bucket to write Run Command task-level logs to. .. epigraph:: LoggingInfo has been deprecated. To specify an Amazon S3 bucket to contain logs for Run Command tasks, 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 .
max_concurrency (Optional[str]) – The maximum number of targets this task can be run for, in parallel. .. epigraph:: Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn’t affect the running of your task.
max_errors (Optional[str]) –
The maximum number of errors allowed before this task stops being scheduled. .. epigraph:: Although this element is listed as “Required: No”, a value can be omitted only when you are registering or updating a targetless task You must provide a value in all other cases. For maintenance window tasks without a target specified, you can’t supply a value for this option. Instead, the system inserts a placeholder value of 1 . This value doesn’t affect the running of your task.
name (Optional[str]) – The task name.
service_role_arn (Optional[str]) – 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.
targets (Union[IResolvable, Sequence[Union[IResolvable, TargetProperty, Dict[str, Any]]], None]) – The targets, either instances or window target IDs. - Specify instances using Key=InstanceIds,Values= *instanceid1* , *instanceid2* . - Specify window target IDs using Key=WindowTargetIds,Values= *window-target-id-1* , *window-target-id-2* .
task_invocation_parameters (Union[IResolvable, TaskInvocationParametersProperty, Dict[str, Any], None]) – The parameters to pass to the task when it runs. Populate only the fields that match the task type. All other fields should be empty. .. epigraph:: When you update a maintenance window task that has options specified in TaskInvocationParameters , you must provide again all the TaskInvocationParameters values that you want to retain. The values you do not specify again are removed. For example, suppose that when you registered a Run Command task, you specified TaskInvocationParameters values for Comment , NotificationConfig , and OutputS3BucketName . If you update the maintenance window task and specify only a different OutputS3BucketName value, the values for Comment and NotificationConfig are removed.
task_parameters (Optional[Any]) – The parameters to pass to the task when it runs. .. epigraph:: TaskParameters has been deprecated. To specify parameters to pass to a task when it runs, instead use the Parameters option in the TaskInvocationParameters structure. For information about how Systems Manager handles these options for the supported maintenance window task types, see MaintenanceWindowTaskInvocationParameters .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::SSM::MaintenanceWindowTask'

attr_id

Id

Type:: cloudformationAttribute

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

cutoff_behavior: The specification for whether tasks should continue to run after the cutoff time specified in the maintenance windows is reached.

description: A description of the task.

logging_info: Information about an Amazon S3 bucket to write Run Command task-level logs to.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

max_concurrency: The maximum number of targets this task can be run for, in parallel.

max_errors: The maximum number of errors allowed before this task stops being scheduled.

name: The task name.

node: The tree node.

priority: The priority of the task in the maintenance window.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

service_role_arn: 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.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

targets: The targets, either instances or window target IDs.

task_arn: The resource that the task uses during execution.

task_invocation_parameters: The parameters to pass to the task when it runs.

task_parameters: The parameters to pass to the task when it runs.

task_type: The type of task.

window_id: The ID of the maintenance window where the task is registered.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

CloudWatchOutputConfigProperty

class CfnMaintenanceWindowTask.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 import aws_ssm as ssm

cloud_watch_output_config_property = ssm.CfnMaintenanceWindowTask.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 CfnMaintenanceWindowTask.LoggingInfoProperty(*, region, s3_bucket, s3_prefix=None)

Bases: object

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. .. epigraph:

``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 <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-maintenancewindowruncommandparameters.html>`_ .

Parameters:

region (str) – The AWS Region where the S3 bucket is located.
s3_bucket (str) – The name of an S3 bucket where execution logs are stored.
s3_prefix (Optional[str]) – The Amazon S3 bucket subfolder.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-logginginfo.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 import aws_ssm as ssm

logging_info_property = ssm.CfnMaintenanceWindowTask.LoggingInfoProperty(
    region="region",
    s3_bucket="s3Bucket",

    # the properties below are optional
    s3_prefix="s3Prefix"
)

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 CfnMaintenanceWindowTask.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 (Optional[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 import aws_ssm as ssm

# parameters: Any

maintenance_window_automation_parameters_property = ssm.CfnMaintenanceWindowTask.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 CfnMaintenanceWindowTask.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 import aws_ssm as ssm

maintenance_window_lambda_parameters_property = ssm.CfnMaintenanceWindowTask.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 CfnMaintenanceWindowTask.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 (Optional[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 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.
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 import aws_ssm as ssm

# parameters: Any

maintenance_window_run_command_parameters_property = ssm.CfnMaintenanceWindowTask.MaintenanceWindowRunCommandParametersProperty(
    cloud_watch_output_config=ssm.CfnMaintenanceWindowTask.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.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
)

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 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.

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 CfnMaintenanceWindowTask.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 import aws_ssm as ssm

maintenance_window_step_functions_parameters_property = ssm.CfnMaintenanceWindowTask.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 CfnMaintenanceWindowTask.NotificationConfigProperty(*, notification_arn, 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 (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 import aws_ssm as ssm

notification_config_property = ssm.CfnMaintenanceWindowTask.NotificationConfigProperty(
    notification_arn="notificationArn",

    # the properties below are optional
    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 CfnMaintenanceWindowTask.TargetProperty(*, key, values)

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 (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 (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 import aws_ssm as ssm

target_property = ssm.CfnMaintenanceWindowTask.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 CfnMaintenanceWindowTask.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 import aws_ssm as ssm

# parameters: Any

task_invocation_parameters_property = 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(
        cloud_watch_output_config=ssm.CfnMaintenanceWindowTask.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.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"
    )
)

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