« blib/lib/Paws/RedShift/RotateEncryptionKeyResult.pm
↑ Summary
blib/lib/Paws/RedShift/ScheduledActionFilter.pm »
| 1 | |||
| 2 | package Paws::RedShift::ScheduledAction; | ||
| 3 | use Moose; | ||
| 4 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 5 | has IamRole => (is => 'ro', isa => 'Str'); | ||
| 6 | has NextInvocations => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'ScheduledActionTime', traits => ['NameInRequest',]); | ||
| 7 | has Schedule => (is => 'ro', isa => 'Str'); | ||
| 8 | has ScheduledActionDescription => (is => 'ro', isa => 'Str'); | ||
| 9 | has ScheduledActionName => (is => 'ro', isa => 'Str'); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has State => (is => 'ro', isa => 'Str'); | ||
| 12 | has TargetAction => (is => 'ro', isa => 'Paws::RedShift::ScheduledActionType'); | ||
| 13 | |||
| 14 | has _request_id => (is => 'ro', isa => 'Str'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::RedShift::ScheduledAction | ||
| 22 | |||
| 23 | =head1 ATTRIBUTES | ||
| 24 | |||
| 25 | |||
| 26 | =head2 EndTime => Str | ||
| 27 | |||
| 28 | The end time in UTC when the schedule is no longer active. After this | ||
| 29 | time, the scheduled action does not trigger. | ||
| 30 | |||
| 31 | |||
| 32 | =head2 IamRole => Str | ||
| 33 | |||
| 34 | The IAM role to assume to run the scheduled action. This IAM role must | ||
| 35 | have permission to run the Amazon Redshift API operation in the | ||
| 36 | scheduled action. This IAM role must allow the Amazon Redshift | ||
| 37 | scheduler (Principal scheduler.redshift.amazonaws.com) to assume | ||
| 38 | permissions on your behalf. For more information about the IAM role to | ||
| 39 | use with the Amazon Redshift scheduler, see Using Identity-Based | ||
| 40 | Policies for Amazon Redshift | ||
| 41 | (https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html) | ||
| 42 | in the I<Amazon Redshift Cluster Management Guide>. | ||
| 43 | |||
| 44 | |||
| 45 | =head2 NextInvocations => ArrayRef[Str|Undef] | ||
| 46 | |||
| 47 | List of times when the scheduled action will run. | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Schedule => Str | ||
| 51 | |||
| 52 | The schedule for a one-time (at format) or recurring (cron format) | ||
| 53 | scheduled action. Schedule invocations must be separated by at least | ||
| 54 | one hour. | ||
| 55 | |||
| 56 | Format of at expressions is "C<at(yyyy-mm-ddThh:mm:ss)>". For example, | ||
| 57 | "C<at(2016-03-04T17:27:00)>". | ||
| 58 | |||
| 59 | Format of cron expressions is "C<cron(Minutes Hours Day-of-month Month | ||
| 60 | Day-of-week Year)>". For example, "C<cron(0 10 ? * MON *)>". For more | ||
| 61 | information, see Cron Expressions | ||
| 62 | (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions) | ||
| 63 | in the I<Amazon CloudWatch Events User Guide>. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 ScheduledActionDescription => Str | ||
| 67 | |||
| 68 | The description of the scheduled action. | ||
| 69 | |||
| 70 | |||
| 71 | =head2 ScheduledActionName => Str | ||
| 72 | |||
| 73 | The name of the scheduled action. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 StartTime => Str | ||
| 77 | |||
| 78 | The start time in UTC when the schedule is active. Before this time, | ||
| 79 | the scheduled action does not trigger. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 State => Str | ||
| 83 | |||
| 84 | The state of the scheduled action. For example, C<DISABLED>. | ||
| 85 | |||
| 86 | Valid values are: C<"ACTIVE">, C<"DISABLED"> | ||
| 87 | =head2 TargetAction => L<Paws::RedShift::ScheduledActionType> | ||
| 88 | |||
| 89 | A JSON format string of the Amazon Redshift API operation with input | ||
| 90 | parameters. | ||
| 91 | |||
| 92 | "C<{\"ResizeCluster\":{\"NodeType\":\"ds2.8xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}>". | ||
| 93 | |||
| 94 | |||
| 95 | =head2 _request_id => Str | ||
| 96 | |||
| 97 | |||
| 98 | =cut | ||
| 99 |