2.238.0

interface TargetProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.SSM.Mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsssm/mixins#CfnMaintenanceWindowTaskPropsMixin_TargetProperty
Javasoftware.amazon.awscdk.mixins.preview.services.ssm.mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty
Pythonaws_cdk.mixins_preview.aws_ssm.mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty
TypeScript @aws-cdk/mixins-preview » aws_ssm » mixins » CfnMaintenanceWindowTaskPropsMixin » TargetProperty

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.

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as ssm_mixins } from '@aws-cdk/mixins-preview/aws-ssm';
const targetProperty: ssm_mixins.CfnMaintenanceWindowTaskPropsMixin.TargetProperty = {
  key: 'key',
  values: ['values'],
};

Properties

NameTypeDescription
key?stringUser-defined criteria for sending commands that target instances that meet the criteria.
values?string[]User-defined criteria that maps to Key .

key?

Type: string (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-key

values?

Type: string[] (optional)

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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssm-maintenancewindowtask-target.html#cfn-ssm-maintenancewindowtask-target-values

← PreviousNext →