// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateScheduledActionInput {
/// <p>The name of the scheduled action.</p>
pub scheduled_action_name: ::std::option::Option<::std::string::String>,
/// <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
/// <p><code>"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"</code></p>
pub target_action: ::std::option::Option<crate::types::TargetAction>,
/// <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p>
/// <ul>
/// <li>
/// <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p></li>
/// <li>
/// <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p></li>
/// </ul>
pub schedule: ::std::option::Option<crate::types::Schedule>,
/// <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
pub role_arn: ::std::option::Option<::std::string::String>,
/// <p>The name of the namespace for which to create a scheduled action.</p>
pub namespace_name: ::std::option::Option<::std::string::String>,
/// <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
pub enabled: ::std::option::Option<bool>,
/// <p>The description of the scheduled action.</p>
pub scheduled_action_description: ::std::option::Option<::std::string::String>,
/// <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
pub start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
/// <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
pub end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl CreateScheduledActionInput {
/// <p>The name of the scheduled action.</p>
pub fn scheduled_action_name(&self) -> ::std::option::Option<&str> {
self.scheduled_action_name.as_deref()
}
/// <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
/// <p><code>"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"</code></p>
pub fn target_action(&self) -> ::std::option::Option<&crate::types::TargetAction> {
self.target_action.as_ref()
}
/// <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p>
/// <ul>
/// <li>
/// <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p></li>
/// <li>
/// <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p></li>
/// </ul>
pub fn schedule(&self) -> ::std::option::Option<&crate::types::Schedule> {
self.schedule.as_ref()
}
/// <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
pub fn role_arn(&self) -> ::std::option::Option<&str> {
self.role_arn.as_deref()
}
/// <p>The name of the namespace for which to create a scheduled action.</p>
pub fn namespace_name(&self) -> ::std::option::Option<&str> {
self.namespace_name.as_deref()
}
/// <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
pub fn enabled(&self) -> ::std::option::Option<bool> {
self.enabled
}
/// <p>The description of the scheduled action.</p>
pub fn scheduled_action_description(&self) -> ::std::option::Option<&str> {
self.scheduled_action_description.as_deref()
}
/// <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
pub fn start_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.start_time.as_ref()
}
/// <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
pub fn end_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
self.end_time.as_ref()
}
}
impl CreateScheduledActionInput {
/// Creates a new builder-style object to manufacture [`CreateScheduledActionInput`](crate::operation::create_scheduled_action::CreateScheduledActionInput).
pub fn builder() -> crate::operation::create_scheduled_action::builders::CreateScheduledActionInputBuilder {
crate::operation::create_scheduled_action::builders::CreateScheduledActionInputBuilder::default()
}
}
/// A builder for [`CreateScheduledActionInput`](crate::operation::create_scheduled_action::CreateScheduledActionInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateScheduledActionInputBuilder {
pub(crate) scheduled_action_name: ::std::option::Option<::std::string::String>,
pub(crate) target_action: ::std::option::Option<crate::types::TargetAction>,
pub(crate) schedule: ::std::option::Option<crate::types::Schedule>,
pub(crate) role_arn: ::std::option::Option<::std::string::String>,
pub(crate) namespace_name: ::std::option::Option<::std::string::String>,
pub(crate) enabled: ::std::option::Option<bool>,
pub(crate) scheduled_action_description: ::std::option::Option<::std::string::String>,
pub(crate) start_time: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) end_time: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl CreateScheduledActionInputBuilder {
/// <p>The name of the scheduled action.</p>
/// This field is required.
pub fn scheduled_action_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scheduled_action_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the scheduled action.</p>
pub fn set_scheduled_action_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scheduled_action_name = input;
self
}
/// <p>The name of the scheduled action.</p>
pub fn get_scheduled_action_name(&self) -> &::std::option::Option<::std::string::String> {
&self.scheduled_action_name
}
/// <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
/// <p><code>"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"</code></p>
/// This field is required.
pub fn target_action(mut self, input: crate::types::TargetAction) -> Self {
self.target_action = ::std::option::Option::Some(input);
self
}
/// <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
/// <p><code>"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"</code></p>
pub fn set_target_action(mut self, input: ::std::option::Option<crate::types::TargetAction>) -> Self {
self.target_action = input;
self
}
/// <p>A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.</p>
/// <p><code>"{"CreateSnapshot": {"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"}}"</code></p>
pub fn get_target_action(&self) -> &::std::option::Option<crate::types::TargetAction> {
&self.target_action
}
/// <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p>
/// <ul>
/// <li>
/// <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p></li>
/// <li>
/// <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p></li>
/// </ul>
/// This field is required.
pub fn schedule(mut self, input: crate::types::Schedule) -> Self {
self.schedule = ::std::option::Option::Some(input);
self
}
/// <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p>
/// <ul>
/// <li>
/// <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p></li>
/// <li>
/// <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p></li>
/// </ul>
pub fn set_schedule(mut self, input: ::std::option::Option<crate::types::Schedule>) -> Self {
self.schedule = input;
self
}
/// <p>The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.</p>
/// <ul>
/// <li>
/// <p>Format of at timestamp is <code>yyyy-mm-ddThh:mm:ss</code>. For example, <code>2016-03-04T17:27:00</code>.</p></li>
/// <li>
/// <p>Format of cron expression is <code>(Minutes Hours Day-of-month Month Day-of-week Year)</code>. For example, <code>"(0 10 ? * MON *)"</code>. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p></li>
/// </ul>
pub fn get_schedule(&self) -> &::std::option::Option<crate::types::Schedule> {
&self.schedule
}
/// <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
/// This field is required.
pub fn role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
pub fn set_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_arn = input;
self
}
/// <p>The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (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 <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the Amazon Redshift Management Guide</p>
pub fn get_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.role_arn
}
/// <p>The name of the namespace for which to create a scheduled action.</p>
/// This field is required.
pub fn namespace_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.namespace_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the namespace for which to create a scheduled action.</p>
pub fn set_namespace_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.namespace_name = input;
self
}
/// <p>The name of the namespace for which to create a scheduled action.</p>
pub fn get_namespace_name(&self) -> &::std::option::Option<::std::string::String> {
&self.namespace_name
}
/// <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
pub fn enabled(mut self, input: bool) -> Self {
self.enabled = ::std::option::Option::Some(input);
self
}
/// <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
pub fn set_enabled(mut self, input: ::std::option::Option<bool>) -> Self {
self.enabled = input;
self
}
/// <p>Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about <code>state</code> of the scheduled action, see <a href="https://docs.aws.amazon.com/redshift-serverless/latest/APIReference/API_ScheduledAction.html">ScheduledAction</a>.</p>
pub fn get_enabled(&self) -> &::std::option::Option<bool> {
&self.enabled
}
/// <p>The description of the scheduled action.</p>
pub fn scheduled_action_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.scheduled_action_description = ::std::option::Option::Some(input.into());
self
}
/// <p>The description of the scheduled action.</p>
pub fn set_scheduled_action_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.scheduled_action_description = input;
self
}
/// <p>The description of the scheduled action.</p>
pub fn get_scheduled_action_description(&self) -> &::std::option::Option<::std::string::String> {
&self.scheduled_action_description
}
/// <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
pub fn start_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.start_time = ::std::option::Option::Some(input);
self
}
/// <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
pub fn set_start_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.start_time = input;
self
}
/// <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
pub fn get_start_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.start_time
}
/// <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
pub fn end_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.end_time = ::std::option::Option::Some(input);
self
}
/// <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
pub fn set_end_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.end_time = input;
self
}
/// <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
pub fn get_end_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.end_time
}
/// Consumes the builder and constructs a [`CreateScheduledActionInput`](crate::operation::create_scheduled_action::CreateScheduledActionInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_scheduled_action::CreateScheduledActionInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::create_scheduled_action::CreateScheduledActionInput {
scheduled_action_name: self.scheduled_action_name,
target_action: self.target_action,
schedule: self.schedule,
role_arn: self.role_arn,
namespace_name: self.namespace_name,
enabled: self.enabled,
scheduled_action_description: self.scheduled_action_description,
start_time: self.start_time,
end_time: self.end_time,
})
}
}