@aws-sdk/client-backup 3.51.0 → 3.54.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/BackupServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +179 -4
- package/dist-cjs/protocols/Aws_restJson1.js +653 -2416
- package/dist-es/index.js +1 -0
- package/dist-es/models/BackupServiceException.js +12 -0
- package/dist-es/models/models_0.js +166 -1
- package/dist-es/protocols/Aws_restJson1.js +1433 -2691
- package/dist-types/Backup.d.ts +14 -12
- package/dist-types/BackupClient.d.ts +2 -2
- package/dist-types/commands/CreateBackupSelectionCommand.d.ts +1 -2
- package/dist-types/commands/ListTagsCommand.d.ts +4 -5
- package/dist-types/commands/UpdateRecoveryPointLifecycleCommand.d.ts +9 -5
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/BackupServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +270 -99
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/BackupClient.d.ts +2 -2
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/BackupServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +55 -32
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +33 -33
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { BackupServiceException as __BaseException } from "./BackupServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>A list of backup options for each resource type.</p>
|
|
4
5
|
*/
|
|
@@ -37,9 +38,9 @@ export declare namespace AdvancedBackupSetting {
|
|
|
37
38
|
/**
|
|
38
39
|
* <p>The required resource already exists.</p>
|
|
39
40
|
*/
|
|
40
|
-
export
|
|
41
|
-
name: "AlreadyExistsException";
|
|
42
|
-
$fault: "client";
|
|
41
|
+
export declare class AlreadyExistsException extends __BaseException {
|
|
42
|
+
readonly name: "AlreadyExistsException";
|
|
43
|
+
readonly $fault: "client";
|
|
43
44
|
Code?: string;
|
|
44
45
|
Message?: string;
|
|
45
46
|
/**
|
|
@@ -58,6 +59,10 @@ export interface AlreadyExistsException extends __SmithyException, $MetadataBear
|
|
|
58
59
|
* <p></p>
|
|
59
60
|
*/
|
|
60
61
|
Context?: string;
|
|
62
|
+
/**
|
|
63
|
+
* @internal
|
|
64
|
+
*/
|
|
65
|
+
constructor(opts: __ExceptionOptionType<AlreadyExistsException, __BaseException>);
|
|
61
66
|
}
|
|
62
67
|
/**
|
|
63
68
|
* <p>Contains information about the backup plan and rule that Backup used to
|
|
@@ -230,10 +235,14 @@ export declare namespace BackupJob {
|
|
|
230
235
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
231
236
|
* a recovery point transitions to cold storage or is deleted.</p>
|
|
232
237
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
233
|
-
* days. Therefore, on the console, the “
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
* <p>Only
|
|
238
|
+
* days. Therefore, on the console, the “retention” setting must be 90 days greater than the
|
|
239
|
+
* “transition to cold after days” setting. The “transition to cold after days” setting cannot
|
|
240
|
+
* be changed after a backup has been transitioned to cold.</p>
|
|
241
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
242
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
243
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
244
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
245
|
+
* other resource types.</p>
|
|
237
246
|
*/
|
|
238
247
|
export interface Lifecycle {
|
|
239
248
|
/**
|
|
@@ -261,10 +270,14 @@ export interface CopyAction {
|
|
|
261
270
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
262
271
|
* a recovery point transitions to cold storage or is deleted.</p>
|
|
263
272
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
264
|
-
* days. Therefore, on the console, the “
|
|
265
|
-
*
|
|
266
|
-
*
|
|
267
|
-
* <p>Only
|
|
273
|
+
* days. Therefore, on the console, the “retention” setting must be 90 days greater than the
|
|
274
|
+
* “transition to cold after days” setting. The “transition to cold after days” setting cannot
|
|
275
|
+
* be changed after a backup has been transitioned to cold.</p>
|
|
276
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
277
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
278
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
279
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
280
|
+
* other resource types.</p>
|
|
268
281
|
*/
|
|
269
282
|
Lifecycle?: Lifecycle;
|
|
270
283
|
/**
|
|
@@ -320,10 +333,14 @@ export interface BackupRule {
|
|
|
320
333
|
* it expires. Backup transitions and expires backups automatically according to
|
|
321
334
|
* the lifecycle that you define. </p>
|
|
322
335
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
323
|
-
* days. Therefore, the “
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
* <p>Only
|
|
336
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
337
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
338
|
+
* after a backup has been transitioned to cold. </p>
|
|
339
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
340
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
341
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
342
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
343
|
+
* other resource types.</p>
|
|
327
344
|
*/
|
|
328
345
|
Lifecycle?: Lifecycle;
|
|
329
346
|
/**
|
|
@@ -419,10 +436,14 @@ export interface BackupRuleInput {
|
|
|
419
436
|
* it expires. Backup will transition and expire backups automatically according
|
|
420
437
|
* to the lifecycle that you define. </p>
|
|
421
438
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
422
|
-
* days. Therefore, the “
|
|
423
|
-
*
|
|
424
|
-
*
|
|
425
|
-
* <p>Only
|
|
439
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
440
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
441
|
+
* after a backup has been transitioned to cold.</p>
|
|
442
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
443
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
444
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
445
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
446
|
+
* other resource types.</p>
|
|
426
447
|
*/
|
|
427
448
|
Lifecycle?: Lifecycle;
|
|
428
449
|
/**
|
|
@@ -623,7 +644,7 @@ export interface Condition {
|
|
|
623
644
|
/**
|
|
624
645
|
* <p>An operation applied to a key-value pair used to assign resources to your backup plan.
|
|
625
646
|
* Condition only supports <code>StringEquals</code>. For more flexible assignment options,
|
|
626
|
-
*
|
|
647
|
+
* including <code>StringLike</code> and the ability to exclude resources from your backup
|
|
627
648
|
* plan, use <code>Conditions</code> (with an "s" on the end) for your <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html">
|
|
628
649
|
* <code>BackupSelection</code>
|
|
629
650
|
* </a>.</p>
|
|
@@ -781,7 +802,9 @@ export declare enum BackupVaultEvent {
|
|
|
781
802
|
RESTORE_JOB_COMPLETED = "RESTORE_JOB_COMPLETED",
|
|
782
803
|
RESTORE_JOB_FAILED = "RESTORE_JOB_FAILED",
|
|
783
804
|
RESTORE_JOB_STARTED = "RESTORE_JOB_STARTED",
|
|
784
|
-
RESTORE_JOB_SUCCESSFUL = "RESTORE_JOB_SUCCESSFUL"
|
|
805
|
+
RESTORE_JOB_SUCCESSFUL = "RESTORE_JOB_SUCCESSFUL",
|
|
806
|
+
S3_BACKUP_OBJECT_FAILED = "S3_BACKUP_OBJECT_FAILED",
|
|
807
|
+
S3_RESTORE_OBJECT_FAILED = "S3_RESTORE_OBJECT_FAILED"
|
|
785
808
|
}
|
|
786
809
|
/**
|
|
787
810
|
* <p>Contains metadata about a backup vault.</p>
|
|
@@ -807,8 +830,16 @@ export interface BackupVaultListMember {
|
|
|
807
830
|
*/
|
|
808
831
|
CreationDate?: Date;
|
|
809
832
|
/**
|
|
810
|
-
* <p>
|
|
811
|
-
*
|
|
833
|
+
* <p>A server-side encryption key you can specify to encrypt your backups from services
|
|
834
|
+
* that support full Backup management; for example,
|
|
835
|
+
* <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.
|
|
836
|
+
* If you specify a key, you must specify its ARN, not its alias. If you do not specify a key,
|
|
837
|
+
* Backup creates a KMS key for you by default.</p>
|
|
838
|
+
* <p>To learn which Backup services support full Backup management
|
|
839
|
+
* and how Backup handles encryption for backups from services that do not yet support
|
|
840
|
+
* full Backup, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html">
|
|
841
|
+
* Encryption for backups in Backup</a>
|
|
842
|
+
* </p>
|
|
812
843
|
*/
|
|
813
844
|
EncryptionKeyArn?: string;
|
|
814
845
|
/**
|
|
@@ -876,10 +907,14 @@ export declare namespace BackupVaultListMember {
|
|
|
876
907
|
* it expires. Backup transitions and expires backups automatically according to
|
|
877
908
|
* the lifecycle that you define.</p>
|
|
878
909
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
879
|
-
* days. Therefore, the “
|
|
880
|
-
*
|
|
881
|
-
*
|
|
882
|
-
* <p>Only
|
|
910
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
911
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
912
|
+
* after a backup has been transitioned to cold.</p>
|
|
913
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
914
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
915
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
916
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
917
|
+
* other resource types.</p>
|
|
883
918
|
*/
|
|
884
919
|
export interface CalculatedLifecycle {
|
|
885
920
|
/**
|
|
@@ -901,9 +936,9 @@ export declare namespace CalculatedLifecycle {
|
|
|
901
936
|
* <p>Backup can't perform the action that you requested until it finishes
|
|
902
937
|
* performing a previous action. Try again later.</p>
|
|
903
938
|
*/
|
|
904
|
-
export
|
|
905
|
-
name: "ConflictException";
|
|
906
|
-
$fault: "client";
|
|
939
|
+
export declare class ConflictException extends __BaseException {
|
|
940
|
+
readonly name: "ConflictException";
|
|
941
|
+
readonly $fault: "client";
|
|
907
942
|
Code?: string;
|
|
908
943
|
Message?: string;
|
|
909
944
|
/**
|
|
@@ -914,6 +949,10 @@ export interface ConflictException extends __SmithyException, $MetadataBearer {
|
|
|
914
949
|
* <p></p>
|
|
915
950
|
*/
|
|
916
951
|
Context?: string;
|
|
952
|
+
/**
|
|
953
|
+
* @internal
|
|
954
|
+
*/
|
|
955
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
917
956
|
}
|
|
918
957
|
/**
|
|
919
958
|
* <p>A list of parameters for a control. A control can have zero, one, or more than one
|
|
@@ -1131,9 +1170,9 @@ export declare namespace CreateBackupPlanOutput {
|
|
|
1131
1170
|
* <p>Indicates that something is wrong with a parameter's value. For example, the value is
|
|
1132
1171
|
* out of range.</p>
|
|
1133
1172
|
*/
|
|
1134
|
-
export
|
|
1135
|
-
name: "InvalidParameterValueException";
|
|
1136
|
-
$fault: "client";
|
|
1173
|
+
export declare class InvalidParameterValueException extends __BaseException {
|
|
1174
|
+
readonly name: "InvalidParameterValueException";
|
|
1175
|
+
readonly $fault: "client";
|
|
1137
1176
|
Code?: string;
|
|
1138
1177
|
Message?: string;
|
|
1139
1178
|
/**
|
|
@@ -1144,14 +1183,18 @@ export interface InvalidParameterValueException extends __SmithyException, $Meta
|
|
|
1144
1183
|
* <p></p>
|
|
1145
1184
|
*/
|
|
1146
1185
|
Context?: string;
|
|
1186
|
+
/**
|
|
1187
|
+
* @internal
|
|
1188
|
+
*/
|
|
1189
|
+
constructor(opts: __ExceptionOptionType<InvalidParameterValueException, __BaseException>);
|
|
1147
1190
|
}
|
|
1148
1191
|
/**
|
|
1149
1192
|
* <p>A limit in the request has been exceeded; for example, a maximum number of items allowed
|
|
1150
1193
|
* in a request.</p>
|
|
1151
1194
|
*/
|
|
1152
|
-
export
|
|
1153
|
-
name: "LimitExceededException";
|
|
1154
|
-
$fault: "client";
|
|
1195
|
+
export declare class LimitExceededException extends __BaseException {
|
|
1196
|
+
readonly name: "LimitExceededException";
|
|
1197
|
+
readonly $fault: "client";
|
|
1155
1198
|
Code?: string;
|
|
1156
1199
|
Message?: string;
|
|
1157
1200
|
/**
|
|
@@ -1162,13 +1205,17 @@ export interface LimitExceededException extends __SmithyException, $MetadataBear
|
|
|
1162
1205
|
* <p></p>
|
|
1163
1206
|
*/
|
|
1164
1207
|
Context?: string;
|
|
1208
|
+
/**
|
|
1209
|
+
* @internal
|
|
1210
|
+
*/
|
|
1211
|
+
constructor(opts: __ExceptionOptionType<LimitExceededException, __BaseException>);
|
|
1165
1212
|
}
|
|
1166
1213
|
/**
|
|
1167
1214
|
* <p>Indicates that a required parameter is missing.</p>
|
|
1168
1215
|
*/
|
|
1169
|
-
export
|
|
1170
|
-
name: "MissingParameterValueException";
|
|
1171
|
-
$fault: "client";
|
|
1216
|
+
export declare class MissingParameterValueException extends __BaseException {
|
|
1217
|
+
readonly name: "MissingParameterValueException";
|
|
1218
|
+
readonly $fault: "client";
|
|
1172
1219
|
Code?: string;
|
|
1173
1220
|
Message?: string;
|
|
1174
1221
|
/**
|
|
@@ -1179,13 +1226,17 @@ export interface MissingParameterValueException extends __SmithyException, $Meta
|
|
|
1179
1226
|
* <p></p>
|
|
1180
1227
|
*/
|
|
1181
1228
|
Context?: string;
|
|
1229
|
+
/**
|
|
1230
|
+
* @internal
|
|
1231
|
+
*/
|
|
1232
|
+
constructor(opts: __ExceptionOptionType<MissingParameterValueException, __BaseException>);
|
|
1182
1233
|
}
|
|
1183
1234
|
/**
|
|
1184
1235
|
* <p>The request failed due to a temporary failure of the server.</p>
|
|
1185
1236
|
*/
|
|
1186
|
-
export
|
|
1187
|
-
name: "ServiceUnavailableException";
|
|
1188
|
-
$fault: "server";
|
|
1237
|
+
export declare class ServiceUnavailableException extends __BaseException {
|
|
1238
|
+
readonly name: "ServiceUnavailableException";
|
|
1239
|
+
readonly $fault: "server";
|
|
1189
1240
|
Code?: string;
|
|
1190
1241
|
Message?: string;
|
|
1191
1242
|
/**
|
|
@@ -1196,6 +1247,10 @@ export interface ServiceUnavailableException extends __SmithyException, $Metadat
|
|
|
1196
1247
|
* <p></p>
|
|
1197
1248
|
*/
|
|
1198
1249
|
Context?: string;
|
|
1250
|
+
/**
|
|
1251
|
+
* @internal
|
|
1252
|
+
*/
|
|
1253
|
+
constructor(opts: __ExceptionOptionType<ServiceUnavailableException, __BaseException>);
|
|
1199
1254
|
}
|
|
1200
1255
|
export interface CreateBackupSelectionInput {
|
|
1201
1256
|
/**
|
|
@@ -1557,9 +1612,9 @@ export declare namespace DeleteBackupPlanOutput {
|
|
|
1557
1612
|
* <p>Indicates that something is wrong with the input to the request. For example, a
|
|
1558
1613
|
* parameter is of the wrong type.</p>
|
|
1559
1614
|
*/
|
|
1560
|
-
export
|
|
1561
|
-
name: "InvalidRequestException";
|
|
1562
|
-
$fault: "client";
|
|
1615
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
1616
|
+
readonly name: "InvalidRequestException";
|
|
1617
|
+
readonly $fault: "client";
|
|
1563
1618
|
Code?: string;
|
|
1564
1619
|
Message?: string;
|
|
1565
1620
|
/**
|
|
@@ -1570,13 +1625,17 @@ export interface InvalidRequestException extends __SmithyException, $MetadataBea
|
|
|
1570
1625
|
* <p></p>
|
|
1571
1626
|
*/
|
|
1572
1627
|
Context?: string;
|
|
1628
|
+
/**
|
|
1629
|
+
* @internal
|
|
1630
|
+
*/
|
|
1631
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
1573
1632
|
}
|
|
1574
1633
|
/**
|
|
1575
1634
|
* <p>A resource that is required for the action doesn't exist.</p>
|
|
1576
1635
|
*/
|
|
1577
|
-
export
|
|
1578
|
-
name: "ResourceNotFoundException";
|
|
1579
|
-
$fault: "client";
|
|
1636
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
1637
|
+
readonly name: "ResourceNotFoundException";
|
|
1638
|
+
readonly $fault: "client";
|
|
1580
1639
|
Code?: string;
|
|
1581
1640
|
Message?: string;
|
|
1582
1641
|
/**
|
|
@@ -1587,6 +1646,10 @@ export interface ResourceNotFoundException extends __SmithyException, $MetadataB
|
|
|
1587
1646
|
* <p></p>
|
|
1588
1647
|
*/
|
|
1589
1648
|
Context?: string;
|
|
1649
|
+
/**
|
|
1650
|
+
* @internal
|
|
1651
|
+
*/
|
|
1652
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
1590
1653
|
}
|
|
1591
1654
|
export interface DeleteBackupSelectionInput {
|
|
1592
1655
|
/**
|
|
@@ -1697,9 +1760,9 @@ export declare namespace DeleteRecoveryPointInput {
|
|
|
1697
1760
|
* <p>Backup is already performing an action on this recovery point. It can't
|
|
1698
1761
|
* perform the action you requested until the first action finishes. Try again later.</p>
|
|
1699
1762
|
*/
|
|
1700
|
-
export
|
|
1701
|
-
name: "InvalidResourceStateException";
|
|
1702
|
-
$fault: "client";
|
|
1763
|
+
export declare class InvalidResourceStateException extends __BaseException {
|
|
1764
|
+
readonly name: "InvalidResourceStateException";
|
|
1765
|
+
readonly $fault: "client";
|
|
1703
1766
|
Code?: string;
|
|
1704
1767
|
Message?: string;
|
|
1705
1768
|
/**
|
|
@@ -1710,6 +1773,10 @@ export interface InvalidResourceStateException extends __SmithyException, $Metad
|
|
|
1710
1773
|
* <p></p>
|
|
1711
1774
|
*/
|
|
1712
1775
|
Context?: string;
|
|
1776
|
+
/**
|
|
1777
|
+
* @internal
|
|
1778
|
+
*/
|
|
1779
|
+
constructor(opts: __ExceptionOptionType<InvalidResourceStateException, __BaseException>);
|
|
1713
1780
|
}
|
|
1714
1781
|
export interface DeleteReportPlanInput {
|
|
1715
1782
|
/**
|
|
@@ -1726,9 +1793,9 @@ export declare namespace DeleteReportPlanInput {
|
|
|
1726
1793
|
/**
|
|
1727
1794
|
* <p>A dependent Amazon Web Services service or resource returned an error to the Backup service, and the action cannot be completed.</p>
|
|
1728
1795
|
*/
|
|
1729
|
-
export
|
|
1730
|
-
name: "DependencyFailureException";
|
|
1731
|
-
$fault: "server";
|
|
1796
|
+
export declare class DependencyFailureException extends __BaseException {
|
|
1797
|
+
readonly name: "DependencyFailureException";
|
|
1798
|
+
readonly $fault: "server";
|
|
1732
1799
|
Code?: string;
|
|
1733
1800
|
Message?: string;
|
|
1734
1801
|
/**
|
|
@@ -1739,6 +1806,10 @@ export interface DependencyFailureException extends __SmithyException, $Metadata
|
|
|
1739
1806
|
* <p></p>
|
|
1740
1807
|
*/
|
|
1741
1808
|
Context?: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* @internal
|
|
1811
|
+
*/
|
|
1812
|
+
constructor(opts: __ExceptionOptionType<DependencyFailureException, __BaseException>);
|
|
1742
1813
|
}
|
|
1743
1814
|
export interface DescribeBackupJobInput {
|
|
1744
1815
|
/**
|
|
@@ -2267,12 +2338,16 @@ export interface DescribeRecoveryPointOutput {
|
|
|
2267
2338
|
/**
|
|
2268
2339
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
2269
2340
|
* it expires. Backup transitions and expires backups automatically according to
|
|
2270
|
-
* the lifecycle that you define
|
|
2341
|
+
* the lifecycle that you define.</p>
|
|
2271
2342
|
* <p>Backups that are transitioned to cold storage must be stored in cold storage for a
|
|
2272
|
-
* minimum of 90 days. Therefore, the “
|
|
2273
|
-
*
|
|
2274
|
-
*
|
|
2275
|
-
* <p>Only
|
|
2343
|
+
* minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the
|
|
2344
|
+
* “transition to cold after days” setting. The “transition to cold after days” setting cannot
|
|
2345
|
+
* be changed after a backup has been transitioned to cold. </p>
|
|
2346
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
2347
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
2348
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
2349
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
2350
|
+
* other resource types.</p>
|
|
2276
2351
|
*/
|
|
2277
2352
|
Lifecycle?: Lifecycle;
|
|
2278
2353
|
/**
|
|
@@ -2320,10 +2395,14 @@ export interface DescribeRegionSettingsOutput {
|
|
|
2320
2395
|
[key: string]: boolean;
|
|
2321
2396
|
};
|
|
2322
2397
|
/**
|
|
2323
|
-
* <p>Returns whether
|
|
2324
|
-
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/
|
|
2325
|
-
*
|
|
2326
|
-
*
|
|
2398
|
+
* <p>Returns whether Backup fully manages the backups for a resource type.</p>
|
|
2399
|
+
* <p>For the benefits of full Backup management, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management"> Full Backup management</a>.</p>
|
|
2400
|
+
* <p>For a list of resource types and whether each supports full Backup
|
|
2401
|
+
* management, see the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
2402
|
+
* availability by resource</a> table.</p>
|
|
2403
|
+
* <p>If <code>"DynamoDB":false</code>, you can enable full Backup management for
|
|
2404
|
+
* DynamoDB backup by enabling <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli">
|
|
2405
|
+
* Backup's advanced DynamoDB backup features</a>.</p>
|
|
2327
2406
|
*/
|
|
2328
2407
|
ResourceTypeManagementPreference?: {
|
|
2329
2408
|
[key: string]: boolean;
|
|
@@ -3022,6 +3101,14 @@ export interface GetSupportedResourceTypesOutput {
|
|
|
3022
3101
|
* <p>
|
|
3023
3102
|
* <code>Storage Gateway</code> for Storage Gateway</p>
|
|
3024
3103
|
* </li>
|
|
3104
|
+
* <li>
|
|
3105
|
+
* <p>
|
|
3106
|
+
* <code>DocDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p>
|
|
3107
|
+
* </li>
|
|
3108
|
+
* <li>
|
|
3109
|
+
* <p>
|
|
3110
|
+
* <code>Neptune</code> for Amazon Neptune</p>
|
|
3111
|
+
* </li>
|
|
3025
3112
|
* </ul>
|
|
3026
3113
|
*/
|
|
3027
3114
|
ResourceTypes?: string[];
|
|
@@ -3073,6 +3160,14 @@ export interface ListBackupJobsInput {
|
|
|
3073
3160
|
* <ul>
|
|
3074
3161
|
* <li>
|
|
3075
3162
|
* <p>
|
|
3163
|
+
* <code>Aurora</code> for Amazon Aurora</p>
|
|
3164
|
+
* </li>
|
|
3165
|
+
* <li>
|
|
3166
|
+
* <p>
|
|
3167
|
+
* <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p>
|
|
3168
|
+
* </li>
|
|
3169
|
+
* <li>
|
|
3170
|
+
* <p>
|
|
3076
3171
|
* <code>DynamoDB</code> for Amazon DynamoDB</p>
|
|
3077
3172
|
* </li>
|
|
3078
3173
|
* <li>
|
|
@@ -3089,16 +3184,28 @@ export interface ListBackupJobsInput {
|
|
|
3089
3184
|
* </li>
|
|
3090
3185
|
* <li>
|
|
3091
3186
|
* <p>
|
|
3092
|
-
* <code>
|
|
3187
|
+
* <code>FSx</code> for Amazon FSx</p>
|
|
3093
3188
|
* </li>
|
|
3094
3189
|
* <li>
|
|
3095
3190
|
* <p>
|
|
3096
|
-
* <code>
|
|
3191
|
+
* <code>Neptune</code> for Amazon Neptune</p>
|
|
3192
|
+
* </li>
|
|
3193
|
+
* <li>
|
|
3194
|
+
* <p>
|
|
3195
|
+
* <code>RDS</code> for Amazon Relational Database Service</p>
|
|
3097
3196
|
* </li>
|
|
3098
3197
|
* <li>
|
|
3099
3198
|
* <p>
|
|
3100
3199
|
* <code>Storage Gateway</code> for Storage Gateway</p>
|
|
3101
3200
|
* </li>
|
|
3201
|
+
* <li>
|
|
3202
|
+
* <p>
|
|
3203
|
+
* <code>S3</code> for Amazon S3</p>
|
|
3204
|
+
* </li>
|
|
3205
|
+
* <li>
|
|
3206
|
+
* <p>
|
|
3207
|
+
* <code>VirtualMachine</code> for virtual machines</p>
|
|
3208
|
+
* </li>
|
|
3102
3209
|
* </ul>
|
|
3103
3210
|
*/
|
|
3104
3211
|
ByResourceType?: string;
|
|
@@ -3376,6 +3483,14 @@ export interface ListCopyJobsInput {
|
|
|
3376
3483
|
* <ul>
|
|
3377
3484
|
* <li>
|
|
3378
3485
|
* <p>
|
|
3486
|
+
* <code>Aurora</code> for Amazon Aurora</p>
|
|
3487
|
+
* </li>
|
|
3488
|
+
* <li>
|
|
3489
|
+
* <p>
|
|
3490
|
+
* <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p>
|
|
3491
|
+
* </li>
|
|
3492
|
+
* <li>
|
|
3493
|
+
* <p>
|
|
3379
3494
|
* <code>DynamoDB</code> for Amazon DynamoDB</p>
|
|
3380
3495
|
* </li>
|
|
3381
3496
|
* <li>
|
|
@@ -3392,16 +3507,28 @@ export interface ListCopyJobsInput {
|
|
|
3392
3507
|
* </li>
|
|
3393
3508
|
* <li>
|
|
3394
3509
|
* <p>
|
|
3395
|
-
* <code>
|
|
3510
|
+
* <code>FSx</code> for Amazon FSx</p>
|
|
3396
3511
|
* </li>
|
|
3397
3512
|
* <li>
|
|
3398
3513
|
* <p>
|
|
3399
|
-
* <code>
|
|
3514
|
+
* <code>Neptune</code> for Amazon Neptune</p>
|
|
3515
|
+
* </li>
|
|
3516
|
+
* <li>
|
|
3517
|
+
* <p>
|
|
3518
|
+
* <code>RDS</code> for Amazon Relational Database Service</p>
|
|
3400
3519
|
* </li>
|
|
3401
3520
|
* <li>
|
|
3402
3521
|
* <p>
|
|
3403
3522
|
* <code>Storage Gateway</code> for Storage Gateway</p>
|
|
3404
3523
|
* </li>
|
|
3524
|
+
* <li>
|
|
3525
|
+
* <p>
|
|
3526
|
+
* <code>S3</code> for Amazon S3</p>
|
|
3527
|
+
* </li>
|
|
3528
|
+
* <li>
|
|
3529
|
+
* <p>
|
|
3530
|
+
* <code>VirtualMachine</code> for virtual machines</p>
|
|
3531
|
+
* </li>
|
|
3405
3532
|
* </ul>
|
|
3406
3533
|
*/
|
|
3407
3534
|
ByResourceType?: string;
|
|
@@ -3729,10 +3856,14 @@ export interface RecoveryPointByBackupVault {
|
|
|
3729
3856
|
* it expires. Backup transitions and expires backups automatically according to
|
|
3730
3857
|
* the lifecycle that you define. </p>
|
|
3731
3858
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
3732
|
-
* days. Therefore, the “
|
|
3733
|
-
*
|
|
3734
|
-
*
|
|
3735
|
-
* <p>Only
|
|
3859
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
3860
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
3861
|
+
* after a backup has been transitioned to cold. </p>
|
|
3862
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
3863
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
3864
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
3865
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
3866
|
+
* other resource types.</p>
|
|
3736
3867
|
*/
|
|
3737
3868
|
Lifecycle?: Lifecycle;
|
|
3738
3869
|
/**
|
|
@@ -4190,7 +4321,8 @@ export interface PutBackupVaultLockConfigurationInput {
|
|
|
4190
4321
|
* lifecycle policy with a retention period equal to or longer than the minimum retention
|
|
4191
4322
|
* period. If the job's retention period is shorter than that minimum retention period, then
|
|
4192
4323
|
* the vault fails that backup or copy job, and you should either modify your lifecycle
|
|
4193
|
-
* settings or use a different vault.
|
|
4324
|
+
* settings or use a different vault. The shortest minimum retention period
|
|
4325
|
+
* you can specify is 1 day. Recovery points already saved in the vault prior to
|
|
4194
4326
|
* Vault Lock are not affected.</p>
|
|
4195
4327
|
*/
|
|
4196
4328
|
MinRetentionDays?: number;
|
|
@@ -4206,7 +4338,9 @@ export interface PutBackupVaultLockConfigurationInput {
|
|
|
4206
4338
|
* lifecycle policy with a retention period equal to or shorter than the maximum retention
|
|
4207
4339
|
* period. If the job's retention period is longer than that maximum retention period, then
|
|
4208
4340
|
* the vault fails the backup or copy job, and you should either modify your lifecycle
|
|
4209
|
-
* settings or use a different vault.
|
|
4341
|
+
* settings or use a different vault. The longest maximum retention period
|
|
4342
|
+
* you can specify is 36500 days (approximately 100 years).
|
|
4343
|
+
* Recovery points already saved in the vault prior to
|
|
4210
4344
|
* Vault Lock are not affected.</p>
|
|
4211
4345
|
*/
|
|
4212
4346
|
MaxRetentionDays?: number;
|
|
@@ -4270,6 +4404,11 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
4270
4404
|
* <code>RECOVERY_POINT_MODIFIED</code>
|
|
4271
4405
|
* </p>
|
|
4272
4406
|
* </li>
|
|
4407
|
+
* <li>
|
|
4408
|
+
* <p>
|
|
4409
|
+
* <code>S3_BACKUP_OBJECT_FAILED</code> | <code>S3_RESTORE_OBJECT_FAILED</code>
|
|
4410
|
+
* </p>
|
|
4411
|
+
* </li>
|
|
4273
4412
|
* </ul>
|
|
4274
4413
|
* <note>
|
|
4275
4414
|
* <p>Ignore the list below because it includes deprecated events. Refer to the list
|
|
@@ -4314,9 +4453,9 @@ export interface StartBackupJobInput {
|
|
|
4314
4453
|
*/
|
|
4315
4454
|
StartWindowMinutes?: number;
|
|
4316
4455
|
/**
|
|
4317
|
-
* <p>A value in minutes during which a successfully started backup must complete, or else
|
|
4318
|
-
*
|
|
4319
|
-
* when the backup was scheduled. It does not add additional time for
|
|
4456
|
+
* <p>A value in minutes during which a successfully started backup must complete, or else
|
|
4457
|
+
* Backup will cancel the job. This value is optional. This value begins
|
|
4458
|
+
* counting down from when the backup was scheduled. It does not add additional time for
|
|
4320
4459
|
* <code>StartWindowMinutes</code>, or if the backup started later than scheduled.</p>
|
|
4321
4460
|
*/
|
|
4322
4461
|
CompleteWindowMinutes?: number;
|
|
@@ -4325,10 +4464,14 @@ export interface StartBackupJobInput {
|
|
|
4325
4464
|
* it expires. Backup will transition and expire backups automatically according
|
|
4326
4465
|
* to the lifecycle that you define. </p>
|
|
4327
4466
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
4328
|
-
* days. Therefore, the “
|
|
4329
|
-
*
|
|
4330
|
-
*
|
|
4331
|
-
* <p>Only
|
|
4467
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
4468
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
4469
|
+
* after a backup has been transitioned to cold. </p>
|
|
4470
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
4471
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
4472
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
4473
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
4474
|
+
* other resource types.</p>
|
|
4332
4475
|
*/
|
|
4333
4476
|
Lifecycle?: Lifecycle;
|
|
4334
4477
|
/**
|
|
@@ -4414,10 +4557,14 @@ export interface StartCopyJobInput {
|
|
|
4414
4557
|
* <p>Contains an array of <code>Transition</code> objects specifying how long in days before
|
|
4415
4558
|
* a recovery point transitions to cold storage or is deleted.</p>
|
|
4416
4559
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
4417
|
-
* days. Therefore, on the console, the “
|
|
4418
|
-
*
|
|
4419
|
-
*
|
|
4420
|
-
* <p>Only
|
|
4560
|
+
* days. Therefore, on the console, the “retention” setting must be 90 days greater than the
|
|
4561
|
+
* “transition to cold after days” setting. The “transition to cold after days” setting cannot
|
|
4562
|
+
* be changed after a backup has been transitioned to cold.</p>
|
|
4563
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
4564
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
4565
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
4566
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
4567
|
+
* other resource types.</p>
|
|
4421
4568
|
*/
|
|
4422
4569
|
Lifecycle?: Lifecycle;
|
|
4423
4570
|
}
|
|
@@ -4554,6 +4701,14 @@ export interface StartRestoreJobInput {
|
|
|
4554
4701
|
* <ul>
|
|
4555
4702
|
* <li>
|
|
4556
4703
|
* <p>
|
|
4704
|
+
* <code>Aurora</code> for Amazon Aurora</p>
|
|
4705
|
+
* </li>
|
|
4706
|
+
* <li>
|
|
4707
|
+
* <p>
|
|
4708
|
+
* <code>DocumentDB</code> for Amazon DocumentDB (with MongoDB compatibility)</p>
|
|
4709
|
+
* </li>
|
|
4710
|
+
* <li>
|
|
4711
|
+
* <p>
|
|
4557
4712
|
* <code>DynamoDB</code> for Amazon DynamoDB</p>
|
|
4558
4713
|
* </li>
|
|
4559
4714
|
* <li>
|
|
@@ -4570,16 +4725,28 @@ export interface StartRestoreJobInput {
|
|
|
4570
4725
|
* </li>
|
|
4571
4726
|
* <li>
|
|
4572
4727
|
* <p>
|
|
4573
|
-
* <code>
|
|
4728
|
+
* <code>FSx</code> for Amazon FSx</p>
|
|
4574
4729
|
* </li>
|
|
4575
4730
|
* <li>
|
|
4576
4731
|
* <p>
|
|
4577
|
-
* <code>
|
|
4732
|
+
* <code>Neptune</code> for Amazon Neptune</p>
|
|
4733
|
+
* </li>
|
|
4734
|
+
* <li>
|
|
4735
|
+
* <p>
|
|
4736
|
+
* <code>RDS</code> for Amazon Relational Database Service</p>
|
|
4578
4737
|
* </li>
|
|
4579
4738
|
* <li>
|
|
4580
4739
|
* <p>
|
|
4581
4740
|
* <code>Storage Gateway</code> for Storage Gateway</p>
|
|
4582
4741
|
* </li>
|
|
4742
|
+
* <li>
|
|
4743
|
+
* <p>
|
|
4744
|
+
* <code>S3</code> for Amazon S3</p>
|
|
4745
|
+
* </li>
|
|
4746
|
+
* <li>
|
|
4747
|
+
* <p>
|
|
4748
|
+
* <code>VirtualMachine</code> for virtual machines</p>
|
|
4749
|
+
* </li>
|
|
4583
4750
|
* </ul>
|
|
4584
4751
|
*/
|
|
4585
4752
|
ResourceType?: string;
|
|
@@ -4789,9 +4956,9 @@ export interface UpdateRecoveryPointLifecycleInput {
|
|
|
4789
4956
|
* it expires. Backup transitions and expires backups automatically according to
|
|
4790
4957
|
* the lifecycle that you define. </p>
|
|
4791
4958
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
4792
|
-
* days. Therefore, the “
|
|
4793
|
-
*
|
|
4794
|
-
*
|
|
4959
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
4960
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
4961
|
+
* after a backup has been transitioned to cold. </p>
|
|
4795
4962
|
*/
|
|
4796
4963
|
Lifecycle?: Lifecycle;
|
|
4797
4964
|
}
|
|
@@ -4815,12 +4982,16 @@ export interface UpdateRecoveryPointLifecycleOutput {
|
|
|
4815
4982
|
/**
|
|
4816
4983
|
* <p>The lifecycle defines when a protected resource is transitioned to cold storage and when
|
|
4817
4984
|
* it expires. Backup transitions and expires backups automatically according to
|
|
4818
|
-
* the lifecycle that you define
|
|
4985
|
+
* the lifecycle that you define.</p>
|
|
4819
4986
|
* <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90
|
|
4820
|
-
* days. Therefore, the “
|
|
4821
|
-
*
|
|
4822
|
-
*
|
|
4823
|
-
* <p>Only
|
|
4987
|
+
* days. Therefore, the “retention” setting must be 90 days greater than the “transition to
|
|
4988
|
+
* cold after days” setting. The “transition to cold after days” setting cannot be changed
|
|
4989
|
+
* after a backup has been transitioned to cold.</p>
|
|
4990
|
+
* <p>Only resource types that support full Backup management can transition their
|
|
4991
|
+
* backups to cold storage. Those resource types are listed in the "Full Backup
|
|
4992
|
+
* management" section of the <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource"> Feature
|
|
4993
|
+
* availability by resource</a> table. Backup ignores this expression for
|
|
4994
|
+
* other resource types.</p>
|
|
4824
4995
|
*/
|
|
4825
4996
|
Lifecycle?: Lifecycle;
|
|
4826
4997
|
/**
|
|
@@ -4843,10 +5014,10 @@ export interface UpdateRegionSettingsInput {
|
|
|
4843
5014
|
[key: string]: boolean;
|
|
4844
5015
|
};
|
|
4845
5016
|
/**
|
|
4846
|
-
* <p>Enables or disables
|
|
4847
|
-
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html">
|
|
4848
|
-
* Backup's advanced DynamoDB backup features</a
|
|
4849
|
-
*
|
|
5017
|
+
* <p>Enables or disables full Backup management of backups for a resource type.
|
|
5018
|
+
* To enable full Backup management for DynamoDB along with <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html">
|
|
5019
|
+
* Backup's advanced DynamoDB backup features</a>, follow the
|
|
5020
|
+
* procedure to <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli"> enable advanced DynamoDB backup programmatically</a>.</p>
|
|
4850
5021
|
*/
|
|
4851
5022
|
ResourceTypeManagementPreference?: {
|
|
4852
5023
|
[key: string]: boolean;
|