« blib/lib/Paws/DynamoDB/UpdateGlobalTableOutput.pm
↑ Summary
blib/lib/Paws/DynamoDB/UpdateGlobalTableSettingsOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::UpdateGlobalTableSettings; | ||
| 3 | use Moose; | ||
| 4 | has GlobalTableBillingMode => (is => 'ro', isa => 'Str'); | ||
| 5 | has GlobalTableGlobalSecondaryIndexSettingsUpdate => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::GlobalTableGlobalSecondaryIndexSettingsUpdate]'); | ||
| 6 | has GlobalTableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate => (is => 'ro', isa => 'Paws::DynamoDB::AutoScalingSettingsUpdate'); | ||
| 8 | has GlobalTableProvisionedWriteCapacityUnits => (is => 'ro', isa => 'Int'); | ||
| 9 | has ReplicaSettingsUpdate => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicaSettingsUpdate]'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateGlobalTableSettings'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::UpdateGlobalTableSettingsOutput'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::DynamoDB::UpdateGlobalTableSettings - Arguments for method UpdateGlobalTableSettings on L<Paws::DynamoDB> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method UpdateGlobalTableSettings on the | ||
| 27 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 28 | as arguments to method UpdateGlobalTableSettings. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateGlobalTableSettings. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 35 | my $UpdateGlobalTableSettingsOutput = $dynamodb->UpdateGlobalTableSettings( | ||
| 36 | GlobalTableName => 'MyTableName', | ||
| 37 | GlobalTableBillingMode => 'PROVISIONED', # OPTIONAL | ||
| 38 | GlobalTableGlobalSecondaryIndexSettingsUpdate => [ | ||
| 39 | { | ||
| 40 | IndexName => 'MyIndexName', # min: 3, max: 255 | ||
| 41 | ProvisionedWriteCapacityAutoScalingSettingsUpdate => { | ||
| 42 | AutoScalingDisabled => 1, # OPTIONAL | ||
| 43 | AutoScalingRoleArn => | ||
| 44 | 'MyAutoScalingRoleArn', # min: 1, max: 1600; OPTIONAL | ||
| 45 | MaximumUnits => 1, # min: 1; OPTIONAL | ||
| 46 | MinimumUnits => 1, # min: 1; OPTIONAL | ||
| 47 | ScalingPolicyUpdate => { | ||
| 48 | TargetTrackingScalingPolicyConfiguration => { | ||
| 49 | TargetValue => 1, | ||
| 50 | DisableScaleIn => 1, # OPTIONAL | ||
| 51 | ScaleInCooldown => 1, # OPTIONAL | ||
| 52 | ScaleOutCooldown => 1, # OPTIONAL | ||
| 53 | }, | ||
| 54 | PolicyName => | ||
| 55 | 'MyAutoScalingPolicyName', # min: 1, max: 256; OPTIONAL | ||
| 56 | }, # OPTIONAL | ||
| 57 | }, # OPTIONAL | ||
| 58 | ProvisionedWriteCapacityUnits => 1, # min: 1; OPTIONAL | ||
| 59 | }, | ||
| 60 | ... | ||
| 61 | ], # OPTIONAL | ||
| 62 | GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate => { | ||
| 63 | AutoScalingDisabled => 1, # OPTIONAL | ||
| 64 | AutoScalingRoleArn => | ||
| 65 | 'MyAutoScalingRoleArn', # min: 1, max: 1600; OPTIONAL | ||
| 66 | MaximumUnits => 1, # min: 1; OPTIONAL | ||
| 67 | MinimumUnits => 1, # min: 1; OPTIONAL | ||
| 68 | ScalingPolicyUpdate => { | ||
| 69 | TargetTrackingScalingPolicyConfiguration => { | ||
| 70 | TargetValue => 1, | ||
| 71 | DisableScaleIn => 1, # OPTIONAL | ||
| 72 | ScaleInCooldown => 1, # OPTIONAL | ||
| 73 | ScaleOutCooldown => 1, # OPTIONAL | ||
| 74 | }, | ||
| 75 | PolicyName => 'MyAutoScalingPolicyName', # min: 1, max: 256; OPTIONAL | ||
| 76 | }, # OPTIONAL | ||
| 77 | }, # OPTIONAL | ||
| 78 | GlobalTableProvisionedWriteCapacityUnits => 1, # OPTIONAL | ||
| 79 | ReplicaSettingsUpdate => [ | ||
| 80 | { | ||
| 81 | RegionName => 'MyRegionName', | ||
| 82 | ReplicaGlobalSecondaryIndexSettingsUpdate => [ | ||
| 83 | { | ||
| 84 | IndexName => 'MyIndexName', # min: 3, max: 255 | ||
| 85 | ProvisionedReadCapacityAutoScalingSettingsUpdate => { | ||
| 86 | AutoScalingDisabled => 1, # OPTIONAL | ||
| 87 | AutoScalingRoleArn => | ||
| 88 | 'MyAutoScalingRoleArn', # min: 1, max: 1600; OPTIONAL | ||
| 89 | MaximumUnits => 1, # min: 1; OPTIONAL | ||
| 90 | MinimumUnits => 1, # min: 1; OPTIONAL | ||
| 91 | ScalingPolicyUpdate => { | ||
| 92 | TargetTrackingScalingPolicyConfiguration => { | ||
| 93 | TargetValue => 1, | ||
| 94 | DisableScaleIn => 1, # OPTIONAL | ||
| 95 | ScaleInCooldown => 1, # OPTIONAL | ||
| 96 | ScaleOutCooldown => 1, # OPTIONAL | ||
| 97 | }, | ||
| 98 | PolicyName => | ||
| 99 | 'MyAutoScalingPolicyName', # min: 1, max: 256; OPTIONAL | ||
| 100 | }, # OPTIONAL | ||
| 101 | }, # OPTIONAL | ||
| 102 | ProvisionedReadCapacityUnits => 1, # min: 1; OPTIONAL | ||
| 103 | }, | ||
| 104 | ... | ||
| 105 | ], # min: 1, max: 20; OPTIONAL | ||
| 106 | ReplicaProvisionedReadCapacityAutoScalingSettingsUpdate => { | ||
| 107 | AutoScalingDisabled => 1, # OPTIONAL | ||
| 108 | AutoScalingRoleArn => | ||
| 109 | 'MyAutoScalingRoleArn', # min: 1, max: 1600; OPTIONAL | ||
| 110 | MaximumUnits => 1, # min: 1; OPTIONAL | ||
| 111 | MinimumUnits => 1, # min: 1; OPTIONAL | ||
| 112 | ScalingPolicyUpdate => { | ||
| 113 | TargetTrackingScalingPolicyConfiguration => { | ||
| 114 | TargetValue => 1, | ||
| 115 | DisableScaleIn => 1, # OPTIONAL | ||
| 116 | ScaleInCooldown => 1, # OPTIONAL | ||
| 117 | ScaleOutCooldown => 1, # OPTIONAL | ||
| 118 | }, | ||
| 119 | PolicyName => | ||
| 120 | 'MyAutoScalingPolicyName', # min: 1, max: 256; OPTIONAL | ||
| 121 | }, # OPTIONAL | ||
| 122 | }, # OPTIONAL | ||
| 123 | ReplicaProvisionedReadCapacityUnits => 1, # min: 1; OPTIONAL | ||
| 124 | }, | ||
| 125 | ... | ||
| 126 | ], # OPTIONAL | ||
| 127 | ); | ||
| 128 | |||
| 129 | # Results: | ||
| 130 | my $GlobalTableName = $UpdateGlobalTableSettingsOutput->GlobalTableName; | ||
| 131 | my $ReplicaSettings = $UpdateGlobalTableSettingsOutput->ReplicaSettings; | ||
| 132 | |||
| 133 | # Returns a L<Paws::DynamoDB::UpdateGlobalTableSettingsOutput> object. | ||
| 134 | |||
| 135 | 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. | ||
| 136 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/UpdateGlobalTableSettings> | ||
| 137 | |||
| 138 | =head1 ATTRIBUTES | ||
| 139 | |||
| 140 | |||
| 141 | =head2 GlobalTableBillingMode => Str | ||
| 142 | |||
| 143 | The billing mode of the global table. If C<GlobalTableBillingMode> is | ||
| 144 | not specified, the global table defaults to C<PROVISIONED> capacity | ||
| 145 | billing mode. | ||
| 146 | |||
| 147 | =over | ||
| 148 | |||
| 149 | =item * | ||
| 150 | |||
| 151 | C<PROVISIONED> - We recommend using C<PROVISIONED> for predictable | ||
| 152 | workloads. C<PROVISIONED> sets the billing mode to Provisioned Mode | ||
| 153 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). | ||
| 154 | |||
| 155 | =item * | ||
| 156 | |||
| 157 | C<PAY_PER_REQUEST> - We recommend using C<PAY_PER_REQUEST> for | ||
| 158 | unpredictable workloads. C<PAY_PER_REQUEST> sets the billing mode to | ||
| 159 | On-Demand Mode | ||
| 160 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). | ||
| 161 | |||
| 162 | =back | ||
| 163 | |||
| 164 | |||
| 165 | Valid values are: C<"PROVISIONED">, C<"PAY_PER_REQUEST"> | ||
| 166 | |||
| 167 | =head2 GlobalTableGlobalSecondaryIndexSettingsUpdate => ArrayRef[L<Paws::DynamoDB::GlobalTableGlobalSecondaryIndexSettingsUpdate>] | ||
| 168 | |||
| 169 | Represents the settings of a global secondary index for a global table | ||
| 170 | that will be modified. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 B<REQUIRED> GlobalTableName => Str | ||
| 175 | |||
| 176 | The name of the global table | ||
| 177 | |||
| 178 | |||
| 179 | |||
| 180 | =head2 GlobalTableProvisionedWriteCapacityAutoScalingSettingsUpdate => L<Paws::DynamoDB::AutoScalingSettingsUpdate> | ||
| 181 | |||
| 182 | Auto scaling settings for managing provisioned write capacity for the | ||
| 183 | global table. | ||
| 184 | |||
| 185 | |||
| 186 | |||
| 187 | =head2 GlobalTableProvisionedWriteCapacityUnits => Int | ||
| 188 | |||
| 189 | The maximum number of writes consumed per second before DynamoDB | ||
| 190 | returns a C<ThrottlingException.> | ||
| 191 | |||
| 192 | |||
| 193 | |||
| 194 | =head2 ReplicaSettingsUpdate => ArrayRef[L<Paws::DynamoDB::ReplicaSettingsUpdate>] | ||
| 195 | |||
| 196 | Represents the settings for a global table in a Region that will be | ||
| 197 | modified. | ||
| 198 | |||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | =head1 SEE ALSO | ||
| 203 | |||
| 204 | This class forms part of L<Paws>, documenting arguments for method UpdateGlobalTableSettings in L<Paws::DynamoDB> | ||
| 205 | |||
| 206 | =head1 BUGS and CONTRIBUTIONS | ||
| 207 | |||
| 208 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 209 | |||
| 210 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 211 | |||
| 212 | =cut | ||
| 213 |