Package software.amazon.awscdk.services.ssm

Interface CfnMaintenanceWindowTargetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnMaintenanceWindowTargetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:24:09.977Z")
@Stability(Stable)
public interface CfnMaintenanceWindowTargetProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.ssm.*;
 CfnMaintenanceWindowTargetProps cfnMaintenanceWindowTargetProps = CfnMaintenanceWindowTargetProps.builder()
         .resourceType("resourceType")
         .targets(List.of(TargetsProperty.builder()
                 .key("key")
                 .values(List.of("values"))
                 .build()))
         .windowId("windowId")
         // the properties below are optional
         .description("description")
         .name("name")
         .ownerInformation("ownerInformation")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnMaintenanceWindowTargetProps.Builder	builder()
default String	getDescription()	A description for the target.
default String	getName()	The name for the maintenance window target.
default String	getOwnerInformation()	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.
String	getResourceType()	The type of target that is being registered with the maintenance window.
Object	getTargets()	The targets to register with the maintenance window.
String	getWindowId()	The ID of the maintenance window to register the target with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getResourceType

@Stability(Stable)
@NotNull
String getResourceType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-resourcetype

getTargets

@Stability(Stable)
@NotNull
Object getTargets()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-targets

getWindowId

@Stability(Stable)
@NotNull
String getWindowId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-windowid

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-description

getName

@Stability(Stable)
@Nullable
default String getName()

The name for the maintenance window target.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-name

getOwnerInformation

@Stability(Stable)
@Nullable
default String getOwnerInformation()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssm-maintenancewindowtarget.html#cfn-ssm-maintenancewindowtarget-ownerinformation

builder

@Stability(Stable)
static CfnMaintenanceWindowTargetProps.Builder builder()

Returns:

a CfnMaintenanceWindowTargetProps.Builder of CfnMaintenanceWindowTargetProps