Skip to content

Commit

Permalink
feat(client-dlm): This release adds support for Local Zones in Amazon…
Browse files Browse the repository at this point in the history 
… Data Lifecycle Manager EBS snapshot lifecycle policies.
  • Loading branch information
awstools committed Dec 16, 2024
1 parent 7567d64 commit 36c9b5a
Show file tree
Hide file tree
Showing 5 changed files with 92 additions and 40 deletions.
4 changes: 2 additions & 2 deletions clients/client-dlm/src/commands/CreateLifecyclePolicyCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolic
* "VOLUME" || "INSTANCE",
* ],
* ResourceLocations: [ // ResourceLocationList
* "CLOUD" || "OUTPOST",
* "CLOUD" || "OUTPOST" || "LOCAL_ZONE",
* ],
* TargetTags: [ // TargetTagList
* { // Tag
Expand All @@ -93,7 +93,7 @@ export interface CreateLifecyclePolicyCommandOutput extends CreateLifecyclePolic
* },
* ],
* CreateRule: { // CreateRule
* Location: "CLOUD" || "OUTPOST_LOCAL",
* Location: "CLOUD" || "OUTPOST_LOCAL" || "LOCAL_ZONE",
* Interval: Number("int"),
* IntervalUnit: "HOURS",
* Times: [ // TimesList
Expand Down
4 changes: 2 additions & 2 deletions clients/client-dlm/src/commands/GetLifecyclePolicyCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export interface GetLifecyclePolicyCommandOutput extends GetLifecyclePolicyRespo
* // "VOLUME" || "INSTANCE",
* // ],
* // ResourceLocations: [ // ResourceLocationList
* // "CLOUD" || "OUTPOST",
* // "CLOUD" || "OUTPOST" || "LOCAL_ZONE",
* // ],
* // TargetTags: [ // TargetTagList
* // { // Tag
Expand All @@ -80,7 +80,7 @@ export interface GetLifecyclePolicyCommandOutput extends GetLifecyclePolicyRespo
* // },
* // ],
* // CreateRule: { // CreateRule
* // Location: "CLOUD" || "OUTPOST_LOCAL",
* // Location: "CLOUD" || "OUTPOST_LOCAL" || "LOCAL_ZONE",
* // Interval: Number("int"),
* // IntervalUnit: "HOURS",
* // Times: [ // TimesList
Expand Down
4 changes: 2 additions & 2 deletions clients/client-dlm/src/commands/UpdateLifecyclePolicyCommand.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export interface UpdateLifecyclePolicyCommandOutput extends UpdateLifecyclePolic
* "VOLUME" || "INSTANCE",
* ],
* ResourceLocations: [ // ResourceLocationList
* "CLOUD" || "OUTPOST",
* "CLOUD" || "OUTPOST" || "LOCAL_ZONE",
* ],
* TargetTags: [ // TargetTagList
* { // Tag
Expand All @@ -73,7 +73,7 @@ export interface UpdateLifecyclePolicyCommandOutput extends UpdateLifecyclePolic
* },
* ],
* CreateRule: { // CreateRule
* Location: "CLOUD" || "OUTPOST_LOCAL",
* Location: "CLOUD" || "OUTPOST_LOCAL" || "LOCAL_ZONE",
* Interval: Number("int"),
* IntervalUnit: "HOURS",
* Times: [ // TimesList
Expand Down
94 changes: 67 additions & 27 deletions clients/client-dlm/src/models/models_0.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ export type PolicyTypeValues = (typeof PolicyTypeValues)[keyof typeof PolicyType
*/
export const ResourceLocationValues = {
CLOUD: "CLOUD",
LOCAL_ZONE: "LOCAL_ZONE",
OUTPOST: "OUTPOST",
} as const;

Expand Down Expand Up @@ -460,6 +461,7 @@ export type IntervalUnitValues = (typeof IntervalUnitValues)[keyof typeof Interv
*/
export const LocationValues = {
CLOUD: "CLOUD",
LOCAL_ZONE: "LOCAL_ZONE",
OUTPOST_LOCAL: "OUTPOST_LOCAL",
} as const;

Expand Down Expand Up @@ -646,14 +648,39 @@ export interface Script {
export interface CreateRule {
/**
* <p>
* <b>[Custom snapshot policies only]</b> Specifies the destination for snapshots created by the policy. To create
* snapshots in the same Region as the source resource, specify <code>CLOUD</code>. To create
* snapshots on the same Outpost as the source resource, specify <code>OUTPOST_LOCAL</code>.
* If you omit this parameter, <code>CLOUD</code> is used by default.</p>
* <p>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.</p>
* <b>[Custom snapshot policies only]</b> Specifies the destination for snapshots created by the policy. The
* allowed destinations depend on the location of the targeted resources.</p>
* <ul>
* <li>
* <p>If the policy targets resources in a Region, then you must create snapshots
* in the same Region as the source resource.</p>
* </li>
* <li>
* <p>If the policy targets resources in a Local Zone, you can create snapshots in
* the same Local Zone or in its parent Region.</p>
* </li>
* <li>
* <p>If the policy targets resources on an Outpost, then you can create snapshots
* on the same Outpost or in its parent Region.</p>
* </li>
* </ul>
* <p>Specify one of the following values:</p>
* <ul>
* <li>
* <p>To create snapshots in the same Region as the source resource, specify
* <code>CLOUD</code>.</p>
* </li>
* <li>
* <p>To create snapshots in the same Local Zone as the source resource, specify
* <code>LOCAL_ZONE</code>.</p>
* </li>
* <li>
* <p>To create snapshots on the same Outpost as the source resource, specify
* <code>OUTPOST_LOCAL</code>.</p>
* </li>
* </ul>
* <p>Default: <code>CLOUD</code>
* </p>
* @public
*/
Location?: LocationValues | undefined;
Expand All @@ -680,8 +707,8 @@ export interface CreateRule {

/**
* <p>The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1
* year. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron
* expressions</a> in the <i>Amazon CloudWatch User Guide</i>.</p>
* year. For more information, see the <a href="https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html">Cron expressions reference</a> in
* the <i>Amazon EventBridge User Guide</i>.</p>
* @public
*/
CronExpression?: string | undefined;
Expand Down Expand Up @@ -1011,11 +1038,11 @@ export interface Schedule {
FastRestoreRule?: FastRestoreRule | undefined;

/**
* <p>Specifies a rule for copying snapshots or AMIs across regions.</p>
* <p>Specifies a rule for copying snapshots or AMIs across Regions.</p>
* <note>
* <p>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.</p>
* <p>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.</p>
* </note>
* @public
*/
Expand Down Expand Up @@ -1054,8 +1081,7 @@ export interface Schedule {
*/
export interface PolicyDetails {
/**
* <p>
* <b>[Custom policies only]</b> The valid target resource types and actions a policy can manage. Specify <code>EBS_SNAPSHOT_MANAGEMENT</code>
* <p>The type of policy. Specify <code>EBS_SNAPSHOT_MANAGEMENT</code>
* to create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify <code>IMAGE_MANAGEMENT</code>
* to create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify <code>EVENT_BASED_POLICY </code>
* to create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.</p>
Expand All @@ -1075,11 +1101,26 @@ export interface PolicyDetails {

/**
* <p>
* <b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup. If the source resources are located in an
* Amazon Web Services Region, specify <code>CLOUD</code>. If the source resources are located on an Outpost
* in your account, specify <code>OUTPOST</code>.</p>
* <p>If you specify <code>OUTPOST</code>, Amazon Data Lifecycle Manager backs up all resources
* of the specified type with matching target tags across all of the Outposts in your account.</p>
* <b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup.</p>
* <ul>
* <li>
* <p>If the source resources are located in a Region, specify <code>CLOUD</code>. In this case,
* the policy targets all resources of the specified type with matching target tags across all
* Availability Zones in the Region.</p>
* </li>
* <li>
* <p>
* <b>[Custom snapshot policies only]</b> If the source resources are located in a Local Zone, specify <code>LOCAL_ZONE</code>.
* In this case, the policy targets all resources of the specified type with matching target
* tags across all Local Zones in the Region.</p>
* </li>
* <li>
* <p>If the source resources are located on an Outpost in your account, specify <code>OUTPOST</code>.
* In this case, the policy targets all resources of the specified type with matching target
* tags across all of the Outposts in your account.</p>
* </li>
* </ul>
* <p></p>
* @public
*/
ResourceLocations?: ResourceLocationValues[] | undefined;
Expand Down Expand Up @@ -1712,8 +1753,7 @@ export interface GetLifecyclePolicyRequest {
}

/**
* <p>
* <b>[Custom policies only]</b> Detailed information about a snapshot, AMI, or event-based lifecycle policy.</p>
* <p>Information about a lifecycle policy.</p>
* @public
*/
export interface LifecyclePolicy {
Expand Down Expand Up @@ -1779,16 +1819,16 @@ export interface LifecyclePolicy {
PolicyArn?: string | undefined;

/**
* <p>
* <b>[Default policies only]</b> The type of default policy. Values include:</p>
* <p>Indicates whether the policy is a default lifecycle policy or a custom
* lifecycle policy.</p>
* <ul>
* <li>
* <p>
* <code>VOLUME</code> - Default policy for EBS snapshots</p>
* <code>true</code> - the policy is a default policy.</p>
* </li>
* <li>
* <p>
* <code>INSTANCE</code> - Default policy for EBS-backed AMIs</p>
* <code>false</code> - the policy is a custom policy.</p>
* </li>
* </ul>
* @public
Expand Down
26 changes: 19 additions & 7 deletions codegen/sdk-codegen/aws-models/dlm.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -306,7 +306,7 @@
"Location": {
"target": "com.amazonaws.dlm#LocationValues",
"traits": {
"smithy.api#documentation": "<p>\n <b>[Custom snapshot policies only]</b> Specifies the destination for snapshots created by the policy. To create \n\t\t\tsnapshots in the same Region as the source resource, specify <code>CLOUD</code>. To create \n\t\t\tsnapshots on the same Outpost as the source resource, specify <code>OUTPOST_LOCAL</code>. \n\t\t\tIf you omit this parameter, <code>CLOUD</code> is used by default.</p>\n <p>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.</p>"
"smithy.api#documentation": "<p>\n <b>[Custom snapshot policies only]</b> Specifies the destination for snapshots created by the policy. The \n\t\t\tallowed destinations depend on the location of the targeted resources.</p>\n <ul>\n <li>\n <p>If 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.</p>\n </li>\n <li>\n <p>If 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.</p>\n </li>\n <li>\n <p>If 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.</p>\n </li>\n </ul>\n <p>Specify one of the following values:</p>\n <ul>\n <li>\n <p>To create snapshots in the same Region as the source resource, specify \n\t\t\t\t\t<code>CLOUD</code>.</p>\n </li>\n <li>\n <p>To create snapshots in the same Local Zone as the source resource, specify \n\t\t\t\t\t<code>LOCAL_ZONE</code>.</p>\n </li>\n <li>\n <p>To create snapshots on the same Outpost as the source resource, specify \n\t\t\t\t\t<code>OUTPOST_LOCAL</code>.</p>\n </li>\n </ul>\n <p>Default: <code>CLOUD</code>\n </p>"
}
},
"Interval": {
Expand All @@ -330,7 +330,7 @@
"CronExpression": {
"target": "com.amazonaws.dlm#CronExpression",
"traits": {
"smithy.api#documentation": "<p>The schedule, as a Cron expression. The schedule interval must be between 1 hour and 1\n\t\t\tyear. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions\">Cron\n\t\t\t\texpressions</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
"smithy.api#documentation": "<p>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 <a href=\"https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-cron-expressions.html\">Cron expressions reference</a> in \n\t\t\tthe <i>Amazon EventBridge User Guide</i>.</p>"
}
},
"Scripts": {
Expand Down Expand Up @@ -1204,12 +1204,12 @@
"DefaultPolicy": {
"target": "com.amazonaws.dlm#DefaultPolicy",
"traits": {
"smithy.api#documentation": "<p>\n <b>[Default policies only]</b> The type of default policy. Values include:</p>\n <ul>\n <li>\n <p>\n <code>VOLUME</code> - Default policy for EBS snapshots</p>\n </li>\n <li>\n <p>\n <code>INSTANCE</code> - Default policy for EBS-backed AMIs</p>\n </li>\n </ul>"
"smithy.api#documentation": "<p>Indicates whether the policy is a default lifecycle policy or a custom \n\t\t\tlifecycle policy.</p>\n <ul>\n <li>\n <p>\n <code>true</code> - the policy is a default policy.</p>\n </li>\n <li>\n <p>\n <code>false</code> - the policy is a custom policy.</p>\n </li>\n </ul>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>\n <b>[Custom policies only]</b> Detailed information about a snapshot, AMI, or event-based lifecycle policy.</p>"
"smithy.api#documentation": "<p>Information about a lifecycle policy.</p>"
}
},
"com.amazonaws.dlm#LifecyclePolicySummary": {
Expand Down Expand Up @@ -1356,6 +1356,12 @@
"traits": {
"smithy.api#enumValue": "OUTPOST_LOCAL"
}
},
"LOCAL_ZONE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "LOCAL_ZONE"
}
}
}
},
Expand Down Expand Up @@ -1423,7 +1429,7 @@
"PolicyType": {
"target": "com.amazonaws.dlm#PolicyTypeValues",
"traits": {
"smithy.api#documentation": "<p>\n <b>[Custom policies only]</b> The valid target resource types and actions a policy can manage. Specify <code>EBS_SNAPSHOT_MANAGEMENT</code> \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify <code>IMAGE_MANAGEMENT</code> \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify <code>EVENT_BASED_POLICY </code> \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.</p>\n <p>The default is <code>EBS_SNAPSHOT_MANAGEMENT</code>.</p>"
"smithy.api#documentation": "<p>The type of policy. Specify <code>EBS_SNAPSHOT_MANAGEMENT</code> \n\t\t\tto create a lifecycle policy that manages the lifecycle of Amazon EBS snapshots. Specify <code>IMAGE_MANAGEMENT</code> \n\t\t\tto create a lifecycle policy that manages the lifecycle of EBS-backed AMIs. Specify <code>EVENT_BASED_POLICY </code> \n\t\t\tto create an event-based policy that performs specific actions when a defined event occurs in your Amazon Web Services account.</p>\n <p>The default is <code>EBS_SNAPSHOT_MANAGEMENT</code>.</p>"
}
},
"ResourceTypes": {
Expand All @@ -1435,7 +1441,7 @@
"ResourceLocations": {
"target": "com.amazonaws.dlm#ResourceLocationList",
"traits": {
"smithy.api#documentation": "<p>\n <b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup. If the source resources are located in an \n\t\t\tAmazon Web Services Region, specify <code>CLOUD</code>. If the source resources are located on an Outpost \n\t\t\tin your account, specify <code>OUTPOST</code>.</p>\n <p>If you specify <code>OUTPOST</code>, 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.</p>"
"smithy.api#documentation": "<p>\n <b>[Custom snapshot and AMI policies only]</b> The location of the resources to backup.</p>\n <ul>\n <li>\n <p>If the source resources are located in a Region, specify <code>CLOUD</code>. 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.</p>\n </li>\n <li>\n <p>\n <b>[Custom snapshot policies only]</b> If the source resources are located in a Local Zone, specify <code>LOCAL_ZONE</code>. \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.</p>\n </li>\n <li>\n <p>If the source resources are located on an Outpost in your account, specify <code>OUTPOST</code>. \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.</p>\n </li>\n </ul>\n <p></p>"
}
},
"TargetTags": {
Expand Down Expand Up @@ -1603,6 +1609,12 @@
"traits": {
"smithy.api#enumValue": "OUTPOST"
}
},
"LOCAL_ZONE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "LOCAL_ZONE"
}
}
}
},
Expand Down Expand Up @@ -1800,7 +1812,7 @@
"CrossRegionCopyRules": {
"target": "com.amazonaws.dlm#CrossRegionCopyRules",
"traits": {
"smithy.api#documentation": "<p>Specifies a rule for copying snapshots or AMIs across regions.</p>\n <note>\n <p>You 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.</p>\n </note>"
"smithy.api#documentation": "<p>Specifies a rule for copying snapshots or AMIs across Regions.</p>\n <note>\n <p>You 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.</p>\n </note>"
}
},
"ShareRules": {
Expand Down

0 comments on commit 36c9b5a

Please sign in to comment.