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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-redshiftserverless/lib/aws-sdk-redshiftserverless/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_timeTime

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

Returns:

  • (Time)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_nameString

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

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_arnString

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)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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

#scheduleTypes::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:



415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_descriptionString

The description of the scheduled action.

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_nameString

The name of the scheduled action.

Returns:

  • (String)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_timeTime

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

Returns:

  • (Time)


415
416
417
418
419
420
421
422
423
424
425
426
427
# 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_actionTypes::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:



415
416
417
418
419
420
421
422
423
424
425
426
427
# 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