« blib/lib/Paws/DynamoDB/UpdateReplicationGroupMemberAction.pm
↑ Summary
blib/lib/Paws/DynamoDB/UpdateTableOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::UpdateTable; | ||
| 3 | use Moose; | ||
| 4 | has AttributeDefinitions => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::AttributeDefinition]'); | ||
| 5 | has BillingMode => (is => 'ro', isa => 'Str'); | ||
| 6 | has GlobalSecondaryIndexUpdates => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::GlobalSecondaryIndexUpdate]'); | ||
| 7 | has ProvisionedThroughput => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughput'); | ||
| 8 | has ReplicaUpdates => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::ReplicationGroupUpdate]'); | ||
| 9 | has SSESpecification => (is => 'ro', isa => 'Paws::DynamoDB::SSESpecification'); | ||
| 10 | has StreamSpecification => (is => 'ro', isa => 'Paws::DynamoDB::StreamSpecification'); | ||
| 11 | has TableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateTable'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::UpdateTableOutput'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::DynamoDB::UpdateTable - Arguments for method UpdateTable on L<Paws::DynamoDB> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateTable on the | ||
| 29 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateTable. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateTable. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 37 | # To modify a table's provisioned throughput | ||
| 38 | # This example increases the provisioned read and write capacity on the Music | ||
| 39 | # table. | ||
| 40 | my $UpdateTableOutput = $dynamodb->UpdateTable( | ||
| 41 | 'ProvisionedThroughput' => { | ||
| 42 | 'ReadCapacityUnits' => 10, | ||
| 43 | 'WriteCapacityUnits' => 10 | ||
| 44 | }, | ||
| 45 | 'TableName' => 'MusicCollection' | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $TableDescription = $UpdateTableOutput->TableDescription; | ||
| 50 | |||
| 51 | # Returns a L<Paws::DynamoDB::UpdateTableOutput> object. | ||
| 52 | |||
| 53 | 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. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/UpdateTable> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 AttributeDefinitions => ArrayRef[L<Paws::DynamoDB::AttributeDefinition>] | ||
| 60 | |||
| 61 | An array of attributes that describe the key schema for the table and | ||
| 62 | indexes. If you are adding a new global secondary index to the table, | ||
| 63 | C<AttributeDefinitions> must include the key element(s) of the new | ||
| 64 | index. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 BillingMode => Str | ||
| 69 | |||
| 70 | Controls how you are charged for read and write throughput and how you | ||
| 71 | manage capacity. When switching from pay-per-request to provisioned | ||
| 72 | capacity, initial provisioned capacity values must be set. The initial | ||
| 73 | provisioned capacity values are estimated based on the consumed read | ||
| 74 | and write capacity of your table and global secondary indexes over the | ||
| 75 | past 30 minutes. | ||
| 76 | |||
| 77 | =over | ||
| 78 | |||
| 79 | =item * | ||
| 80 | |||
| 81 | C<PROVISIONED> - We recommend using C<PROVISIONED> for predictable | ||
| 82 | workloads. C<PROVISIONED> sets the billing mode to Provisioned Mode | ||
| 83 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.ProvisionedThroughput.Manual). | ||
| 84 | |||
| 85 | =item * | ||
| 86 | |||
| 87 | C<PAY_PER_REQUEST> - We recommend using C<PAY_PER_REQUEST> for | ||
| 88 | unpredictable workloads. C<PAY_PER_REQUEST> sets the billing mode to | ||
| 89 | On-Demand Mode | ||
| 90 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html#HowItWorks.OnDemand). | ||
| 91 | |||
| 92 | =back | ||
| 93 | |||
| 94 | |||
| 95 | Valid values are: C<"PROVISIONED">, C<"PAY_PER_REQUEST"> | ||
| 96 | |||
| 97 | =head2 GlobalSecondaryIndexUpdates => ArrayRef[L<Paws::DynamoDB::GlobalSecondaryIndexUpdate>] | ||
| 98 | |||
| 99 | An array of one or more global secondary indexes for the table. For | ||
| 100 | each index in the array, you can request one action: | ||
| 101 | |||
| 102 | =over | ||
| 103 | |||
| 104 | =item * | ||
| 105 | |||
| 106 | C<Create> - add a new global secondary index to the table. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | C<Update> - modify the provisioned throughput settings of an existing | ||
| 111 | global secondary index. | ||
| 112 | |||
| 113 | =item * | ||
| 114 | |||
| 115 | C<Delete> - remove a global secondary index from the table. | ||
| 116 | |||
| 117 | =back | ||
| 118 | |||
| 119 | You can create or delete only one global secondary index per | ||
| 120 | C<UpdateTable> operation. | ||
| 121 | |||
| 122 | For more information, see Managing Global Secondary Indexes | ||
| 123 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/GSI.OnlineOps.html) | ||
| 124 | in the I<Amazon DynamoDB Developer Guide>. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | =head2 ProvisionedThroughput => L<Paws::DynamoDB::ProvisionedThroughput> | ||
| 129 | |||
| 130 | The new provisioned throughput settings for the specified table or | ||
| 131 | index. | ||
| 132 | |||
| 133 | |||
| 134 | |||
| 135 | =head2 ReplicaUpdates => ArrayRef[L<Paws::DynamoDB::ReplicationGroupUpdate>] | ||
| 136 | |||
| 137 | A list of replica update actions (create, delete, or update) for the | ||
| 138 | table. | ||
| 139 | |||
| 140 | This property only applies to Version 2019.11.21 | ||
| 141 | (https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/globaltables.V2.html) | ||
| 142 | of global tables. | ||
| 143 | |||
| 144 | |||
| 145 | |||
| 146 | =head2 SSESpecification => L<Paws::DynamoDB::SSESpecification> | ||
| 147 | |||
| 148 | The new server-side encryption settings for the specified table. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 StreamSpecification => L<Paws::DynamoDB::StreamSpecification> | ||
| 153 | |||
| 154 | Represents the DynamoDB Streams configuration for the table. | ||
| 155 | |||
| 156 | You receive a C<ResourceInUseException> if you try to enable a stream | ||
| 157 | on a table that already has a stream, or if you try to disable a stream | ||
| 158 | on a table that doesn't have a stream. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 B<REQUIRED> TableName => Str | ||
| 163 | |||
| 164 | The name of the table to be updated. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | |||
| 169 | =head1 SEE ALSO | ||
| 170 | |||
| 171 | This class forms part of L<Paws>, documenting arguments for method UpdateTable in L<Paws::DynamoDB> | ||
| 172 | |||
| 173 | =head1 BUGS and CONTRIBUTIONS | ||
| 174 | |||
| 175 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 176 | |||
| 177 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 178 | |||
| 179 | =cut | ||
| 180 |