Package software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowTask.TargetProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowTask.TargetProperty.Jsii$Proxy

Enclosing class:

CfnMaintenanceWindowTask

@Stability(Stable)
public static interface CfnMaintenanceWindowTask.TargetProperty
extends software.amazon.jsii.JsiiSerializable

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ssm.*;
 TargetProperty targetProperty = TargetProperty.builder()
         .key("key")
         .values(List.of("values"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnMaintenanceWindowTask.TargetProperty.Builder	A builder for CfnMaintenanceWindowTask.TargetProperty
static final class	CfnMaintenanceWindowTask.TargetProperty.Jsii$Proxy	An implementation for CfnMaintenanceWindowTask.TargetProperty

Method Summary

Modifier and Type	Method	Description
static CfnMaintenanceWindowTask.TargetProperty.Builder	builder()
String	getKey()	User-defined criteria for sending commands that target instances that meet the criteria.
List<String>	getValues()	User-defined criteria that maps to Key .

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getKey

@Stability(Stable)
@NotNull
String getKey()

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

getValues

@Stability(Stable)
@NotNull
List<String> getValues()

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

builder

@Stability(Stable)
static CfnMaintenanceWindowTask.TargetProperty.Builder builder()

Returns:

a CfnMaintenanceWindowTask.TargetProperty.Builder of CfnMaintenanceWindowTask.TargetProperty