@aws-sdk/client-backup 3.40.0 → 3.45.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 +41 -0
- package/dist-cjs/endpoints.js +9 -0
- package/dist-cjs/models/models_0.js +16 -4
- package/dist-cjs/protocols/Aws_restJson1.js +117 -0
- package/dist-es/endpoints.js +9 -0
- package/dist-es/models/models_0.js +8 -0
- package/dist-es/protocols/Aws_restJson1.js +133 -29
- package/dist-types/Backup.d.ts +6 -40
- package/dist-types/commands/CreateBackupPlanCommand.d.ts +1 -1
- package/dist-types/commands/CreateBackupSelectionCommand.d.ts +3 -41
- package/dist-types/commands/CreateBackupVaultCommand.d.ts +1 -1
- package/dist-types/commands/CreateFrameworkCommand.d.ts +1 -1
- package/dist-types/commands/CreateReportPlanCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupPlanCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupSelectionCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupVaultAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupVaultCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupVaultLockConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteBackupVaultNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteFrameworkCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRecoveryPointCommand.d.ts +1 -1
- package/dist-types/commands/DeleteReportPlanCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBackupJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeBackupVaultCommand.d.ts +1 -1
- package/dist-types/commands/DescribeCopyJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeFrameworkCommand.d.ts +1 -1
- package/dist-types/commands/DescribeGlobalSettingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeProtectedResourceCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRecoveryPointCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRegionSettingsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReportJobCommand.d.ts +1 -1
- package/dist-types/commands/DescribeReportPlanCommand.d.ts +1 -1
- package/dist-types/commands/DescribeRestoreJobCommand.d.ts +1 -1
- package/dist-types/commands/DisassociateRecoveryPointCommand.d.ts +1 -1
- package/dist-types/commands/ExportBackupPlanTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupPlanCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupPlanFromJSONCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupPlanFromTemplateCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupSelectionCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupVaultAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetBackupVaultNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/GetRecoveryPointRestoreMetadataCommand.d.ts +1 -1
- package/dist-types/commands/GetSupportedResourceTypesCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupPlanTemplatesCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupPlanVersionsCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupPlansCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupSelectionsCommand.d.ts +1 -1
- package/dist-types/commands/ListBackupVaultsCommand.d.ts +1 -1
- package/dist-types/commands/ListCopyJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListFrameworksCommand.d.ts +1 -1
- package/dist-types/commands/ListProtectedResourcesCommand.d.ts +1 -1
- package/dist-types/commands/ListRecoveryPointsByBackupVaultCommand.d.ts +1 -1
- package/dist-types/commands/ListRecoveryPointsByResourceCommand.d.ts +1 -1
- package/dist-types/commands/ListReportJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListReportPlansCommand.d.ts +1 -1
- package/dist-types/commands/ListRestoreJobsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsCommand.d.ts +1 -1
- package/dist-types/commands/PutBackupVaultAccessPolicyCommand.d.ts +1 -1
- package/dist-types/commands/PutBackupVaultLockConfigurationCommand.d.ts +5 -1
- package/dist-types/commands/PutBackupVaultNotificationsCommand.d.ts +1 -1
- package/dist-types/commands/StartBackupJobCommand.d.ts +1 -1
- package/dist-types/commands/StartCopyJobCommand.d.ts +1 -1
- package/dist-types/commands/StartReportJobCommand.d.ts +1 -1
- package/dist-types/commands/StartRestoreJobCommand.d.ts +1 -1
- package/dist-types/commands/StopBackupJobCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateBackupPlanCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFrameworkCommand.d.ts +1 -1
- package/dist-types/commands/UpdateGlobalSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRecoveryPointLifecycleCommand.d.ts +1 -1
- package/dist-types/commands/UpdateRegionSettingsCommand.d.ts +1 -1
- package/dist-types/commands/UpdateReportPlanCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +197 -46
- package/dist-types/ts3.4/models/models_0.d.ts +38 -0
- package/package.json +6 -6
|
@@ -21,7 +21,7 @@ export interface ListReportPlansCommandOutput extends ListReportPlansOutput, __M
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link ListReportPlansCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link ListReportPlansCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class ListReportPlansCommand extends $Command<ListReportPlansCommandInput, ListReportPlansCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface ListRestoreJobsCommandOutput extends ListRestoreJobsOutput, __M
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link ListRestoreJobsCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link ListRestoreJobsCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class ListRestoreJobsCommand extends $Command<ListRestoreJobsCommandInput, ListRestoreJobsCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -26,7 +26,7 @@ export interface ListTagsCommandOutput extends ListTagsOutput, __MetadataBearer
|
|
|
26
26
|
*
|
|
27
27
|
* @see {@link ListTagsCommandInput} for command's `input` shape.
|
|
28
28
|
* @see {@link ListTagsCommandOutput} for command's `response` shape.
|
|
29
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
29
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
30
30
|
*
|
|
31
31
|
*/
|
|
32
32
|
export declare class ListTagsCommand extends $Command<ListTagsCommandInput, ListTagsCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface PutBackupVaultAccessPolicyCommandOutput extends __MetadataBeare
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link PutBackupVaultAccessPolicyCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link PutBackupVaultAccessPolicyCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class PutBackupVaultAccessPolicyCommand extends $Command<PutBackupVaultAccessPolicyCommandInput, PutBackupVaultAccessPolicyCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -12,6 +12,10 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata
|
|
|
12
12
|
* attempts to update the lifecycle policy that controls the retention period of any recovery
|
|
13
13
|
* point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and
|
|
14
14
|
* maximum retention period for future backup and copy jobs that target a backup vault.</p>
|
|
15
|
+
* <note>
|
|
16
|
+
* <p>Backup Vault Lock has yet to receive a third-party assessment for SEC
|
|
17
|
+
* 17a-4(f) and CFTC.</p>
|
|
18
|
+
* </note>
|
|
15
19
|
* @example
|
|
16
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
17
21
|
* ```javascript
|
|
@@ -24,7 +28,7 @@ export interface PutBackupVaultLockConfigurationCommandOutput extends __Metadata
|
|
|
24
28
|
*
|
|
25
29
|
* @see {@link PutBackupVaultLockConfigurationCommandInput} for command's `input` shape.
|
|
26
30
|
* @see {@link PutBackupVaultLockConfigurationCommandOutput} for command's `response` shape.
|
|
27
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
31
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
28
32
|
*
|
|
29
33
|
*/
|
|
30
34
|
export declare class PutBackupVaultLockConfigurationCommand extends $Command<PutBackupVaultLockConfigurationCommandInput, PutBackupVaultLockConfigurationCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface PutBackupVaultNotificationsCommandOutput extends __MetadataBear
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link PutBackupVaultNotificationsCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link PutBackupVaultNotificationsCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class PutBackupVaultNotificationsCommand extends $Command<PutBackupVaultNotificationsCommandInput, PutBackupVaultNotificationsCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface StartBackupJobCommandOutput extends StartBackupJobOutput, __Met
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link StartBackupJobCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link StartBackupJobCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class StartBackupJobCommand extends $Command<StartBackupJobCommandInput, StartBackupJobCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface StartCopyJobCommandOutput extends StartCopyJobOutput, __Metadat
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link StartCopyJobCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link StartCopyJobCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class StartCopyJobCommand extends $Command<StartCopyJobCommandInput, StartCopyJobCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface StartReportJobCommandOutput extends StartReportJobOutput, __Met
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link StartReportJobCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link StartReportJobCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class StartReportJobCommand extends $Command<StartReportJobCommandInput, StartReportJobCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface StartRestoreJobCommandOutput extends StartRestoreJobOutput, __M
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link StartRestoreJobCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link StartRestoreJobCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class StartRestoreJobCommand extends $Command<StartRestoreJobCommandInput, StartRestoreJobCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -20,7 +20,7 @@ export interface StopBackupJobCommandOutput extends __MetadataBearer {
|
|
|
20
20
|
*
|
|
21
21
|
* @see {@link StopBackupJobCommandInput} for command's `input` shape.
|
|
22
22
|
* @see {@link StopBackupJobCommandOutput} for command's `response` shape.
|
|
23
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
23
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
24
24
|
*
|
|
25
25
|
*/
|
|
26
26
|
export declare class StopBackupJobCommand extends $Command<StopBackupJobCommandInput, StopBackupJobCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link TagResourceCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link TagResourceCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link UntagResourceCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link UntagResourceCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface UpdateBackupPlanCommandOutput extends UpdateBackupPlanOutput, _
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link UpdateBackupPlanCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link UpdateBackupPlanCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class UpdateBackupPlanCommand extends $Command<UpdateBackupPlanCommandInput, UpdateBackupPlanCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface UpdateFrameworkCommandOutput extends UpdateFrameworkOutput, __M
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link UpdateFrameworkCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link UpdateFrameworkCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class UpdateFrameworkCommand extends $Command<UpdateFrameworkCommandInput, UpdateFrameworkCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -22,7 +22,7 @@ export interface UpdateGlobalSettingsCommandOutput extends __MetadataBearer {
|
|
|
22
22
|
*
|
|
23
23
|
* @see {@link UpdateGlobalSettingsCommandInput} for command's `input` shape.
|
|
24
24
|
* @see {@link UpdateGlobalSettingsCommandOutput} for command's `response` shape.
|
|
25
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
25
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
26
26
|
*
|
|
27
27
|
*/
|
|
28
28
|
export declare class UpdateGlobalSettingsCommand extends $Command<UpdateGlobalSettingsCommandInput, UpdateGlobalSettingsCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -29,7 +29,7 @@ export interface UpdateRecoveryPointLifecycleCommandOutput extends UpdateRecover
|
|
|
29
29
|
*
|
|
30
30
|
* @see {@link UpdateRecoveryPointLifecycleCommandInput} for command's `input` shape.
|
|
31
31
|
* @see {@link UpdateRecoveryPointLifecycleCommandOutput} for command's `response` shape.
|
|
32
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
32
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
33
33
|
*
|
|
34
34
|
*/
|
|
35
35
|
export declare class UpdateRecoveryPointLifecycleCommand extends $Command<UpdateRecoveryPointLifecycleCommandInput, UpdateRecoveryPointLifecycleCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -25,7 +25,7 @@ export interface UpdateRegionSettingsCommandOutput extends __MetadataBearer {
|
|
|
25
25
|
*
|
|
26
26
|
* @see {@link UpdateRegionSettingsCommandInput} for command's `input` shape.
|
|
27
27
|
* @see {@link UpdateRegionSettingsCommandOutput} for command's `response` shape.
|
|
28
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
28
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
29
29
|
*
|
|
30
30
|
*/
|
|
31
31
|
export declare class UpdateRegionSettingsCommand extends $Command<UpdateRegionSettingsCommandInput, UpdateRegionSettingsCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -21,7 +21,7 @@ export interface UpdateReportPlanCommandOutput extends UpdateReportPlanOutput, _
|
|
|
21
21
|
*
|
|
22
22
|
* @see {@link UpdateReportPlanCommandInput} for command's `input` shape.
|
|
23
23
|
* @see {@link UpdateReportPlanCommandOutput} for command's `response` shape.
|
|
24
|
-
* @see {@link BackupClientResolvedConfig | config} for
|
|
24
|
+
* @see {@link BackupClientResolvedConfig | config} for BackupClient's `config` shape.
|
|
25
25
|
*
|
|
26
26
|
*/
|
|
27
27
|
export declare class UpdateReportPlanCommand extends $Command<UpdateReportPlanCommandInput, UpdateReportPlanCommandOutput, BackupClientResolvedConfig> {
|
|
@@ -291,7 +291,8 @@ export declare namespace CopyAction {
|
|
|
291
291
|
*/
|
|
292
292
|
export interface BackupRule {
|
|
293
293
|
/**
|
|
294
|
-
* <p>
|
|
294
|
+
* <p>A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
|
|
295
|
+
* characters.</p>
|
|
295
296
|
*/
|
|
296
297
|
RuleName: string | undefined;
|
|
297
298
|
/**
|
|
@@ -303,10 +304,11 @@ export interface BackupRule {
|
|
|
303
304
|
TargetBackupVaultName: string | undefined;
|
|
304
305
|
/**
|
|
305
306
|
* <p>A cron expression in UTC specifying when Backup initiates a backup job. For
|
|
306
|
-
* more information about cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User
|
|
307
|
-
* Guide.</i>.
|
|
308
|
-
*
|
|
309
|
-
*
|
|
307
|
+
* more information about Amazon Web Services cron expressions, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User
|
|
308
|
+
* Guide.</i>. Two examples of Amazon Web Services cron expressions are <code> 15 * ?
|
|
309
|
+
* * * *</code> (take a backup every hour at 15 minutes past the hour) and <code>0 12 * * ?
|
|
310
|
+
* *</code> (take a backup every day at 12 noon UTC). For a table of examples, click the
|
|
311
|
+
* preceding link and scroll down the page.</p>
|
|
310
312
|
*/
|
|
311
313
|
ScheduleExpression?: string;
|
|
312
314
|
/**
|
|
@@ -367,7 +369,8 @@ export declare namespace BackupRule {
|
|
|
367
369
|
*/
|
|
368
370
|
export interface BackupPlan {
|
|
369
371
|
/**
|
|
370
|
-
* <p>The display name of a backup plan
|
|
372
|
+
* <p>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
|
|
373
|
+
* characters.</p>
|
|
371
374
|
*/
|
|
372
375
|
BackupPlanName: string | undefined;
|
|
373
376
|
/**
|
|
@@ -391,7 +394,8 @@ export declare namespace BackupPlan {
|
|
|
391
394
|
*/
|
|
392
395
|
export interface BackupRuleInput {
|
|
393
396
|
/**
|
|
394
|
-
* <p>
|
|
397
|
+
* <p>A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
|
|
398
|
+
* characters.</p>
|
|
395
399
|
*/
|
|
396
400
|
RuleName: string | undefined;
|
|
397
401
|
/**
|
|
@@ -458,7 +462,8 @@ export declare namespace BackupRuleInput {
|
|
|
458
462
|
*/
|
|
459
463
|
export interface BackupPlanInput {
|
|
460
464
|
/**
|
|
461
|
-
* <p>The
|
|
465
|
+
* <p>The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
|
|
466
|
+
* characters.</p>
|
|
462
467
|
*/
|
|
463
468
|
BackupPlanName: string | undefined;
|
|
464
469
|
/**
|
|
@@ -516,7 +521,8 @@ export interface BackupPlansListMember {
|
|
|
516
521
|
BackupPlanName?: string;
|
|
517
522
|
/**
|
|
518
523
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
519
|
-
* without the risk of running the operation twice.</p>
|
|
524
|
+
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
525
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
520
526
|
*/
|
|
521
527
|
CreatorRequestId?: string;
|
|
522
528
|
/**
|
|
@@ -556,28 +562,87 @@ export declare namespace BackupPlanTemplatesListMember {
|
|
|
556
562
|
*/
|
|
557
563
|
const filterSensitiveLog: (obj: BackupPlanTemplatesListMember) => any;
|
|
558
564
|
}
|
|
565
|
+
/**
|
|
566
|
+
* <p>Includes information about tags you define to assign tagged resources to a backup
|
|
567
|
+
* plan.</p>
|
|
568
|
+
*/
|
|
569
|
+
export interface ConditionParameter {
|
|
570
|
+
/**
|
|
571
|
+
* <p>The key in a key-value pair. For example, in the tag <code>Department:
|
|
572
|
+
* Accounting</code>, <code>Department</code> is the key.</p>
|
|
573
|
+
*/
|
|
574
|
+
ConditionKey?: string;
|
|
575
|
+
/**
|
|
576
|
+
* <p>The value in a key-value pair. For example, in the tag <code>Department:
|
|
577
|
+
* Accounting</code>, <code>Accounting</code> is the value.</p>
|
|
578
|
+
*/
|
|
579
|
+
ConditionValue?: string;
|
|
580
|
+
}
|
|
581
|
+
export declare namespace ConditionParameter {
|
|
582
|
+
/**
|
|
583
|
+
* @internal
|
|
584
|
+
*/
|
|
585
|
+
const filterSensitiveLog: (obj: ConditionParameter) => any;
|
|
586
|
+
}
|
|
587
|
+
/**
|
|
588
|
+
* <p>Contains information about which resources to include or exclude from a backup plan
|
|
589
|
+
* using their tags. Conditions are case sensitive.</p>
|
|
590
|
+
*/
|
|
591
|
+
export interface Conditions {
|
|
592
|
+
/**
|
|
593
|
+
* <p>Filters the values of your tagged resources for only those resources that you tagged
|
|
594
|
+
* with the same value. Also called "exact matching."</p>
|
|
595
|
+
*/
|
|
596
|
+
StringEquals?: ConditionParameter[];
|
|
597
|
+
/**
|
|
598
|
+
* <p>Filters the values of your tagged resources for only those resources that you tagged
|
|
599
|
+
* that do not have the same value. Also called "negated matching."</p>
|
|
600
|
+
*/
|
|
601
|
+
StringNotEquals?: ConditionParameter[];
|
|
602
|
+
/**
|
|
603
|
+
* <p>Filters the values of your tagged resources for matching tag values with the use of a
|
|
604
|
+
* wildcard character (*) anywhere in the string. For example, "prod*" or "*rod*" matches the
|
|
605
|
+
* tag value "production".</p>
|
|
606
|
+
*/
|
|
607
|
+
StringLike?: ConditionParameter[];
|
|
608
|
+
/**
|
|
609
|
+
* <p>Filters the values of your tagged resources for non-matching tag values with the use of
|
|
610
|
+
* a wildcard character (*) anywhere in the string.</p>
|
|
611
|
+
*/
|
|
612
|
+
StringNotLike?: ConditionParameter[];
|
|
613
|
+
}
|
|
614
|
+
export declare namespace Conditions {
|
|
615
|
+
/**
|
|
616
|
+
* @internal
|
|
617
|
+
*/
|
|
618
|
+
const filterSensitiveLog: (obj: Conditions) => any;
|
|
619
|
+
}
|
|
559
620
|
export declare enum ConditionType {
|
|
560
621
|
STRINGEQUALS = "STRINGEQUALS"
|
|
561
622
|
}
|
|
562
623
|
/**
|
|
563
624
|
* <p>Contains an array of triplets made up of a condition type (such as
|
|
564
|
-
* <code>StringEquals</code>), a key, and a value.
|
|
565
|
-
*
|
|
625
|
+
* <code>StringEquals</code>), a key, and a value. Used to filter resources using their
|
|
626
|
+
* tags and assign them to a backup plan. Case sensitive.</p>
|
|
566
627
|
*/
|
|
567
628
|
export interface Condition {
|
|
568
629
|
/**
|
|
569
|
-
* <p>An operation
|
|
570
|
-
*
|
|
630
|
+
* <p>An operation applied to a key-value pair used to assign resources to your backup plan.
|
|
631
|
+
* Condition only supports <code>StringEquals</code>. For more flexible assignment options,
|
|
632
|
+
* incluidng <code>StringLike</code> and the ability to exclude resources from your backup
|
|
633
|
+
* 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">
|
|
634
|
+
* <code>BackupSelection</code>
|
|
635
|
+
* </a>.</p>
|
|
571
636
|
*/
|
|
572
637
|
ConditionType: ConditionType | string | undefined;
|
|
573
638
|
/**
|
|
574
|
-
* <p>The key in a key-value pair. For example, in <code>
|
|
575
|
-
*
|
|
639
|
+
* <p>The key in a key-value pair. For example, in the tag <code>Department:
|
|
640
|
+
* Accounting</code>, <code>Department</code> is the key.</p>
|
|
576
641
|
*/
|
|
577
642
|
ConditionKey: string | undefined;
|
|
578
643
|
/**
|
|
579
|
-
* <p>The value in a key-value pair. For example, in <code>
|
|
580
|
-
*
|
|
644
|
+
* <p>The value in a key-value pair. For example, in the tag <code>Department:
|
|
645
|
+
* Accounting</code>, <code>Accounting</code> is the value.</p>
|
|
581
646
|
*/
|
|
582
647
|
ConditionValue: string | undefined;
|
|
583
648
|
}
|
|
@@ -592,7 +657,8 @@ export declare namespace Condition {
|
|
|
592
657
|
*/
|
|
593
658
|
export interface BackupSelection {
|
|
594
659
|
/**
|
|
595
|
-
* <p>The display name of a resource selection document
|
|
660
|
+
* <p>The display name of a resource selection document. Must contain 1 to 50 alphanumeric or
|
|
661
|
+
* '-_.' characters.</p>
|
|
596
662
|
*/
|
|
597
663
|
SelectionName: string | undefined;
|
|
598
664
|
/**
|
|
@@ -601,17 +667,63 @@ export interface BackupSelection {
|
|
|
601
667
|
*/
|
|
602
668
|
IamRoleArn: string | undefined;
|
|
603
669
|
/**
|
|
604
|
-
* <p>
|
|
605
|
-
*
|
|
606
|
-
*
|
|
670
|
+
* <p>A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum number of
|
|
671
|
+
* ARNs is 500 without wildcards, or 30 ARNs with wildcards.</p>
|
|
672
|
+
* <p>If you need to assign many resources to a backup plan, consider a different resource
|
|
673
|
+
* selection strategy, such as assigning all resources of a resource type or refining your
|
|
674
|
+
* resource selection using tags.</p>
|
|
607
675
|
*/
|
|
608
676
|
Resources?: string[];
|
|
609
677
|
/**
|
|
610
|
-
* <p>
|
|
611
|
-
*
|
|
612
|
-
*
|
|
678
|
+
* <p>A list of conditions that you define to assign resources to your backup plans using
|
|
679
|
+
* tags. For example, <code>"StringEquals": {"Department": "accounting"</code>. Condition
|
|
680
|
+
* operators are case sensitive.</p>
|
|
681
|
+
* <p>
|
|
682
|
+
* <code>ListOfTags</code> differs from <code>Conditions</code> as follows:</p>
|
|
683
|
+
* <ul>
|
|
684
|
+
* <li>
|
|
685
|
+
* <p>When you specify more than one condition, you assign all resources that match AT
|
|
686
|
+
* LEAST ONE condition (using OR logic).</p>
|
|
687
|
+
* </li>
|
|
688
|
+
* <li>
|
|
689
|
+
* <p>
|
|
690
|
+
* <code>ListOfTags</code> only supports <code>StringEquals</code>.
|
|
691
|
+
* <code>Conditions</code> supports <code>StringEquals</code>,
|
|
692
|
+
* <code>StringLike</code>, <code>StringNotEquals</code>, and
|
|
693
|
+
* <code>StringNotLike</code>. </p>
|
|
694
|
+
* </li>
|
|
695
|
+
* </ul>
|
|
613
696
|
*/
|
|
614
697
|
ListOfTags?: Condition[];
|
|
698
|
+
/**
|
|
699
|
+
* <p>A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The maximum number
|
|
700
|
+
* of ARNs is 500 without wildcards, or 30 ARNs with wildcards.</p>
|
|
701
|
+
* <p>If you need to exclude many resources from a backup plan, consider a different resource
|
|
702
|
+
* selection strategy, such as assigning only one or a few resource types or refining your
|
|
703
|
+
* resource selection using tags.</p>
|
|
704
|
+
*/
|
|
705
|
+
NotResources?: string[];
|
|
706
|
+
/**
|
|
707
|
+
* <p>A list of conditions that you define to assign resources to your backup plans using
|
|
708
|
+
* tags. For example, <code>"StringEquals": {"Department": "accounting"</code>. Condition
|
|
709
|
+
* operators are case sensitive.</p>
|
|
710
|
+
* <p>
|
|
711
|
+
* <code>Conditions</code> differs from <code>ListOfTags</code> as follows:</p>
|
|
712
|
+
* <ul>
|
|
713
|
+
* <li>
|
|
714
|
+
* <p>When you specify more than one condition, you only assign the resources that match
|
|
715
|
+
* ALL conditions (using AND logic).</p>
|
|
716
|
+
* </li>
|
|
717
|
+
* <li>
|
|
718
|
+
* <p>
|
|
719
|
+
* <code>Conditions</code> supports <code>StringEquals</code>,
|
|
720
|
+
* <code>StringLike</code>, <code>StringNotEquals</code>, and
|
|
721
|
+
* <code>StringNotLike</code>. <code>ListOfTags</code> only supports
|
|
722
|
+
* <code>StringEquals</code>.</p>
|
|
723
|
+
* </li>
|
|
724
|
+
* </ul>
|
|
725
|
+
*/
|
|
726
|
+
Conditions?: Conditions;
|
|
615
727
|
}
|
|
616
728
|
export declare namespace BackupSelection {
|
|
617
729
|
/**
|
|
@@ -644,7 +756,8 @@ export interface BackupSelectionsListMember {
|
|
|
644
756
|
CreationDate?: Date;
|
|
645
757
|
/**
|
|
646
758
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
647
|
-
* without the risk of running the operation twice.</p>
|
|
759
|
+
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
760
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
648
761
|
*/
|
|
649
762
|
CreatorRequestId?: string;
|
|
650
763
|
/**
|
|
@@ -706,7 +819,8 @@ export interface BackupVaultListMember {
|
|
|
706
819
|
EncryptionKeyArn?: string;
|
|
707
820
|
/**
|
|
708
821
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
709
|
-
* without the risk of running the operation twice.</p>
|
|
822
|
+
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
823
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
710
824
|
*/
|
|
711
825
|
CreatorRequestId?: string;
|
|
712
826
|
/**
|
|
@@ -837,9 +951,10 @@ export declare namespace ControlInputParameter {
|
|
|
837
951
|
}
|
|
838
952
|
/**
|
|
839
953
|
* <p>A framework consists of one or more controls. Each control has its own control scope.
|
|
840
|
-
* The control scope
|
|
841
|
-
*
|
|
842
|
-
*
|
|
954
|
+
* The control scope can include one or more resource types, a combination of a tag key and
|
|
955
|
+
* value, or a combination of one resource type and one resource ID. If no scope is specified,
|
|
956
|
+
* evaluations for the rule are triggered when any resource in your recording group changes in
|
|
957
|
+
* configuration.</p>
|
|
843
958
|
* <note>
|
|
844
959
|
* <p>To set a control scope that includes all of a particular resource, leave the
|
|
845
960
|
* <code>ControlScope</code> empty or do not pass it when calling
|
|
@@ -858,8 +973,10 @@ export interface ControlScope {
|
|
|
858
973
|
*/
|
|
859
974
|
ComplianceResourceTypes?: string[];
|
|
860
975
|
/**
|
|
861
|
-
* <p>
|
|
862
|
-
*
|
|
976
|
+
* <p>The tag key-value pair applied to those Amazon Web Services resources that you want to
|
|
977
|
+
* trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag
|
|
978
|
+
* value is optional, but it cannot be an empty string. The structure to assign a tag is:
|
|
979
|
+
* <code>[{"Key":"string","Value":"string"}]</code>.</p>
|
|
863
980
|
*/
|
|
864
981
|
Tags?: {
|
|
865
982
|
[key: string]: string;
|
|
@@ -978,6 +1095,7 @@ export interface CreateBackupPlanInput {
|
|
|
978
1095
|
* <p>Identifies the request and allows failed requests to be retried without the risk of
|
|
979
1096
|
* running the operation twice. If the request includes a <code>CreatorRequestId</code> that
|
|
980
1097
|
* matches an existing backup plan, that plan is returned. This parameter is optional.</p>
|
|
1098
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
981
1099
|
*/
|
|
982
1100
|
CreatorRequestId?: string;
|
|
983
1101
|
}
|
|
@@ -1127,7 +1245,8 @@ export interface CreateBackupSelectionInput {
|
|
|
1127
1245
|
BackupSelection: BackupSelection | undefined;
|
|
1128
1246
|
/**
|
|
1129
1247
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
1130
|
-
* without the risk of running the operation twice.</p>
|
|
1248
|
+
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
1249
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
1131
1250
|
*/
|
|
1132
1251
|
CreatorRequestId?: string;
|
|
1133
1252
|
}
|
|
@@ -1182,7 +1301,8 @@ export interface CreateBackupVaultInput {
|
|
|
1182
1301
|
EncryptionKeyArn?: string;
|
|
1183
1302
|
/**
|
|
1184
1303
|
* <p>A unique string that identifies the request and allows failed requests to be retried
|
|
1185
|
-
* without the risk of running the operation twice.</p>
|
|
1304
|
+
* without the risk of running the operation twice. This parameter is optional.</p>
|
|
1305
|
+
* <p>If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.</p>
|
|
1186
1306
|
*/
|
|
1187
1307
|
CreatorRequestId?: string;
|
|
1188
1308
|
}
|
|
@@ -2259,6 +2379,15 @@ export interface DescribeRegionSettingsOutput {
|
|
|
2259
2379
|
ResourceTypeOptInPreference?: {
|
|
2260
2380
|
[key: string]: boolean;
|
|
2261
2381
|
};
|
|
2382
|
+
/**
|
|
2383
|
+
* <p>Returns whether a DynamoDB recovery point was taken using
|
|
2384
|
+
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html">
|
|
2385
|
+
* Backup's advanced DynamoDB backup features</a>.
|
|
2386
|
+
* </p>
|
|
2387
|
+
*/
|
|
2388
|
+
ResourceTypeManagementPreference?: {
|
|
2389
|
+
[key: string]: boolean;
|
|
2390
|
+
};
|
|
2262
2391
|
}
|
|
2263
2392
|
export declare namespace DescribeRegionSettingsOutput {
|
|
2264
2393
|
/**
|
|
@@ -4180,19 +4309,31 @@ export interface PutBackupVaultNotificationsInput {
|
|
|
4180
4309
|
/**
|
|
4181
4310
|
* <p>An array of events that indicate the status of jobs to back up resources to the backup
|
|
4182
4311
|
* vault.</p>
|
|
4312
|
+
* <p>For common use cases and code samples, see <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html">Using Amazon SNS to
|
|
4313
|
+
* track Backup events</a>.</p>
|
|
4314
|
+
* <p>The following events are supported:</p>
|
|
4315
|
+
* <ul>
|
|
4316
|
+
* <li>
|
|
4317
|
+
* <p>
|
|
4318
|
+
* <code>BACKUP_JOB_STARTED</code> | <code>BACKUP_JOB_COMPLETED</code>
|
|
4319
|
+
* </p>
|
|
4320
|
+
* </li>
|
|
4321
|
+
* <li>
|
|
4322
|
+
* <p>
|
|
4323
|
+
* <code>COPY_JOB_STARTED</code> | <code>COPY_JOB_SUCCESSFUL</code> |
|
|
4324
|
+
* <code>COPY_JOB_FAILED</code>
|
|
4325
|
+
* </p>
|
|
4326
|
+
* </li>
|
|
4327
|
+
* <li>
|
|
4328
|
+
* <p>
|
|
4329
|
+
* <code>RESTORE_JOB_STARTED</code> | <code>RESTORE_JOB_COMPLETED</code> |
|
|
4330
|
+
* <code>RECOVERY_POINT_MODIFIED</code>
|
|
4331
|
+
* </p>
|
|
4332
|
+
* </li>
|
|
4333
|
+
* </ul>
|
|
4183
4334
|
* <note>
|
|
4184
|
-
* <p>
|
|
4185
|
-
*
|
|
4186
|
-
* <code>BACKUP_JOB_STARTED</code>, <code>BACKUP_JOB_COMPLETED</code>,</p>
|
|
4187
|
-
* <p>
|
|
4188
|
-
* <code>COPY_JOB_STARTED</code>, <code>COPY_JOB_SUCCESSFUL</code>,
|
|
4189
|
-
* <code>COPY_JOB_FAILED</code>,</p>
|
|
4190
|
-
* <p>
|
|
4191
|
-
* <code>RESTORE_JOB_STARTED</code>, <code>RESTORE_JOB_COMPLETED</code>, and
|
|
4192
|
-
* <code>RECOVERY_POINT_MODIFIED</code>.</p>
|
|
4193
|
-
* <p>To find failed backup jobs, use <code>BACKUP_JOB_COMPLETED</code> and filter using
|
|
4194
|
-
* event metadata.</p>
|
|
4195
|
-
* <p>Other events in the following list are deprecated.</p>
|
|
4335
|
+
* <p>Ignore the list below because it includes deprecated events. Refer to the list
|
|
4336
|
+
* above.</p>
|
|
4196
4337
|
* </note>
|
|
4197
4338
|
*/
|
|
4198
4339
|
BackupVaultEvents: (BackupVaultEvent | string)[] | undefined;
|
|
@@ -4541,7 +4682,8 @@ export interface TagResourceInput {
|
|
|
4541
4682
|
ResourceArn: string | undefined;
|
|
4542
4683
|
/**
|
|
4543
4684
|
* <p>Key-value pairs that are used to help organize your resources. You can assign your own
|
|
4544
|
-
* metadata to the resources you create
|
|
4685
|
+
* metadata to the resources you create. For clarity, this is the structure to assign tags:
|
|
4686
|
+
* <code>[{"Key":"string","Value":"string"}]</code>.</p>
|
|
4545
4687
|
*/
|
|
4546
4688
|
Tags: {
|
|
4547
4689
|
[key: string]: string;
|
|
@@ -4760,6 +4902,15 @@ export interface UpdateRegionSettingsInput {
|
|
|
4760
4902
|
ResourceTypeOptInPreference?: {
|
|
4761
4903
|
[key: string]: boolean;
|
|
4762
4904
|
};
|
|
4905
|
+
/**
|
|
4906
|
+
* <p>Enables or disables
|
|
4907
|
+
* <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html">
|
|
4908
|
+
* Backup's advanced DynamoDB backup features</a> for the
|
|
4909
|
+
* Region.</p>
|
|
4910
|
+
*/
|
|
4911
|
+
ResourceTypeManagementPreference?: {
|
|
4912
|
+
[key: string]: boolean;
|
|
4913
|
+
};
|
|
4763
4914
|
}
|
|
4764
4915
|
export declare namespace UpdateRegionSettingsInput {
|
|
4765
4916
|
/**
|