| 1 | |||
| 2 | package Paws::RedShift::CreateUsageLimit; | ||
| 3 | use Moose; | ||
| 4 | has Amount => (is => 'ro', isa => 'Int', required => 1); | ||
| 5 | has BreachAction => (is => 'ro', isa => 'Str'); | ||
| 6 | has ClusterIdentifier => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has FeatureType => (is => 'ro', isa => 'Str', required => 1); | ||
| 8 | has LimitType => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has Period => (is => 'ro', isa => 'Str'); | ||
| 10 | has Tags => (is => 'ro', isa => 'ArrayRef[Paws::RedShift::Tag]'); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateUsageLimit'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::RedShift::UsageLimit'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro', default => 'CreateUsageLimitResult'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::RedShift::CreateUsageLimit - Arguments for method CreateUsageLimit on L<Paws::RedShift> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method CreateUsageLimit on the | ||
| 28 | L<Amazon Redshift|Paws::RedShift> service. Use the attributes of this class | ||
| 29 | as arguments to method CreateUsageLimit. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateUsageLimit. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $redshift = Paws->service('RedShift'); | ||
| 36 | my $UsageLimit = $redshift->CreateUsageLimit( | ||
| 37 | Amount => 1, | ||
| 38 | ClusterIdentifier => 'MyString', | ||
| 39 | FeatureType => 'spectrum', | ||
| 40 | LimitType => 'time', | ||
| 41 | BreachAction => 'log', # OPTIONAL | ||
| 42 | Period => 'daily', # OPTIONAL | ||
| 43 | Tags => [ | ||
| 44 | { | ||
| 45 | Key => 'MyString', # max: 2147483647 | ||
| 46 | Value => 'MyString', # max: 2147483647 | ||
| 47 | }, | ||
| 48 | ... | ||
| 49 | ], # OPTIONAL | ||
| 50 | ); | ||
| 51 | |||
| 52 | # Results: | ||
| 53 | my $Amount = $UsageLimit->Amount; | ||
| 54 | my $BreachAction = $UsageLimit->BreachAction; | ||
| 55 | my $ClusterIdentifier = $UsageLimit->ClusterIdentifier; | ||
| 56 | my $FeatureType = $UsageLimit->FeatureType; | ||
| 57 | my $LimitType = $UsageLimit->LimitType; | ||
| 58 | my $Period = $UsageLimit->Period; | ||
| 59 | my $Tags = $UsageLimit->Tags; | ||
| 60 | my $UsageLimitId = $UsageLimit->UsageLimitId; | ||
| 61 | |||
| 62 | # Returns a L<Paws::RedShift::UsageLimit> object. | ||
| 63 | |||
| 64 | 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. | ||
| 65 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/redshift/CreateUsageLimit> | ||
| 66 | |||
| 67 | =head1 ATTRIBUTES | ||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> Amount => Int | ||
| 71 | |||
| 72 | The limit amount. If time-based, this amount is in minutes. If | ||
| 73 | data-based, this amount is in terabytes (TB). The value must be a | ||
| 74 | positive number. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 BreachAction => Str | ||
| 79 | |||
| 80 | The action that Amazon Redshift takes when the limit is reached. The | ||
| 81 | default is log. For more information about this parameter, see | ||
| 82 | UsageLimit. | ||
| 83 | |||
| 84 | Valid values are: C<"log">, C<"emit-metric">, C<"disable"> | ||
| 85 | |||
| 86 | =head2 B<REQUIRED> ClusterIdentifier => Str | ||
| 87 | |||
| 88 | The identifier of the cluster that you want to limit usage. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | =head2 B<REQUIRED> FeatureType => Str | ||
| 93 | |||
| 94 | The Amazon Redshift feature that you want to limit. | ||
| 95 | |||
| 96 | Valid values are: C<"spectrum">, C<"concurrency-scaling"> | ||
| 97 | |||
| 98 | =head2 B<REQUIRED> LimitType => Str | ||
| 99 | |||
| 100 | The type of limit. Depending on the feature type, this can be based on | ||
| 101 | a time duration or data size. If C<FeatureType> is C<spectrum>, then | ||
| 102 | C<LimitType> must be C<data-scanned>. If C<FeatureType> is | ||
| 103 | C<concurrency-scaling>, then C<LimitType> must be C<time>. | ||
| 104 | |||
| 105 | Valid values are: C<"time">, C<"data-scanned"> | ||
| 106 | |||
| 107 | =head2 Period => Str | ||
| 108 | |||
| 109 | The time period that the amount applies to. A C<weekly> period begins | ||
| 110 | on Sunday. The default is C<monthly>. | ||
| 111 | |||
| 112 | Valid values are: C<"daily">, C<"weekly">, C<"monthly"> | ||
| 113 | |||
| 114 | =head2 Tags => ArrayRef[L<Paws::RedShift::Tag>] | ||
| 115 | |||
| 116 | A list of tag instances. | ||
| 117 | |||
| 118 | |||
| 119 | |||
| 120 | |||
| 121 | =head1 SEE ALSO | ||
| 122 | |||
| 123 | This class forms part of L<Paws>, documenting arguments for method CreateUsageLimit in L<Paws::RedShift> | ||
| 124 | |||
| 125 | =head1 BUGS and CONTRIBUTIONS | ||
| 126 | |||
| 127 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 128 | |||
| 129 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 130 | |||
| 131 | =cut | ||
| 132 |