CfnMaintenanceWindowTargetProps

class aws_cdk.aws_ssm.CfnMaintenanceWindowTargetProps(*, resource_type, targets, window_id, description=None, name=None, owner_information=None)

Bases: object

Properties for defining a CfnMaintenanceWindowTarget.

Parameters
  • resource_type (str) – The type of target that is being registered with the maintenance window.

  • targets (Union[IResolvable, Sequence[Union[IResolvable, TargetsProperty]]]) – The targets to register with the maintenance window. In other words, the instances to run commands on when the maintenance window runs. You must specify targets by using the WindowTargetIds parameter.

  • window_id (str) – The ID of the maintenance window to register the target with.

  • description (Optional[str]) – A description for the target.

  • name (Optional[str]) – The name for the maintenance window target.

  • owner_information (Optional[str]) – A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

Link

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

ExampleMetadata

fixture=_generated

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

cfn_maintenance_window_target_props = ssm.CfnMaintenanceWindowTargetProps(
    resource_type="resourceType",
    targets=[ssm.CfnMaintenanceWindowTarget.TargetsProperty(
        key="key",
        values=["values"]
    )],
    window_id="windowId",

    # the properties below are optional
    description="description",
    name="name",
    owner_information="ownerInformation"
)

Attributes

description

A description for the target.

Link

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

Return type

Optional[str]

name

The name for the maintenance window target.

Link

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

Return type

Optional[str]

owner_information

A user-provided value that will be included in any Amazon CloudWatch Events events that are raised while running tasks for these targets in this maintenance window.

Link

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

Return type

Optional[str]

resource_type

The type of target that is being registered with the maintenance window.

Link

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

Return type

str

targets

The targets to register with the maintenance window.

In other words, the instances to run commands on when the maintenance window runs.

You must specify targets by using the WindowTargetIds parameter.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, TargetsProperty]]]

window_id

The ID of the maintenance window to register the target with.

Link

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

Return type

str