Struct aws_sdk_ssm::input::CreateMaintenanceWindowInput

#[non_exhaustive]
pub struct CreateMaintenanceWindowInput {
    pub name: Option<String>,
    pub description: Option<String>,
    pub start_date: Option<String>,
    pub end_date: Option<String>,
    pub schedule: Option<String>,
    pub schedule_timezone: Option<String>,
    pub schedule_offset: Option<i32>,
    pub duration: i32,
    pub cutoff: i32,
    pub allow_unassociated_targets: bool,
    pub client_token: Option<String>,
    pub tags: Option<Vec<Tag>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Option<String>

The name of the maintenance window.

description: Option<String>

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

start_date: Option<String>

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.

end_date: Option<String>

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.

schedule: Option<String>

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

schedule_timezone: Option<String>

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.

schedule_offset: Option<i32>

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.

duration: i32

The duration of the maintenance window in hours.

cutoff: i32

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

allow_unassociated_targets: bool

Enables a maintenance window task to run on managed instances, even if you haven't 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.

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

client_token: Option<String>

User-provided idempotency token.

tags: Option<Vec<Tag>>

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.

Implementations

impl CreateMaintenanceWindowInput

pub async fn make_operation(
    self,
    _config: &Config
) -> Result<Operation<CreateMaintenanceWindow, AwsErrorRetryPolicy>, BuildError>

Consumes the builder and constructs an Operation<CreateMaintenanceWindow>

pub fn builder() -> Builder

Creates a new builder-style object to manufacture CreateMaintenanceWindowInput

impl CreateMaintenanceWindowInput

pub fn name(&self) -> Option<&str>

The name of the maintenance window.

pub fn description(&self) -> Option<&str>

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

pub fn start_date(&self) -> Option<&str>

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) -> Option<&str>

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) -> Option<&str>

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

pub fn schedule_timezone(&self) -> Option<&str>

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) -> Option<i32>

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) -> i32

The duration of the maintenance window in hours.

pub fn cutoff(&self) -> i32

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) -> bool

Enables a maintenance window task to run on managed instances, even if you haven't 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.

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) -> Option<&str>

User-provided idempotency token.

pub fn tags(&self) -> Option<&[Tag]>

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 CreateMaintenanceWindowInput

fn clone(&self) -> CreateMaintenanceWindowInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateMaintenanceWindowInput

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

Formats the value using the given formatter.

impl PartialEq<CreateMaintenanceWindowInput> for CreateMaintenanceWindowInput

fn eq(&self, other: &CreateMaintenanceWindowInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CreateMaintenanceWindowInput) -> bool

This method tests for !=.

impl StructuralPartialEq for CreateMaintenanceWindowInput