AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::SSM::MaintenanceWindowTarget

CfnMaintenanceWindowTarget

The `AWS::SSM::MaintenanceWindowTarget` resource registers a target with a maintenance window for AWS Systems Manager . For more information, see [RegisterTargetWithMaintenanceWindow](https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_RegisterTargetWithMaintenanceWindow.html) in the *AWS Systems Manager API Reference* .

Import

import { CfnMaintenanceWindowTarget } from 'aws-cdk-lib/aws-ssm';

Or use the module namespace:

import * as ssm from 'aws-cdk-lib/aws-ssm';
// ssm.CfnMaintenanceWindowTarget

Properties

Configuration passed to the constructor as CfnMaintenanceWindowTargetProps.

resourceTypeRequired
string

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

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

windowIdRequired
string

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

descriptionOptional
string

A description for the target.

nameOptional
string

The name for the maintenance window target.

ownerInformationOptional
string

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.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter