aws-cdk-lib.aws_ssm.CfnMaintenanceWindowTargetProps

CfnMaintenanceWindowTargetProps Struct

Properties for defining a CfnMaintenanceWindowTarget.

CfnMaintenanceWindowTargetProps

used as props by

• CfnMaintenanceWindowTarget

Source

Generated code

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

description?optionalstringdescription?optionalstrdescription?optionalStringDescription?optionalstringDescription?optional*string#

A description for the target.

name?optionalstringname?optionalstrname?optionalStringName?optionalstringName?optional*string#

The name for the maintenance window target.

ownerInformation?optionalstringowner_information?optionalstrownerInformation?optionalStringOwnerInformation?optionalstringOwnerInformation?optional*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.

resourceTypestringresource_typestrresourceTypeStringResourceTypestringResourceType*stringrequired#

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

targetsIResolvable | IResolvable | CfnMaintenanceWindowTarget.TargetsProperty[]targetstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TargetsProperty]]]targetsIResolvableTargetsIResolvableTargetsinterface{}required#

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.

windowIdstringwindow_idstrwindowIdStringWindowIdstringWindowId*stringrequired#

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