Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindowTarget

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ssm.CfnMaintenanceWindowTarget
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-24T21:00:37.787Z") @Stability(Stable) public class CfnMaintenanceWindowTarget extends CfnResource implements IInspectable
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();

See Also:

  • 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 software.constructs.Construct scope, @NotNull String id, @NotNull CfnMaintenanceWindowTargetProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • 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.

    • setTargets

      @Stability(Stable) public void setTargets(@NotNull IResolvable value)
      The targets to register with the maintenance window.

    • setTargets

      @Stability(Stable) public void setTargets(@NotNull List<Object> value)
      The targets to register with the maintenance window.

    • 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.