Class: Aws::RedshiftServerless::Types::UpdateScheduledActionRequest

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftServerless::Types::UpdateScheduledActionRequest

Includes:

Structure

Defined in:

lib/aws-sdk-redshiftserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Specifies whether to enable the scheduled action.

• #end_time ⇒ Time

  The end time in UTC of the scheduled action to update.

• #role_arn ⇒ String

  The ARN of the IAM role to assume to run the scheduled action.

• #schedule ⇒ Types::Schedule

  The schedule for a one-time (at format) or recurring (cron format) scheduled action.

• #scheduled_action_description ⇒ String

  The descripion of the scheduled action to update to.

• #scheduled_action_name ⇒ String

  The name of the scheduled action to update to.

• #start_time ⇒ Time

  The start time in UTC of the scheduled action to update to.

• #target_action ⇒ Types::TargetAction

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

Instance Attribute Details

#enabled ⇒ Boolean

Specifies whether to enable the scheduled action.

Returns:

• (Boolean)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The end time in UTC of the scheduled action to update.

Returns:

• (Time)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

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 [Using Identity-Based Policies for Amazon Redshift] in the Amazon Redshift Cluster Management Guide

[1]: docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html

Returns:

• (String)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#schedule ⇒ Types::Schedule

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*.

[1]: docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions

Returns:

• (Types::Schedule)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_action_description ⇒ String

The descripion of the scheduled action to update to.

Returns:

• (String)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#scheduled_action_name ⇒ String

The name of the scheduled action to update to.

Returns:

• (String)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The start time in UTC of the scheduled action to update to.

Returns:

• (Time)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end

#target_action ⇒ Types::TargetAction

A JSON format string of the Amazon Redshift Serverless API operation with input parameters. The following is an example of a target action.

‘“{”NamespaceName“: ”sampleNamespace“,”SnapshotName“: ”sampleSnapshot“, ”retentionPeriod“: ”1“}”`

Returns:

• (Types::TargetAction)

# File 'lib/aws-sdk-redshiftserverless/types.rb', line 3237

class UpdateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :role_arn,
  :schedule,
  :scheduled_action_description,
  :scheduled_action_name,
  :start_time,
  :target_action)
  SENSITIVE = []
  include Aws::Structure
end