aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTargetProps

interface CfnMaintenanceWindowTargetProps

LanguageType name
.NETAmazon.CDK.AWS.SSM.CfnMaintenanceWindowTargetProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsssm#CfnMaintenanceWindowTargetProps
Javasoftware.amazon.awscdk.services.ssm.CfnMaintenanceWindowTargetProps
Pythonaws_cdk.aws_ssm.CfnMaintenanceWindowTargetProps
TypeScript aws-cdk-lib » aws_ssm » CfnMaintenanceWindowTargetProps

Properties for defining a CfnMaintenanceWindowTarget.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ssm as ssm } from 'aws-cdk-lib';
const cfnMaintenanceWindowTargetProps: ssm.CfnMaintenanceWindowTargetProps = {
  resourceType: 'resourceType',
  targets: [{
    key: 'key',
    values: ['values'],
  }],
  windowId: 'windowId',

  // the properties below are optional
  description: 'description',
  name: 'name',
  ownerInformation: 'ownerInformation',
};

Properties

NameTypeDescription
resourceTypestringThe type of target that is being registered with the maintenance window.
targetsIResolvable | IResolvable | TargetsProperty[]The targets to register with the maintenance window.
windowIdstringThe ID of the maintenance window to register the target with.
description?stringA description for the target.
name?stringThe name for the maintenance window target.
ownerInformation?stringA 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.

resourceType

Type: string

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


targets

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


windowId

Type: string

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


description?

Type: string (optional)

A description for the target.


name?

Type: string (optional)

The name for the maintenance window target.


ownerInformation?

Type: string (optional)

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.