Package 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:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-05-31T18:44:09.429Z") @Stability(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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnMaintenanceWindowTarget

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

    • CfnMaintenanceWindowTarget

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

    • CfnMaintenanceWindowTarget

      @Stability(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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getResourceType

      @Stability(Stable) @NotNull public String getResourceType()
      The type of target that is being registered with the maintenance window.

    • setResourceType

      @Stability(Stable) public void setResourceType(@NotNull String value)
      The type of target that is being registered with the maintenance window.

    • getTargets

      @Stability(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(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(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(Stable) @NotNull public String getWindowId()
      The ID of the maintenance window to register the target with.

    • setWindowId

      @Stability(Stable) public void setWindowId(@NotNull String value)
      The ID of the maintenance window to register the target with.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the target.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the target.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name for the maintenance window target.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name for the maintenance window target.

    • getOwnerInformation

      @Stability(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(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.