Struct aws_sdk_ssm::client::fluent_builders::CreateMaintenanceWindow

pub struct CreateMaintenanceWindow { /* private fields */ }

Fluent builder constructing a request to CreateMaintenanceWindow.

Creates a new maintenance window.

The value you specify for Duration determines the specific end time for the maintenance window based on the time it begins. No maintenance window tasks are permitted to start after the resulting endtime minus the number of hours you specify for Cutoff. For example, if the maintenance window starts at 3 PM, the duration is three hours, and the value you specify for Cutoff is one hour, no maintenance window tasks can start after 5 PM.

Implementations

impl CreateMaintenanceWindow

pub async fn send(
    self
) -> Result<CreateMaintenanceWindowOutput, SdkError<CreateMaintenanceWindowError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the maintenance window.

pub fn set_name(self, input: Option<String>) -> Self

The name of the maintenance window.

pub fn description(self, input: impl Into<String>) -> Self

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

pub fn set_description(self, input: Option<String>) -> Self

An optional description for the maintenance window. We recommend specifying a description to help you organize your maintenance windows.

pub fn start_date(self, input: impl Into<String>) -> Self

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

pub fn set_start_date(self, input: Option<String>) -> Self

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become active. StartDate allows you to delay activation of the maintenance window until the specified future date.

pub fn end_date(self, input: impl Into<String>) -> Self

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

pub fn set_end_date(self, input: Option<String>) -> Self

The date and time, in ISO-8601 Extended format, for when you want the maintenance window to become inactive. EndDate allows you to set a date and time in the future when the maintenance window will no longer run.

pub fn schedule(self, input: impl Into<String>) -> Self

The schedule of the maintenance window in the form of a cron or rate expression.

pub fn set_schedule(self, input: Option<String>) -> Self

The schedule of the maintenance window in the form of a cron or rate expression.

pub fn schedule_timezone(self, input: impl Into<String>) -> Self

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

pub fn set_schedule_timezone(self, input: Option<String>) -> Self

The time zone that the scheduled maintenance window executions are based on, in Internet Assigned Numbers Authority (IANA) format. For example: "America/Los_Angeles", "UTC", or "Asia/Seoul". For more information, see the Time Zone Database on the IANA website.

pub fn schedule_offset(self, input: i32) -> Self

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

pub fn set_schedule_offset(self, input: Option<i32>) -> Self

The number of days to wait after the date and time specified by a cron expression before running the maintenance window.

For example, the following cron expression schedules a maintenance window to run on the third Tuesday of every month at 11:30 PM.

cron(30 23 ? * TUE#3 *)

If the schedule offset is 2, the maintenance window won't run until two days later.

pub fn duration(self, input: i32) -> Self

The duration of the maintenance window in hours.

pub fn set_duration(self, input: Option<i32>) -> Self

The duration of the maintenance window in hours.

pub fn cutoff(self, input: i32) -> Self

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

pub fn set_cutoff(self, input: Option<i32>) -> Self

The number of hours before the end of the maintenance window that Amazon Web Services Systems Manager stops scheduling new tasks for execution.

pub fn allow_unassociated_targets(self, input: bool) -> Self

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

pub fn set_allow_unassociated_targets(self, input: Option<bool>) -> Self

Enables a maintenance window task to run on managed nodes, even if you haven't registered those nodes as targets. If enabled, then you must specify the unregistered managed nodes (by node ID) when you register a task with the maintenance window.

If you don't enable this option, then you must specify previously-registered targets when you register a task with the maintenance window.

pub fn client_token(self, input: impl Into<String>) -> Self

User-provided idempotency token.

pub fn set_client_token(self, input: Option<String>) -> Self

User-provided idempotency token.

pub fn tags(self, input: Tag) -> Self

Appends an item to Tags.

To override the contents of this collection use set_tags.

Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:

• Key=TaskType,Value=AgentUpdate

• Key=OS,Value=Windows

• Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource operation.

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

Optional metadata that you assign to a resource. 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. In this case, you could specify the following key-value pairs:

• Key=TaskType,Value=AgentUpdate

• Key=OS,Value=Windows

• Key=Environment,Value=Production

To add tags to an existing maintenance window, use the AddTagsToResource operation.

Trait Implementations

impl Clone for CreateMaintenanceWindow

fn clone(&self) -> CreateMaintenanceWindow

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateMaintenanceWindow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.