Package software.amazon.awscdk.services.ssm

Class CfnMaintenanceWindow

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.CfnMaintenanceWindow
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:37.744Z") @Stability(Stable) public class CfnMaintenanceWindow extends CfnResource implements IInspectable
A CloudFormation AWS::SSM::MaintenanceWindow.

The AWS::SSM::MaintenanceWindow resource represents general information about a maintenance window for AWS Systems Manager . Maintenance Windows let you define a schedule for when to perform potentially disruptive actions on your instances, such as patching an operating system (OS), updating drivers, or installing software. Each maintenance window has a schedule, a duration, a set of registered targets, and a set of registered tasks.

For more information, see Systems Manager Maintenance Windows in the AWS Systems Manager User Guide and CreateMaintenanceWindow 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.*;
 CfnMaintenanceWindow cfnMaintenanceWindow = CfnMaintenanceWindow.Builder.create(this, "MyCfnMaintenanceWindow")
         .allowUnassociatedTargets(false)
         .cutoff(123)
         .duration(123)
         .name("name")
         .schedule("schedule")
         // the properties below are optional
         .description("description")
         .endDate("endDate")
         .scheduleOffset(123)
         .scheduleTimezone("scheduleTimezone")
         .startDate("startDate")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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

    • CfnMaintenanceWindow

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

    • CfnMaintenanceWindow

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

    • CfnMaintenanceWindow

      @Stability(Stable) public CfnMaintenanceWindow(@NotNull Construct scope, @NotNull String id, @NotNull CfnMaintenanceWindowProps props)
      Create a new AWS::SSM::MaintenanceWindow.

      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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).

      Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag a maintenance window to identify the type of tasks it will run, the types of targets, and the environment it will run in.

    • getAllowUnassociatedTargets

      @Stability(Stable) @NotNull public Object getAllowUnassociatedTargets()
      Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

      If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

    • setAllowUnassociatedTargets

      @Stability(Stable) public void setAllowUnassociatedTargets(@NotNull Boolean value)
      Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

      If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

    • setAllowUnassociatedTargets

      @Stability(Stable) public void setAllowUnassociatedTargets(@NotNull IResolvable value)
      Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.

      If enabled, then you must specify the unregistered instances (by instance ID) when you register a task with the maintenance window.

    • getCutoff

      @Stability(Stable) @NotNull public Number getCutoff()
      The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

    • setCutoff

      @Stability(Stable) public void setCutoff(@NotNull Number value)
      The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.

    • getDuration

      @Stability(Stable) @NotNull public Number getDuration()
      The duration of the maintenance window in hours.

    • setDuration

      @Stability(Stable) public void setDuration(@NotNull Number value)
      The duration of the maintenance window in hours.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the maintenance window.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the maintenance window.

    • getSchedule

      @Stability(Stable) @NotNull public String getSchedule()
      The schedule of the maintenance window in the form of a cron or rate expression.

    • setSchedule

      @Stability(Stable) public void setSchedule(@NotNull String value)
      The schedule of the maintenance window in the form of a cron or rate expression.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the maintenance window.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the maintenance window.

    • getEndDate

      @Stability(Stable) @Nullable public String getEndDate()
      The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

    • setEndDate

      @Stability(Stable) public void setEndDate(@Nullable String value)
      The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.

    • getScheduleOffset

      @Stability(Stable) @Nullable public Number getScheduleOffset()
      The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

    • setScheduleOffset

      @Stability(Stable) public void setScheduleOffset(@Nullable Number value)
      The number of days to wait to run a maintenance window after the scheduled cron expression date and time.

    • getScheduleTimezone

      @Stability(Stable) @Nullable public String getScheduleTimezone()
      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

    • setScheduleTimezone

      @Stability(Stable) public void setScheduleTimezone(@Nullable String value)
      The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.

    • getStartDate

      @Stability(Stable) @Nullable public String getStartDate()
      The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

      StartDate allows you to delay activation of the Maintenance Window until the specified future date.

    • setStartDate

      @Stability(Stable) public void setStartDate(@Nullable String value)
      The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.

      StartDate allows you to delay activation of the Maintenance Window until the specified future date.