Interface CfnMaintenanceWindowProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnMaintenanceWindowProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
date="2024-08-23T05:56:24.095Z")
@Stability(Stable)
public interface CfnMaintenanceWindowProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnMaintenanceWindow
.
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.*; CfnMaintenanceWindowProps cfnMaintenanceWindowProps = CfnMaintenanceWindowProps.builder() .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();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnMaintenanceWindowProps
static final class
An implementation forCfnMaintenanceWindowProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Enables a maintenance window task to run on managed instances, even if you have not registered those instances as targets.The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.default String
A description of the maintenance window.The duration of the maintenance window in hours.default String
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.getName()
The name of the maintenance window.The schedule of the maintenance window in the form of a cron or rate expression.default Number
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.default String
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.default String
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become active.getTags()
Optional metadata that you assign to a resource in the form of an arbitrary set of tags (key-value pairs).Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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.
- See Also:
-
getCutoff
The number of hours before the end of the maintenance window that AWS Systems Manager stops scheduling new tasks for execution.- See Also:
-
getDuration
The duration of the maintenance window in hours.- See Also:
-
getName
The name of the maintenance window.- See Also:
-
getSchedule
The schedule of the maintenance window in the form of a cron or rate expression.- See Also:
-
getDescription
A description of the maintenance window.- See Also:
-
getEndDate
The date and time, in ISO-8601 Extended format, for when the maintenance window is scheduled to become inactive.- See Also:
-
getScheduleOffset
The number of days to wait to run a maintenance window after the scheduled cron expression date and time.- See Also:
-
getScheduleTimezone
The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format.- See Also:
-
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.- See Also:
-
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.
- See Also:
-
builder
- Returns:
- a
CfnMaintenanceWindowProps.Builder
ofCfnMaintenanceWindowProps
-