Class: Aws::RedshiftServerless::Types::CreateScheduledActionRequest

Inherits:

Struct

• Object
• Struct
• Aws::RedshiftServerless::Types::CreateScheduledActionRequest

Defined in:

gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Indicates whether the schedule is enabled.

• #end_time ⇒ Time

  The end time in UTC when the schedule is no longer active.

• #namespace_name ⇒ String

  The name of the namespace for which to create a scheduled action.

• #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 timestamp format) or recurring (cron format) scheduled action.

• #scheduled_action_description ⇒ String

  The description of the scheduled action.

• #scheduled_action_name ⇒ String

  The name of the scheduled action.

• #start_time ⇒ Time

  The start time in UTC when the schedule is active.

• #target_action ⇒ Types::TargetAction

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

Instance Attribute Details

#enabled ⇒ Boolean

Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.

Returns:

• (Boolean)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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 when the schedule is no longer active. After this time, the scheduled action does not trigger.

Returns:

• (Time)

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

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

#namespace_name ⇒ String

The name of the namespace for which to create a scheduled action.

Returns:

• (String)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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

Returns:

• (String)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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 timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC.

• Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.

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

Returns:

• (Types::Schedule)

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

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

#scheduled_action_description ⇒ String

The description of the scheduled action.

Returns:

• (String)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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.

Returns:

• (String)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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 when the schedule is active. Before this time, the scheduled action does not trigger.

Returns:

• (Time)

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

class CreateScheduledActionRequest < Struct.new(
  :enabled,
  :end_time,
  :namespace_name,
  :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.

"\{"CreateSnapshot": \{"NamespaceName": "sampleNamespace","SnapshotName": "sampleSnapshot", "retentionPeriod": "1"\}\}"

Returns:

• (Types::TargetAction)

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

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