Struct aws_sdk_redshift::model::ScheduledAction

#[non_exhaustive]
pub struct ScheduledAction {
    pub scheduled_action_name: Option<String>,
    pub target_action: Option<ScheduledActionType>,
    pub schedule: Option<String>,
    pub iam_role: Option<String>,
    pub scheduled_action_description: Option<String>,
    pub state: Option<ScheduledActionState>,
    pub next_invocations: Option<Vec<DateTime>>,
    pub start_time: Option<DateTime>,
    pub end_time: Option<DateTime>,
}

Describes a scheduled action. You can use a scheduled action to trigger some Amazon Redshift API operations on a schedule. For information about which API operations can be scheduled, see ScheduledActionType.

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.

scheduled_action_name: Option<String>

The name of the scheduled action.

target_action: Option<ScheduledActionType>

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

schedule: Option<String>

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

iam_role: Option<String>

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.

For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

scheduled_action_description: Option<String>

The description of the scheduled action.

state: Option<ScheduledActionState>

The state of the scheduled action. For example, DISABLED.

next_invocations: Option<Vec<DateTime>>

List of times when the scheduled action will run.

start_time: Option<DateTime>

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

end_time: Option<DateTime>

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

Implementations

impl ScheduledAction

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

The name of the scheduled action.

pub fn target_action(&self) -> Option<&ScheduledActionType>

A JSON format string of the Amazon Redshift API operation with input parameters.

"{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}".

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

The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.

Format of at expressions is "at(yyyy-mm-ddThh:mm:ss)". For example, "at(2016-03-04T17:27:00)".

Format of cron expressions is "cron(Minutes Hours Day-of-month Month Day-of-week Year)". For example, "cron(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.

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

The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf.

For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide.

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

The description of the scheduled action.

pub fn state(&self) -> Option<&ScheduledActionState>

The state of the scheduled action. For example, DISABLED.

pub fn next_invocations(&self) -> Option<&[DateTime]>

List of times when the scheduled action will run.

pub fn start_time(&self) -> Option<&DateTime>

The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.

pub fn end_time(&self) -> Option<&DateTime>

The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.

impl ScheduledAction

pub fn builder() -> Builder

Creates a new builder-style object to manufacture ScheduledAction

Trait Implementations

impl Clone for ScheduledAction

fn clone(&self) -> ScheduledAction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScheduledAction

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

Formats the value using the given formatter.

impl PartialEq<ScheduledAction> for ScheduledAction

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

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

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

This method tests for !=.

impl StructuralPartialEq for ScheduledAction