« blib/lib/Paws/DynamoDB/RestoreTableFromBackupOutput.pm
↑ Summary
blib/lib/Paws/DynamoDB/RestoreTableToPointInTimeOutput.pm »
| 1 | |||
| 2 | package Paws::DynamoDB::RestoreTableToPointInTime; | ||
| 3 | use Moose; | ||
| 4 | has BillingModeOverride => (is => 'ro', isa => 'Str'); | ||
| 5 | has GlobalSecondaryIndexOverride => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::GlobalSecondaryIndex]'); | ||
| 6 | has LocalSecondaryIndexOverride => (is => 'ro', isa => 'ArrayRef[Paws::DynamoDB::LocalSecondaryIndex]'); | ||
| 7 | has ProvisionedThroughputOverride => (is => 'ro', isa => 'Paws::DynamoDB::ProvisionedThroughput'); | ||
| 8 | has RestoreDateTime => (is => 'ro', isa => 'Str'); | ||
| 9 | has SourceTableArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has SourceTableName => (is => 'ro', isa => 'Str'); | ||
| 11 | has SSESpecificationOverride => (is => 'ro', isa => 'Paws::DynamoDB::SSESpecification'); | ||
| 12 | has TargetTableName => (is => 'ro', isa => 'Str', required => 1); | ||
| 13 | has UseLatestRestorableTime => (is => 'ro', isa => 'Bool'); | ||
| 14 | |||
| 15 | use MooseX::ClassAttribute; | ||
| 16 | |||
| 17 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'RestoreTableToPointInTime'); | ||
| 18 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DynamoDB::RestoreTableToPointInTimeOutput'); | ||
| 19 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::DynamoDB::RestoreTableToPointInTime - Arguments for method RestoreTableToPointInTime on L<Paws::DynamoDB> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method RestoreTableToPointInTime on the | ||
| 31 | L<Amazon DynamoDB|Paws::DynamoDB> service. Use the attributes of this class | ||
| 32 | as arguments to method RestoreTableToPointInTime. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to RestoreTableToPointInTime. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $dynamodb = Paws->service('DynamoDB'); | ||
| 39 | my $RestoreTableToPointInTimeOutput = $dynamodb->RestoreTableToPointInTime( | ||
| 40 | TargetTableName => 'MyTableName', | ||
| 41 | BillingModeOverride => 'PROVISIONED', # OPTIONAL | ||
| 42 | GlobalSecondaryIndexOverride => [ | ||
| 43 | { | ||
| 44 | IndexName => 'MyIndexName', # min: 3, max: 255 | ||
| 45 | KeySchema => [ | ||
| 46 | { | ||
| 47 | AttributeName => 'MyKeySchemaAttributeName', # min: 1, max: 255 | ||
| 48 | KeyType => 'HASH', # values: HASH, RANGE | ||
| 49 | |||
| 50 | }, | ||
| 51 | ... | ||
| 52 | ], # min: 1, max: 2 | ||
| 53 | Projection => { | ||
| 54 | NonKeyAttributes => [ | ||
| 55 | 'MyNonKeyAttributeName', ... # min: 1, max: 255 | ||
| 56 | ], # min: 1, max: 20; OPTIONAL | ||
| 57 | ProjectionType => 'ALL', # values: ALL, KEYS_ONLY, INCLUDE; OPTIONAL | ||
| 58 | }, | ||
| 59 | ProvisionedThroughput => { | ||
| 60 | ReadCapacityUnits => 1, # min: 1 | ||
| 61 | WriteCapacityUnits => 1, # min: 1 | ||
| 62 | |||
| 63 | }, # OPTIONAL | ||
| 64 | }, | ||
| 65 | ... | ||
| 66 | ], # OPTIONAL | ||
| 67 | LocalSecondaryIndexOverride => [ | ||
| 68 | { | ||
| 69 | IndexName => 'MyIndexName', # min: 3, max: 255 | ||
| 70 | KeySchema => [ | ||
| 71 | { | ||
| 72 | AttributeName => 'MyKeySchemaAttributeName', # min: 1, max: 255 | ||
| 73 | KeyType => 'HASH', # values: HASH, RANGE | ||
| 74 | |||
| 75 | }, | ||
| 76 | ... | ||
| 77 | ], # min: 1, max: 2 | ||
| 78 | Projection => { | ||
| 79 | NonKeyAttributes => [ | ||
| 80 | 'MyNonKeyAttributeName', ... # min: 1, max: 255 | ||
| 81 | ], # min: 1, max: 20; OPTIONAL | ||
| 82 | ProjectionType => 'ALL', # values: ALL, KEYS_ONLY, INCLUDE; OPTIONAL | ||
| 83 | }, | ||
| 84 | |||
| 85 | }, | ||
| 86 | ... | ||
| 87 | ], # OPTIONAL | ||
| 88 | ProvisionedThroughputOverride => { | ||
| 89 | ReadCapacityUnits => 1, # min: 1 | ||
| 90 | WriteCapacityUnits => 1, # min: 1 | ||
| 91 | |||
| 92 | }, # OPTIONAL | ||
| 93 | RestoreDateTime => '1970-01-01T01:00:00', # OPTIONAL | ||
| 94 | SSESpecificationOverride => { | ||
| 95 | Enabled => 1, # OPTIONAL | ||
| 96 | KMSMasterKeyId => 'MyKMSMasterKeyId', # OPTIONAL | ||
| 97 | SSEType => 'AES256', # values: AES256, KMS; OPTIONAL | ||
| 98 | }, # OPTIONAL | ||
| 99 | SourceTableArn => 'MyTableArn', # OPTIONAL | ||
| 100 | SourceTableName => 'MyTableName', # OPTIONAL | ||
| 101 | UseLatestRestorableTime => 1, # OPTIONAL | ||
| 102 | ); | ||
| 103 | |||
| 104 | # Results: | ||
| 105 | my $TableDescription = $RestoreTableToPointInTimeOutput->TableDescription; | ||
| 106 | |||
| 107 | # Returns a L<Paws::DynamoDB::RestoreTableToPointInTimeOutput> object. | ||
| 108 | |||
| 109 | 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. | ||
| 110 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/dynamodb/RestoreTableToPointInTime> | ||
| 111 | |||
| 112 | =head1 ATTRIBUTES | ||
| 113 | |||
| 114 | |||
| 115 | =head2 BillingModeOverride => Str | ||
| 116 | |||
| 117 | The billing mode of the restored table. | ||
| 118 | |||
| 119 | Valid values are: C<"PROVISIONED">, C<"PAY_PER_REQUEST"> | ||
| 120 | |||
| 121 | =head2 GlobalSecondaryIndexOverride => ArrayRef[L<Paws::DynamoDB::GlobalSecondaryIndex>] | ||
| 122 | |||
| 123 | List of global secondary indexes for the restored table. The indexes | ||
| 124 | provided should match existing secondary indexes. You can choose to | ||
| 125 | exclude some or all of the indexes at the time of restore. | ||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head2 LocalSecondaryIndexOverride => ArrayRef[L<Paws::DynamoDB::LocalSecondaryIndex>] | ||
| 130 | |||
| 131 | List of local secondary indexes for the restored table. The indexes | ||
| 132 | provided should match existing secondary indexes. You can choose to | ||
| 133 | exclude some or all of the indexes at the time of restore. | ||
| 134 | |||
| 135 | |||
| 136 | |||
| 137 | =head2 ProvisionedThroughputOverride => L<Paws::DynamoDB::ProvisionedThroughput> | ||
| 138 | |||
| 139 | Provisioned throughput settings for the restored table. | ||
| 140 | |||
| 141 | |||
| 142 | |||
| 143 | =head2 RestoreDateTime => Str | ||
| 144 | |||
| 145 | Time in the past to restore the table to. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head2 SourceTableArn => Str | ||
| 150 | |||
| 151 | The DynamoDB table that will be restored. This value is an Amazon | ||
| 152 | Resource Name (ARN). | ||
| 153 | |||
| 154 | |||
| 155 | |||
| 156 | =head2 SourceTableName => Str | ||
| 157 | |||
| 158 | Name of the source table that is being restored. | ||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head2 SSESpecificationOverride => L<Paws::DynamoDB::SSESpecification> | ||
| 163 | |||
| 164 | The new server-side encryption settings for the restored table. | ||
| 165 | |||
| 166 | |||
| 167 | |||
| 168 | =head2 B<REQUIRED> TargetTableName => Str | ||
| 169 | |||
| 170 | The name of the new table to which it must be restored to. | ||
| 171 | |||
| 172 | |||
| 173 | |||
| 174 | =head2 UseLatestRestorableTime => Bool | ||
| 175 | |||
| 176 | Restore the table to the latest possible time. | ||
| 177 | C<LatestRestorableDateTime> is typically 5 minutes before the current | ||
| 178 | time. | ||
| 179 | |||
| 180 | |||
| 181 | |||
| 182 | |||
| 183 | =head1 SEE ALSO | ||
| 184 | |||
| 185 | This class forms part of L<Paws>, documenting arguments for method RestoreTableToPointInTime in L<Paws::DynamoDB> | ||
| 186 | |||
| 187 | =head1 BUGS and CONTRIBUTIONS | ||
| 188 | |||
| 189 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 190 | |||
| 191 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 192 | |||
| 193 | =cut | ||
| 194 |