From 36c9b5add4913254dfb4cbec876b985366f4d96d Mon Sep 17 00:00:00 2001
From: awstools
- * [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create
- * snapshots in the same Region as the source resource, specify If the policy targets resources in an Amazon Web Services Region, then you must create
- * snapshots in the same Region as the source resource. If the policy targets resources on an
- * Outpost, then you can create snapshots on the same Outpost as the source resource, or in
- * the Region of that Outpost.CLOUD
. To create
- * snapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL
.
- * If you omit this parameter, CLOUD
is used by default.
If the policy targets resources in a Region, then you must create snapshots + * in the same Region as the source resource.
+ *If the policy targets resources in a Local Zone, you can create snapshots in + * the same Local Zone or in its parent Region.
+ *If the policy targets resources on an Outpost, then you can create snapshots + * on the same Outpost or in its parent Region.
+ *Specify one of the following values:
+ *To create snapshots in the same Region as the source resource, specify
+ * CLOUD
.
To create snapshots in the same Local Zone as the source resource, specify
+ * LOCAL_ZONE
.
To create snapshots on the same Outpost as the source resource, specify
+ * OUTPOST_LOCAL
.
Default: CLOUD
+ *
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1 - * year. For more information, see Cron - * expressions in the Amazon CloudWatch User Guide.
+ * year. For more information, see the Cron expressions reference in + * the Amazon EventBridge User Guide. * @public */ CronExpression?: string | undefined; @@ -1011,11 +1038,11 @@ export interface Schedule { FastRestoreRule?: FastRestoreRule | undefined; /** - *Specifies a rule for copying snapshots or AMIs across regions.
+ *Specifies a rule for copying snapshots or AMIs across Regions.
*You can't specify cross-Region copy rules for policies that create snapshots on an Outpost. - * If the policy creates snapshots in a Region, then snapshots can be copied to up to three - * Regions or Outposts.
+ *You can't specify cross-Region copy rules for policies that create snapshots on an + * Outpost or in a Local Zone. If the policy creates snapshots in a Region, then snapshots + * can be copied to up to three Regions or Outposts.
*
- * [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT
+ *
The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT
* to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT
* to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
* to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
- * [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an
- * Amazon Web Services Region, specify CLOUD
. If the source resources are located on an Outpost
- * in your account, specify OUTPOST
.
If you specify OUTPOST
, Amazon Data Lifecycle Manager backs up all resources
- * of the specified type with matching target tags across all of the Outposts in your account.
If the source resources are located in a Region, specify CLOUD
. In this case,
+ * the policy targets all resources of the specified type with matching target tags across all
+ * Availability Zones in the Region.
+ * [Custom snapshot policies only] If the source resources are located in a Local Zone, specify LOCAL_ZONE
.
+ * In this case, the policy targets all resources of the specified type with matching target
+ * tags across all Local Zones in the Region.
If the source resources are located on an Outpost in your account, specify OUTPOST
.
+ * In this case, the policy targets all resources of the specified type with matching target
+ * tags across all of the Outposts in your account.
- * [Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
+ *Information about a lifecycle policy.
* @public */ export interface LifecyclePolicy { @@ -1779,16 +1819,16 @@ export interface LifecyclePolicy { PolicyArn?: string | undefined; /** - *- * [Default policies only] The type of default policy. Values include:
+ *Indicates whether the policy is a default lifecycle policy or a custom + * lifecycle policy.
*
- * VOLUME
- Default policy for EBS snapshots
true
- the policy is a default policy.
*
- * INSTANCE
- Default policy for EBS-backed AMIs
false
- the policy is a custom policy.
* \n [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. To create \n\t\t\tsnapshots in the same Region as the source resource, specify CLOUD
. To create \n\t\t\tsnapshots on the same Outpost as the source resource, specify OUTPOST_LOCAL
. \n\t\t\tIf you omit this parameter, CLOUD
is used by default.
If the policy targets resources in an Amazon Web Services Region, then you must create \n\t\t\tsnapshots in the same Region as the source resource. If the policy targets resources on an \n\t\t\tOutpost, then you can create snapshots on the same Outpost as the source resource, or in \n\t\t\tthe Region of that Outpost.
" + "smithy.api#documentation": "\n [Custom snapshot policies only] Specifies the destination for snapshots created by the policy. The \n\t\t\tallowed destinations depend on the location of the targeted resources.
\nIf the policy targets resources in a Region, then you must create snapshots \n\t\t\t\t\tin the same Region as the source resource.
\nIf the policy targets resources in a Local Zone, you can create snapshots in \n\t\t\t\t\tthe same Local Zone or in its parent Region.
\nIf the policy targets resources on an Outpost, then you can create snapshots \n\t\t\t\t\ton the same Outpost or in its parent Region.
\nSpecify one of the following values:
\nTo create snapshots in the same Region as the source resource, specify \n\t\t\t\t\tCLOUD
.
To create snapshots in the same Local Zone as the source resource, specify \n\t\t\t\t\tLOCAL_ZONE
.
To create snapshots on the same Outpost as the source resource, specify \n\t\t\t\t\tOUTPOST_LOCAL
.
Default: CLOUD
\n
The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\n\t\t\tyear. For more information, see Cron\n\t\t\t\texpressions in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\n\t\t\tyear. For more information, see the Cron expressions reference in \n\t\t\tthe Amazon EventBridge User Guide.
" } }, "Scripts": { @@ -1204,12 +1204,12 @@ "DefaultPolicy": { "target": "com.amazonaws.dlm#DefaultPolicy", "traits": { - "smithy.api#documentation": "\n [Default policies only] The type of default policy. Values include:
\n\n VOLUME
- Default policy for EBS snapshots
\n INSTANCE
- Default policy for EBS-backed AMIs
Indicates whether the policy is a default lifecycle policy or a custom \n\t\t\tlifecycle policy.
\n\n true
- the policy is a default policy.
\n false
- the policy is a custom policy.
\n [Custom policies only] Detailed information about a snapshot, AMI, or event-based lifecycle policy.
" + "smithy.api#documentation": "Information about a lifecycle policy.
" } }, "com.amazonaws.dlm#LifecyclePolicySummary": { @@ -1356,6 +1356,12 @@ "traits": { "smithy.api#enumValue": "OUTPOST_LOCAL" } + }, + "LOCAL_ZONE": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "LOCAL_ZONE" + } } } }, @@ -1423,7 +1429,7 @@ "PolicyType": { "target": "com.amazonaws.dlm#PolicyTypeValues", "traits": { - "smithy.api#documentation": "\n [Custom policies only] The valid target resource types and actions a policy can manage. Specify EBS_SNAPSHOT_MANAGEMENT
\n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT
\n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
\n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT
.
The type of policy. Specify EBS_SNAPSHOT_MANAGEMENT
\n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify IMAGE_MANAGEMENT
\n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify EVENT_BASED_POLICY
\n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.
The default is EBS_SNAPSHOT_MANAGEMENT
.
\n [Custom snapshot and AMI policies only] The location of the resources to backup. If the source resources are located in an \n\t\t\tAmazon Web Services Region, specify CLOUD
. If the source resources are located on an Outpost \n\t\t\tin your account, specify OUTPOST
.
If you specify OUTPOST
, Amazon Data Lifecycle Manager backs up all resources \n\t\t\t\tof the specified type with matching target tags across all of the Outposts in your account.
\n [Custom snapshot and AMI policies only] The location of the resources to backup.
\nIf the source resources are located in a Region, specify CLOUD
. In this case, \n\t\t\t\t\tthe policy targets all resources of the specified type with matching target tags across all \n\t\t\t\t\tAvailability Zones in the Region.
\n [Custom snapshot policies only] If the source resources are located in a Local Zone, specify LOCAL_ZONE
. \n\t\t\t\t\tIn this case, the policy targets all resources of the specified type with matching target \n\t\t\t\t\ttags across all Local Zones in the Region.
If the source resources are located on an Outpost in your account, specify OUTPOST
. \n\t\t\t\t\tIn this case, the policy targets all resources of the specified type with matching target \n\t\t\t\t\ttags across all of the Outposts in your account.
Specifies a rule for copying snapshots or AMIs across regions.
\nYou can't specify cross-Region copy rules for policies that create snapshots on an Outpost. \n\t\t\tIf the policy creates snapshots in a Region, then snapshots can be copied to up to three \n\t\t\tRegions or Outposts.
\nSpecifies a rule for copying snapshots or AMIs across Regions.
\nYou can't specify cross-Region copy rules for policies that create snapshots on an \n\t\t\t\tOutpost or in a Local Zone. If the policy creates snapshots in a Region, then snapshots \n\t\t\t\tcan be copied to up to three Regions or Outposts.
\n