software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTarget

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTarget

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-28T21:34:20.909Z")
 @Stability(value=Stable)
public class CfnMaintenanceWindowTarget
extends CfnResource
implements IInspectable

A CloudFormation `AWS::SSM::MaintenanceWindowTarget`.

The AWS::SSM::MaintenanceWindowTarget resource registers a target with a maintenance window for AWS Systems Manager . For more information, see RegisterTargetWithMaintenanceWindow in the AWS Systems Manager API Reference .

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.*;
 CfnMaintenanceWindowTarget cfnMaintenanceWindowTarget = CfnMaintenanceWindowTarget.Builder.create(this, "MyCfnMaintenanceWindowTarget")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnMaintenanceWindowTarget.Builder A fluent builder for CfnMaintenanceWindowTarget.
static interface	CfnMaintenanceWindowTarget.TargetsProperty The `Targets` property type specifies adding a target to a maintenance window target in AWS Systems Manager .

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnMaintenanceWindowTarget(Construct scope, String id, CfnMaintenanceWindowTargetProps props) Create a new `AWS::SSM::MaintenanceWindowTarget`.
protected	CfnMaintenanceWindowTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMaintenanceWindowTarget(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() A description for the target.
String	getName() The name for the maintenance window target.
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) A description for the target.
void	setName(String value) The name for the maintenance window target.
void	setOwnerInformation(String value) 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.
void	setResourceType(String value) The type of target that is being registered with the maintenance window.
void	setTargets(IResolvable value) The targets to register with the maintenance window.
void	setTargets(List<Object> value) The targets to register with the maintenance window.
void	setWindowId(String value) The ID of the maintenance window to register the target with.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnMaintenanceWindowTarget

protected CfnMaintenanceWindowTarget(software.amazon.jsii.JsiiObjectRef objRef)

CfnMaintenanceWindowTarget

protected CfnMaintenanceWindowTarget(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnMaintenanceWindowTarget

@Stability(value=Stable)
public CfnMaintenanceWindowTarget(@NotNull
                                                           Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @NotNull
                                                           CfnMaintenanceWindowTargetProps props)

Create a new `AWS::SSM::MaintenanceWindowTarget`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getResourceType

@Stability(value=Stable)
 @NotNull
public String getResourceType()

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

setResourceType

@Stability(value=Stable)
public void setResourceType(@NotNull
                                                     String value)

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

getTargets

@Stability(value=Stable)
 @NotNull
public 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.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                IResolvable value)

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.

setTargets

@Stability(value=Stable)
public void setTargets(@NotNull
                                                List<Object> value)

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.

getWindowId

@Stability(value=Stable)
 @NotNull
public String getWindowId()

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

setWindowId

@Stability(value=Stable)
public void setWindowId(@NotNull
                                                 String value)

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

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description for the target.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description for the target.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

The name for the maintenance window target.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

The name for the maintenance window target.

getOwnerInformation

@Stability(value=Stable)
 @Nullable
public 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.

setOwnerInformation

@Stability(value=Stable)
public void setOwnerInformation(@Nullable
                                                         String value)

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.