Struct aws_sdk_opensearch::operation::start_service_software_update::StartServiceSoftwareUpdateInput

#[non_exhaustive]
pub struct StartServiceSoftwareUpdateInput {
    pub domain_name: Option<String>,
    pub schedule_at: Option<ScheduleAt>,
    pub desired_start_time: Option<i64>,
}

Container for the request parameters to the StartServiceSoftwareUpdate operation.

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.

domain_name: Option<String>

The name of the domain that you want to update to the latest service software.

schedule_at: Option<ScheduleAt>

When to start the service software update.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

desired_start_time: Option<i64>

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Implementations

impl StartServiceSoftwareUpdateInput

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

The name of the domain that you want to update to the latest service software.

pub fn schedule_at(&self) -> Option<&ScheduleAt>

When to start the service software update.

• NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

• TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

• OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

pub fn desired_start_time(&self) -> Option<i64>

The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

impl StartServiceSoftwareUpdateInput

pub fn builder() -> StartServiceSoftwareUpdateInputBuilder

Creates a new builder-style object to manufacture StartServiceSoftwareUpdateInput.

Trait Implementations

impl Clone for StartServiceSoftwareUpdateInput

fn clone(&self) -> StartServiceSoftwareUpdateInput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StartServiceSoftwareUpdateInput

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

Formats the value using the given formatter.

impl PartialEq for StartServiceSoftwareUpdateInput

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StartServiceSoftwareUpdateInput