« blib/lib/Paws/RedShift/CreateHsmConfigurationResult.pm
↑ Summary
blib/lib/Paws/RedShift/CreateSnapshotCopyGrant.pm »
| 1 | |||
| 2 | package Paws::RedShift::CreateScheduledAction; | ||
| 3 | use Moose; | ||
| 4 | has Enable => (is => 'ro', isa => 'Bool'); | ||
| 5 | has EndTime => (is => 'ro', isa => 'Str'); | ||
| 6 | has IamRole => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has Schedule => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has ScheduledActionDescription => (is => 'ro', isa => 'Str'); | ||
| 9 | has ScheduledActionName => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has StartTime => (is => 'ro', isa => 'Str'); | ||
| 11 | has TargetAction => (is => 'ro', isa => 'Paws::RedShift::ScheduledActionType', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateScheduledAction'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::ScheduledAction'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateScheduledActionResult'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::RedShift::CreateScheduledAction - Arguments for method CreateScheduledAction on L<Paws::RedShift> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method CreateScheduledAction on the | ||
| 29 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 30 | as arguments to method CreateScheduledAction. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateScheduledAction. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $redshift = Paws->service('RedShift'); | ||
| 37 | my $ScheduledAction = $redshift->CreateScheduledAction( | ||
| 38 | IamRole => 'MyString', | ||
| 39 | Schedule => 'MyString', | ||
| 40 | ScheduledActionName => 'MyString', | ||
| 41 | TargetAction => { | ||
| 42 | PauseCluster => { | ||
| 43 | ClusterIdentifier => 'MyString', # max: 2147483647 | ||
| 44 | |||
| 45 | }, # OPTIONAL | ||
| 46 | ResizeCluster => { | ||
| 47 | ClusterIdentifier => 'MyString', # max: 2147483647 | ||
| 48 | Classic => 1, # OPTIONAL | ||
| 49 | ClusterType => 'MyString', # max: 2147483647 | ||
| 50 | NodeType => 'MyString', # max: 2147483647 | ||
| 51 | NumberOfNodes => 1, # OPTIONAL | ||
| 52 | }, # OPTIONAL | ||
| 53 | ResumeCluster => { | ||
| 54 | ClusterIdentifier => 'MyString', # max: 2147483647 | ||
| 55 | |||
| 56 | }, # OPTIONAL | ||
| 57 | }, | ||
| 58 | Enable => 1, # OPTIONAL | ||
| 59 | EndTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 60 | ScheduledActionDescription => 'MyString', # OPTIONAL | ||
| 61 | StartTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 62 | ); | ||
| 63 | |||
| 64 | # Results: | ||
| 65 | my $EndTime = $ScheduledAction->EndTime; | ||
| 66 | my $IamRole = $ScheduledAction->IamRole; | ||
| 67 | my $NextInvocations = $ScheduledAction->NextInvocations; | ||
| 68 | my $Schedule = $ScheduledAction->Schedule; | ||
| 69 | my $ScheduledActionDescription = | ||
| 70 | $ScheduledAction->ScheduledActionDescription; | ||
| 71 | my $ScheduledActionName = $ScheduledAction->ScheduledActionName; | ||
| 72 | my $StartTime = $ScheduledAction->StartTime; | ||
| 73 | my $State = $ScheduledAction->State; | ||
| 74 | my $TargetAction = $ScheduledAction->TargetAction; | ||
| 75 | |||
| 76 | # Returns a L<Paws::RedShift::ScheduledAction> object. | ||
| 77 | |||
| 78 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 79 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateScheduledAction> | ||
| 80 | |||
| 81 | =head1 ATTRIBUTES | ||
| 82 | |||
| 83 | |||
| 84 | =head2 Enable => Bool | ||
| 85 | |||
| 86 | If true, the schedule is enabled. If false, the scheduled action does | ||
| 87 | not trigger. For more information about C<state> of the scheduled | ||
| 88 | action, see ScheduledAction. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 EndTime => Str | ||
| 93 | |||
| 94 | The end time in UTC of the scheduled action. After this time, the | ||
| 95 | scheduled action does not trigger. For more information about this | ||
| 96 | parameter, see ScheduledAction. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 B<REQUIRED> IamRole => Str | ||
| 101 | |||
| 102 | The IAM role to assume to run the target action. For more information | ||
| 103 | about this parameter, see ScheduledAction. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> Schedule => Str | ||
| 108 | |||
| 109 | The schedule in C<at( )> or C<cron( )> format. For more information | ||
| 110 | about this parameter, see ScheduledAction. | ||
| 111 | |||
| 112 | |||
| 113 | |||
| 114 | =head2 ScheduledActionDescription => Str | ||
| 115 | |||
| 116 | The description of the scheduled action. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | =head2 B<REQUIRED> ScheduledActionName => Str | ||
| 121 | |||
| 122 | The name of the scheduled action. The name must be unique within an | ||
| 123 | account. For more information about this parameter, see | ||
| 124 | ScheduledAction. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 StartTime => Str | ||
| 129 | |||
| 130 | The start time in UTC of the scheduled action. Before this time, the | ||
| 131 | scheduled action does not trigger. For more information about this | ||
| 132 | parameter, see ScheduledAction. | ||
| 133 | |||
| 134 | |||
| 135 | |||
| 136 | =head2 B<REQUIRED> TargetAction => L<Paws::RedShift::ScheduledActionType> | ||
| 137 | |||
| 138 | A JSON format string of the Amazon Redshift API operation with input | ||
| 139 | parameters. For more information about this parameter, see | ||
| 140 | ScheduledAction. | ||
| 141 | |||
| 142 | |||
| 143 | |||
| 144 | |||
| 145 | =head1 SEE ALSO | ||
| 146 | |||
| 147 | This class forms part of L<Paws>, documenting arguments for method CreateScheduledAction in L<Paws::RedShift> | ||
| 148 | |||
| 149 | =head1 BUGS and CONTRIBUTIONS | ||
| 150 | |||
| 151 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 152 | |||
| 153 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 154 | |||
| 155 | =cut | ||
| 156 |