Amazon S3 examples using SDK for JavaScript (v3) (original) (raw)
Entrypoint for the scenario (index.js). This orchestrates all of the steps. Visit GitHub to see the implementation details for Scenario, ScenarioInput, ScenarioOutput, and ScenarioAction.
import * as Scenarios from "@aws-doc-sdk-examples/lib/scenario/index.js";
import {
exitOnFalse,
loadState,
saveState,
} from "@aws-doc-sdk-examples/lib/scenario/steps-common.js";
import { welcome, welcomeContinue } from "./welcome.steps.js";
import {
confirmCreateBuckets,
confirmPopulateBuckets,
confirmSetLegalHoldFileEnabled,
confirmSetLegalHoldFileRetention,
confirmSetRetentionPeriodFileEnabled,
confirmSetRetentionPeriodFileRetention,
confirmUpdateLockPolicy,
confirmUpdateRetention,
createBuckets,
createBucketsAction,
getBucketPrefix,
populateBuckets,
populateBucketsAction,
setLegalHoldFileEnabledAction,
setLegalHoldFileRetentionAction,
setRetentionPeriodFileEnabledAction,
setRetentionPeriodFileRetentionAction,
updateLockPolicy,
updateLockPolicyAction,
updateRetention,
updateRetentionAction,
} from "./setup.steps.js";
/**
* @param {Scenarios} scenarios
* @param {Record<string, any>} initialState
*/
export const getWorkflowStages = (scenarios, initialState = {}) => {
const client = new S3Client({});
return {
deploy: new scenarios.Scenario(
"S3 Object Locking - Deploy",
[
welcome(scenarios),
welcomeContinue(scenarios),
exitOnFalse(scenarios, "welcomeContinue"),
getBucketPrefix(scenarios),
createBuckets(scenarios),
confirmCreateBuckets(scenarios),
exitOnFalse(scenarios, "confirmCreateBuckets"),
createBucketsAction(scenarios, client),
updateRetention(scenarios),
confirmUpdateRetention(scenarios),
exitOnFalse(scenarios, "confirmUpdateRetention"),
updateRetentionAction(scenarios, client),
populateBuckets(scenarios),
confirmPopulateBuckets(scenarios),
exitOnFalse(scenarios, "confirmPopulateBuckets"),
populateBucketsAction(scenarios, client),
updateLockPolicy(scenarios),
confirmUpdateLockPolicy(scenarios),
exitOnFalse(scenarios, "confirmUpdateLockPolicy"),
updateLockPolicyAction(scenarios, client),
confirmSetLegalHoldFileEnabled(scenarios),
setLegalHoldFileEnabledAction(scenarios, client),
confirmSetRetentionPeriodFileEnabled(scenarios),
setRetentionPeriodFileEnabledAction(scenarios, client),
confirmSetLegalHoldFileRetention(scenarios),
setLegalHoldFileRetentionAction(scenarios, client),
confirmSetRetentionPeriodFileRetention(scenarios),
setRetentionPeriodFileRetentionAction(scenarios, client),
saveState,
],
initialState,
),
demo: new scenarios.Scenario(
"S3 Object Locking - Demo",
[loadState, replAction(scenarios, client)],
initialState,
),
clean: new scenarios.Scenario(
"S3 Object Locking - Destroy",
[
loadState,
confirmCleanup(scenarios),
exitOnFalse(scenarios, "confirmCleanup"),
cleanupAction(scenarios, client),
],
initialState,
),
};
};
// Call function if run directly
import { fileURLToPath } from "node:url";
import { S3Client } from "@aws-sdk/client-s3";
import { cleanupAction, confirmCleanup } from "./clean.steps.js";
import { replAction } from "./repl.steps.js";
if (process.argv[1] === fileURLToPath(import.meta.url)) {
const objectLockingScenarios = getWorkflowStages(Scenarios);
Scenarios.parseScenarioArgs(objectLockingScenarios, {
name: "Amazon S3 object locking workflow",
description:
"Work with Amazon Simple Storage Service (Amazon S3) object locking features.",
synopsis:
"node index.js --scenario <deploy | demo | clean> [-h|--help] [-y|--yes] [-v|--verbose]",
});
}
Output welcome messages to the console (welcome.steps.js).
/**
* @typedef {import("@aws-doc-sdk-examples/lib/scenario/index.js")} Scenarios
*/
/**
* @param {Scenarios} scenarios
*/
const welcome = (scenarios) =>
new scenarios.ScenarioOutput(
"welcome",
"Welcome to the Amazon Simple Storage Service (S3) Object Locking Feature Scenario. For this workflow, we will use the AWS SDK for JavaScript to create several S3 buckets and files to demonstrate working with S3 locking features.",
{ header: true },
);
/**
* @param {Scenarios} scenarios
*/
const welcomeContinue = (scenarios) =>
new scenarios.ScenarioInput(
"welcomeContinue",
"Press Enter when you are ready to start.",
{ type: "confirm" },
);
export { welcome, welcomeContinue };
Deploy buckets, objects, and file settings (setup.steps.js).
import {
BucketVersioningStatus,
ChecksumAlgorithm,
CreateBucketCommand,
MFADeleteStatus,
PutBucketVersioningCommand,
PutObjectCommand,
PutObjectLockConfigurationCommand,
PutObjectLegalHoldCommand,
PutObjectRetentionCommand,
ObjectLockLegalHoldStatus,
ObjectLockRetentionMode,
GetBucketVersioningCommand,
BucketAlreadyExists,
BucketAlreadyOwnedByYou,
S3ServiceException,
waitUntilBucketExists,
} from "@aws-sdk/client-s3";
import { retry } from "@aws-doc-sdk-examples/lib/utils/util-timers.js";
/**
* @typedef {import("@aws-doc-sdk-examples/lib/scenario/index.js")} Scenarios
*/
/**
* @typedef {import("@aws-sdk/client-s3").S3Client} S3Client
*/
/**
* @param {Scenarios} scenarios
*/
const getBucketPrefix = (scenarios) =>
new scenarios.ScenarioInput(
"bucketPrefix",
"Provide a prefix that will be used for bucket creation.",
{ type: "input", default: "amzn-s3-demo-bucket" },
);
/**
* @param {Scenarios} scenarios
*/
const createBuckets = (scenarios) =>
new scenarios.ScenarioOutput(
"createBuckets",
(state) => `The following buckets will be created:
${state.bucketPrefix}-no-lock with object lock False.
${state.bucketPrefix}-lock-enabled with object lock True.
${state.bucketPrefix}-retention-after-creation with object lock False.`,
{ preformatted: true },
);
/**
* @param {Scenarios} scenarios
*/
const confirmCreateBuckets = (scenarios) =>
new scenarios.ScenarioInput("confirmCreateBuckets", "Create the buckets?", {
type: "confirm",
});
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const createBucketsAction = (scenarios, client) =>
new scenarios.ScenarioAction("createBucketsAction", async (state) => {
const noLockBucketName = `${state.bucketPrefix}-no-lock`;
const lockEnabledBucketName = `${state.bucketPrefix}-lock-enabled`;
const retentionBucketName = `${state.bucketPrefix}-retention-after-creation`;
try {
await client.send(new CreateBucketCommand({ Bucket: noLockBucketName }));
await waitUntilBucketExists({ client }, { Bucket: noLockBucketName });
await client.send(
new CreateBucketCommand({
Bucket: lockEnabledBucketName,
ObjectLockEnabledForBucket: true,
}),
);
await waitUntilBucketExists(
{ client },
{ Bucket: lockEnabledBucketName },
);
await client.send(
new CreateBucketCommand({ Bucket: retentionBucketName }),
);
await waitUntilBucketExists({ client }, { Bucket: retentionBucketName });
state.noLockBucketName = noLockBucketName;
state.lockEnabledBucketName = lockEnabledBucketName;
state.retentionBucketName = retentionBucketName;
} catch (caught) {
if (
caught instanceof BucketAlreadyExists ||
caught instanceof BucketAlreadyOwnedByYou
) {
console.error(`${caught.name}: ${caught.message}`);
state.earlyExit = true;
} else {
throw caught;
}
}
});
/**
* @param {Scenarios} scenarios
*/
const populateBuckets = (scenarios) =>
new scenarios.ScenarioOutput(
"populateBuckets",
(state) => `The following test files will be created:
file0.txt in ${state.bucketPrefix}-no-lock.
file1.txt in ${state.bucketPrefix}-no-lock.
file0.txt in ${state.bucketPrefix}-lock-enabled.
file1.txt in ${state.bucketPrefix}-lock-enabled.
file0.txt in ${state.bucketPrefix}-retention-after-creation.
file1.txt in ${state.bucketPrefix}-retention-after-creation.`,
{ preformatted: true },
);
/**
* @param {Scenarios} scenarios
*/
const confirmPopulateBuckets = (scenarios) =>
new scenarios.ScenarioInput(
"confirmPopulateBuckets",
"Populate the buckets?",
{ type: "confirm" },
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const populateBucketsAction = (scenarios, client) =>
new scenarios.ScenarioAction("populateBucketsAction", async (state) => {
try {
await client.send(
new PutObjectCommand({
Bucket: state.noLockBucketName,
Key: "file0.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
await client.send(
new PutObjectCommand({
Bucket: state.noLockBucketName,
Key: "file1.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
await client.send(
new PutObjectCommand({
Bucket: state.lockEnabledBucketName,
Key: "file0.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
await client.send(
new PutObjectCommand({
Bucket: state.lockEnabledBucketName,
Key: "file1.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
await client.send(
new PutObjectCommand({
Bucket: state.retentionBucketName,
Key: "file0.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
await client.send(
new PutObjectCommand({
Bucket: state.retentionBucketName,
Key: "file1.txt",
Body: "Content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
} catch (caught) {
if (caught instanceof S3ServiceException) {
console.error(
`Error from S3 while uploading object. <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>c</mi><mi>a</mi><mi>u</mi><mi>g</mi><mi>h</mi><mi>t</mi><mi mathvariant="normal">.</mi><mi>n</mi><mi>a</mi><mi>m</mi><mi>e</mi></mrow><mo>:</mo></mrow><annotation encoding="application/x-tex">{caught.name}: </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">c</span><span class="mord mathnormal">a</span><span class="mord mathnormal" style="margin-right:0.03588em;">ug</span><span class="mord mathnormal">h</span><span class="mord mathnormal">t</span><span class="mord">.</span><span class="mord mathnormal">nam</span><span class="mord mathnormal">e</span></span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">:</span></span></span></span>{caught.message}`,
);
} else {
throw caught;
}
}
});
/**
* @param {Scenarios} scenarios
*/
const updateRetention = (scenarios) =>
new scenarios.ScenarioOutput(
"updateRetention",
(state) => `A bucket can be configured to use object locking with a default retention period.
A default retention period will be configured for ${state.bucketPrefix}-retention-after-creation.`,
{ preformatted: true },
);
/**
* @param {Scenarios} scenarios
*/
const confirmUpdateRetention = (scenarios) =>
new scenarios.ScenarioInput(
"confirmUpdateRetention",
"Configure default retention period?",
{ type: "confirm" },
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const updateRetentionAction = (scenarios, client) =>
new scenarios.ScenarioAction("updateRetentionAction", async (state) => {
await client.send(
new PutBucketVersioningCommand({
Bucket: state.retentionBucketName,
VersioningConfiguration: {
MFADelete: MFADeleteStatus.Disabled,
Status: BucketVersioningStatus.Enabled,
},
}),
);
const getBucketVersioning = new GetBucketVersioningCommand({
Bucket: state.retentionBucketName,
});
await retry({ intervalInMs: 500, maxRetries: 10 }, async () => {
const { Status } = await client.send(getBucketVersioning);
if (Status !== "Enabled") {
throw new Error("Bucket versioning is not enabled.");
}
});
await client.send(
new PutObjectLockConfigurationCommand({
Bucket: state.retentionBucketName,
ObjectLockConfiguration: {
ObjectLockEnabled: "Enabled",
Rule: {
DefaultRetention: {
Mode: "GOVERNANCE",
Years: 1,
},
},
},
}),
);
});
/**
* @param {Scenarios} scenarios
*/
const updateLockPolicy = (scenarios) =>
new scenarios.ScenarioOutput(
"updateLockPolicy",
(state) => `Object lock policies can also be added to existing buckets.
An object lock policy will be added to ${state.bucketPrefix}-lock-enabled.`,
{ preformatted: true },
);
/**
* @param {Scenarios} scenarios
*/
const confirmUpdateLockPolicy = (scenarios) =>
new scenarios.ScenarioInput(
"confirmUpdateLockPolicy",
"Add object lock policy?",
{ type: "confirm" },
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const updateLockPolicyAction = (scenarios, client) =>
new scenarios.ScenarioAction("updateLockPolicyAction", async (state) => {
await client.send(
new PutObjectLockConfigurationCommand({
Bucket: state.lockEnabledBucketName,
ObjectLockConfiguration: {
ObjectLockEnabled: "Enabled",
},
}),
);
});
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const confirmSetLegalHoldFileEnabled = (scenarios) =>
new scenarios.ScenarioInput(
"confirmSetLegalHoldFileEnabled",
(state) =>
`Would you like to add a legal hold to file0.txt in ${state.lockEnabledBucketName}?`,
{
type: "confirm",
},
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const setLegalHoldFileEnabledAction = (scenarios, client) =>
new scenarios.ScenarioAction(
"setLegalHoldFileEnabledAction",
async (state) => {
await client.send(
new PutObjectLegalHoldCommand({
Bucket: state.lockEnabledBucketName,
Key: "file0.txt",
LegalHold: {
Status: ObjectLockLegalHoldStatus.ON,
},
}),
);
console.log(
`Modified legal hold for file0.txt in ${state.lockEnabledBucketName}.`,
);
},
{ skipWhen: (state) => !state.confirmSetLegalHoldFileEnabled },
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const confirmSetRetentionPeriodFileEnabled = (scenarios) =>
new scenarios.ScenarioInput(
"confirmSetRetentionPeriodFileEnabled",
(state) =>
`Would you like to add a 1 day Governance retention period to file1.txt in ${state.lockEnabledBucketName}?
Reminder: Only a user with the s3:BypassGovernanceRetention permission will be able to delete this file or its bucket until the retention period has expired.`,
{
type: "confirm",
},
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const setRetentionPeriodFileEnabledAction = (scenarios, client) =>
new scenarios.ScenarioAction(
"setRetentionPeriodFileEnabledAction",
async (state) => {
const retentionDate = new Date();
retentionDate.setDate(retentionDate.getDate() + 1);
await client.send(
new PutObjectRetentionCommand({
Bucket: state.lockEnabledBucketName,
Key: "file1.txt",
Retention: {
Mode: ObjectLockRetentionMode.GOVERNANCE,
RetainUntilDate: retentionDate,
},
}),
);
console.log(
`Set retention for file1.txt in <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>t</mi><mi>a</mi><mi>t</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>l</mi><mi>o</mi><mi>c</mi><mi>k</mi><mi>E</mi><mi>n</mi><mi>a</mi><mi>b</mi><mi>l</mi><mi>e</mi><mi>d</mi><mi>B</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi><mi>N</mi><mi>a</mi><mi>m</mi><mi>e</mi></mrow><mi>u</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>l</mi></mrow><annotation encoding="application/x-tex">{state.lockEnabledBucketName} until </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">s</span><span class="mord mathnormal">t</span><span class="mord mathnormal">a</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">oc</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.05764em;">E</span><span class="mord mathnormal">nab</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.05017em;">B</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right:0.10903em;">tN</span><span class="mord mathnormal">am</span><span class="mord mathnormal">e</span></span><span class="mord mathnormal">u</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span></span></span></span>{retentionDate.toISOString().split("T")[0]}.`,
);
},
{ skipWhen: (state) => !state.confirmSetRetentionPeriodFileEnabled },
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const confirmSetLegalHoldFileRetention = (scenarios) =>
new scenarios.ScenarioInput(
"confirmSetLegalHoldFileRetention",
(state) =>
`Would you like to add a legal hold to file0.txt in ${state.retentionBucketName}?`,
{
type: "confirm",
},
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const setLegalHoldFileRetentionAction = (scenarios, client) =>
new scenarios.ScenarioAction(
"setLegalHoldFileRetentionAction",
async (state) => {
await client.send(
new PutObjectLegalHoldCommand({
Bucket: state.retentionBucketName,
Key: "file0.txt",
LegalHold: {
Status: ObjectLockLegalHoldStatus.ON,
},
}),
);
console.log(
`Modified legal hold for file0.txt in ${state.retentionBucketName}.`,
);
},
{ skipWhen: (state) => !state.confirmSetLegalHoldFileRetention },
);
/**
* @param {Scenarios} scenarios
*/
const confirmSetRetentionPeriodFileRetention = (scenarios) =>
new scenarios.ScenarioInput(
"confirmSetRetentionPeriodFileRetention",
(state) =>
`Would you like to add a 1 day Governance retention period to file1.txt in ${state.retentionBucketName}?
Reminder: Only a user with the s3:BypassGovernanceRetention permission will be able to delete this file or its bucket until the retention period has expired.`,
{
type: "confirm",
},
);
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const setRetentionPeriodFileRetentionAction = (scenarios, client) =>
new scenarios.ScenarioAction(
"setRetentionPeriodFileRetentionAction",
async (state) => {
const retentionDate = new Date();
retentionDate.setDate(retentionDate.getDate() + 1);
await client.send(
new PutObjectRetentionCommand({
Bucket: state.retentionBucketName,
Key: "file1.txt",
Retention: {
Mode: ObjectLockRetentionMode.GOVERNANCE,
RetainUntilDate: retentionDate,
},
BypassGovernanceRetention: true,
}),
);
console.log(
`Set retention for file1.txt in <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>t</mi><mi>a</mi><mi>t</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>r</mi><mi>e</mi><mi>t</mi><mi>e</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>o</mi><mi>n</mi><mi>B</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi><mi>N</mi><mi>a</mi><mi>m</mi><mi>e</mi></mrow><mi>u</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>l</mi></mrow><annotation encoding="application/x-tex">{state.retentionBucketName} until </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">s</span><span class="mord mathnormal">t</span><span class="mord mathnormal">a</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal">re</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal">o</span><span class="mord mathnormal">n</span><span class="mord mathnormal" style="margin-right:0.05017em;">B</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal" style="margin-right:0.10903em;">tN</span><span class="mord mathnormal">am</span><span class="mord mathnormal">e</span></span><span class="mord mathnormal">u</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span></span></span></span>{retentionDate.toISOString().split("T")[0]}.`,
);
},
{ skipWhen: (state) => !state.confirmSetRetentionPeriodFileRetention },
);
export {
getBucketPrefix,
createBuckets,
confirmCreateBuckets,
createBucketsAction,
populateBuckets,
confirmPopulateBuckets,
populateBucketsAction,
updateRetention,
confirmUpdateRetention,
updateRetentionAction,
updateLockPolicy,
confirmUpdateLockPolicy,
updateLockPolicyAction,
confirmSetLegalHoldFileEnabled,
setLegalHoldFileEnabledAction,
confirmSetRetentionPeriodFileEnabled,
setRetentionPeriodFileEnabledAction,
confirmSetLegalHoldFileRetention,
setLegalHoldFileRetentionAction,
confirmSetRetentionPeriodFileRetention,
setRetentionPeriodFileRetentionAction,
};
View and delete files in the buckets (repl.steps.js).
import {
ChecksumAlgorithm,
DeleteObjectCommand,
GetObjectLegalHoldCommand,
GetObjectLockConfigurationCommand,
GetObjectRetentionCommand,
ListObjectVersionsCommand,
PutObjectCommand,
} from "@aws-sdk/client-s3";
/**
* @typedef {import("@aws-doc-sdk-examples/lib/scenario/index.js")} Scenarios
*/
/**
* @typedef {import("@aws-sdk/client-s3").S3Client} S3Client
*/
const choices = {
EXIT: 0,
LIST_ALL_FILES: 1,
DELETE_FILE: 2,
DELETE_FILE_WITH_RETENTION: 3,
OVERWRITE_FILE: 4,
VIEW_RETENTION_SETTINGS: 5,
VIEW_LEGAL_HOLD_SETTINGS: 6,
};
/**
* @param {Scenarios} scenarios
*/
const replInput = (scenarios) =>
new scenarios.ScenarioInput(
"replChoice",
"Explore the S3 locking features by selecting one of the following choices",
{
type: "select",
choices: [
{ name: "List all files in buckets", value: choices.LIST_ALL_FILES },
{ name: "Attempt to delete a file.", value: choices.DELETE_FILE },
{
name: "Attempt to delete a file with retention period bypass.",
value: choices.DELETE_FILE_WITH_RETENTION,
},
{ name: "Attempt to overwrite a file.", value: choices.OVERWRITE_FILE },
{
name: "View the object and bucket retention settings for a file.",
value: choices.VIEW_RETENTION_SETTINGS,
},
{
name: "View the legal hold settings for a file.",
value: choices.VIEW_LEGAL_HOLD_SETTINGS,
},
{ name: "Finish the workflow.", value: choices.EXIT },
],
},
);
/**
* @param {S3Client} client
* @param {string[]} buckets
*/
const getAllFiles = async (client, buckets) => {
/** @type {{bucket: string, key: string, version: string}[]} */
const files = [];
for (const bucket of buckets) {
const objectsResponse = await client.send(
new ListObjectVersionsCommand({ Bucket: bucket }),
);
for (const version of objectsResponse.Versions || []) {
const { Key, VersionId } = version;
files.push({ bucket, key: Key, version: VersionId });
}
}
return files;
};
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const replAction = (scenarios, client) =>
new scenarios.ScenarioAction(
"replAction",
async (state) => {
const files = await getAllFiles(client, [
state.noLockBucketName,
state.lockEnabledBucketName,
state.retentionBucketName,
]);
const fileInput = new scenarios.ScenarioInput(
"selectedFile",
"Select a file:",
{
type: "select",
choices: files.map((file, index) => ({
name: `${index + 1}: <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>f</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>b</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi></mrow><mo>:</mo></mrow><annotation encoding="application/x-tex">{file.bucket}: </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal" style="margin-right:0.10764em;">f</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal">b</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span></span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">:</span></span></span></span>{file.key} (version: ${
file.version
})`,
value: index,
})),
},
);
const { replChoice } = state;
switch (replChoice) {
case choices.LIST_ALL_FILES: {
const files = await getAllFiles(client, [
state.noLockBucketName,
state.lockEnabledBucketName,
state.retentionBucketName,
]);
state.replOutput = files
.map(
(file) =>
`${file.bucket}: <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>f</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mo stretchy="false">(</mo><mi>v</mi><mi>e</mi><mi>r</mi><mi>s</mi><mi>i</mi><mi>o</mi><mi>n</mi><mo>:</mo></mrow><annotation encoding="application/x-tex">{file.key} (version: </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:1em;vertical-align:-0.25em;"></span><span class="mord"><span class="mord mathnormal" style="margin-right:0.10764em;">f</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mopen">(</span><span class="mord mathnormal" style="margin-right:0.03588em;">v</span><span class="mord mathnormal">ers</span><span class="mord mathnormal">i</span><span class="mord mathnormal">o</span><span class="mord mathnormal">n</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">:</span></span></span></span>{file.version})`,
)
.join("\n");
break;
}
case choices.DELETE_FILE: {
/** @type {number} */
const fileToDelete = await fileInput.handle(state);
const selectedFile = files[fileToDelete];
try {
await client.send(
new DeleteObjectCommand({
Bucket: selectedFile.bucket,
Key: selectedFile.key,
VersionId: selectedFile.version,
}),
);
state.replOutput = `Deleted <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}.`;
} catch (err) {
state.replOutput = `Unable to delete object <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi><mi>b</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in bucket </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">inb</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span></span></span></span>{selectedFile.bucket}: ${err.message}`;
}
break;
}
case choices.DELETE_FILE_WITH_RETENTION: {
/** @type {number} */
const fileToDelete = await fileInput.handle(state);
const selectedFile = files[fileToDelete];
try {
await client.send(
new DeleteObjectCommand({
Bucket: selectedFile.bucket,
Key: selectedFile.key,
VersionId: selectedFile.version,
BypassGovernanceRetention: true,
}),
);
state.replOutput = `Deleted <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}.`;
} catch (err) {
state.replOutput = `Unable to delete object <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi><mi>b</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in bucket </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">inb</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span></span></span></span>{selectedFile.bucket}: ${err.message}`;
}
break;
}
case choices.OVERWRITE_FILE: {
/** @type {number} */
const fileToOverwrite = await fileInput.handle(state);
const selectedFile = files[fileToOverwrite];
try {
await client.send(
new PutObjectCommand({
Bucket: selectedFile.bucket,
Key: selectedFile.key,
Body: "New content",
ChecksumAlgorithm: ChecksumAlgorithm.SHA256,
}),
);
state.replOutput = `Overwrote <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}.`;
} catch (err) {
state.replOutput = `Unable to overwrite object <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi><mi>b</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in bucket </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">inb</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span></span></span></span>{selectedFile.bucket}: ${err.message}`;
}
break;
}
case choices.VIEW_RETENTION_SETTINGS: {
/** @type {number} */
const fileToView = await fileInput.handle(state);
const selectedFile = files[fileToView];
try {
const retention = await client.send(
new GetObjectRetentionCommand({
Bucket: selectedFile.bucket,
Key: selectedFile.key,
VersionId: selectedFile.version,
}),
);
const bucketConfig = await client.send(
new GetObjectLockConfigurationCommand({
Bucket: selectedFile.bucket,
}),
);
state.replOutput = `Object retention for <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}: <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>r</mi><mi>e</mi><mi>t</mi><mi>e</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>o</mi><mi>n</mi><mi mathvariant="normal">.</mi><mi>R</mi><mi>e</mi><mi>t</mi><mi>e</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>o</mi><mi>n</mi><mo stretchy="false">?</mo><mi mathvariant="normal">.</mi><mi>M</mi><mi>o</mi><mi>d</mi><mi>e</mi></mrow><mi>u</mi><mi>n</mi><mi>t</mi><mi>i</mi><mi>l</mi></mrow><annotation encoding="application/x-tex">{retention.Retention?.Mode} until </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">re</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal">o</span><span class="mord mathnormal">n</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.00773em;">R</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal">o</span><span class="mord mathnormal">n</span><span class="mclose">?</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.10903em;">M</span><span class="mord mathnormal">o</span><span class="mord mathnormal">d</span><span class="mord mathnormal">e</span></span><span class="mord mathnormal">u</span><span class="mord mathnormal">n</span><span class="mord mathnormal">t</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span></span></span></span>{retention.Retention?.RetainUntilDate?.toISOString()}.
Bucket object lock config for <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>b</mi><mi>u</mi><mi>c</mi><mi>k</mi><mi>e</mi><mi>t</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.bucket} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.6944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal">b</span><span class="mord mathnormal">u</span><span class="mord mathnormal">c</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal">e</span><span class="mord mathnormal">t</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}:
Enabled: ${bucketConfig.ObjectLockConfiguration?.ObjectLockEnabled}
Rule: ${JSON.stringify(bucketConfig.ObjectLockConfiguration?.Rule?.DefaultRetention)}`;
} catch (err) {
state.replOutput = `Unable to fetch object lock retention: '${err.message}'`;
}
break;
}
case choices.VIEW_LEGAL_HOLD_SETTINGS: {
/** @type {number} */
const fileToView = await fileInput.handle(state);
const selectedFile = files[fileToView];
try {
const legalHold = await client.send(
new GetObjectLegalHoldCommand({
Bucket: selectedFile.bucket,
Key: selectedFile.key,
VersionId: selectedFile.version,
}),
);
state.replOutput = `Object legal hold for <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>s</mi><mi>e</mi><mi>l</mi><mi>e</mi><mi>c</mi><mi>t</mi><mi>e</mi><mi>d</mi><mi>F</mi><mi>i</mi><mi>l</mi><mi>e</mi><mi mathvariant="normal">.</mi><mi>k</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{selectedFile.key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8889em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal">se</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">ec</span><span class="mord mathnormal">t</span><span class="mord mathnormal">e</span><span class="mord mathnormal">d</span><span class="mord mathnormal" style="margin-right:0.13889em;">F</span><span class="mord mathnormal">i</span><span class="mord mathnormal" style="margin-right:0.01968em;">l</span><span class="mord mathnormal">e</span><span class="mord">.</span><span class="mord mathnormal" style="margin-right:0.03148em;">k</span><span class="mord mathnormal" style="margin-right:0.03588em;">ey</span></span><span class="mord mathnormal">in</span></span></span></span>{selectedFile.bucket}: Status: ${legalHold.LegalHold?.Status}`;
} catch (err) {
state.replOutput = `Unable to fetch legal hold: '${err.message}'`;
}
break;
}
default:
throw new Error(`Invalid replChoice: ${replChoice}`);
}
},
{
whileConfig: {
whileFn: ({ replChoice }) => replChoice !== choices.EXIT,
input: replInput(scenarios),
output: new scenarios.ScenarioOutput(
"REPL output",
(state) => state.replOutput,
{ preformatted: true },
),
},
},
);
export { replInput, replAction, choices };
Destroy all created resources (clean.steps.js).
import {
DeleteObjectCommand,
DeleteBucketCommand,
ListObjectVersionsCommand,
GetObjectLegalHoldCommand,
GetObjectRetentionCommand,
PutObjectLegalHoldCommand,
} from "@aws-sdk/client-s3";
/**
* @typedef {import("@aws-doc-sdk-examples/lib/scenario/index.js")} Scenarios
*/
/**
* @typedef {import("@aws-sdk/client-s3").S3Client} S3Client
*/
/**
* @param {Scenarios} scenarios
*/
const confirmCleanup = (scenarios) =>
new scenarios.ScenarioInput("confirmCleanup", "Clean up resources?", {
type: "confirm",
});
/**
* @param {Scenarios} scenarios
* @param {S3Client} client
*/
const cleanupAction = (scenarios, client) =>
new scenarios.ScenarioAction("cleanupAction", async (state) => {
const { noLockBucketName, lockEnabledBucketName, retentionBucketName } =
state;
const buckets = [
noLockBucketName,
lockEnabledBucketName,
retentionBucketName,
];
for (const bucket of buckets) {
/** @type {import("@aws-sdk/client-s3").ListObjectVersionsCommandOutput} */
let objectsResponse;
try {
objectsResponse = await client.send(
new ListObjectVersionsCommand({
Bucket: bucket,
}),
);
} catch (e) {
if (e instanceof Error && e.name === "NoSuchBucket") {
console.log("Object's bucket has already been deleted.");
continue;
}
throw e;
}
for (const version of objectsResponse.Versions || []) {
const { Key, VersionId } = version;
try {
const legalHold = await client.send(
new GetObjectLegalHoldCommand({
Bucket: bucket,
Key,
VersionId,
}),
);
if (legalHold.LegalHold?.Status === "ON") {
await client.send(
new PutObjectLegalHoldCommand({
Bucket: bucket,
Key,
VersionId,
LegalHold: {
Status: "OFF",
},
}),
);
}
} catch (err) {
console.log(
`Unable to fetch legal hold for <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>K</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{Key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8778em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal" style="margin-right:0.03588em;">Key</span></span><span class="mord mathnormal">in</span></span></span></span>{bucket}: '${err.message}'`,
);
}
try {
const retention = await client.send(
new GetObjectRetentionCommand({
Bucket: bucket,
Key,
VersionId,
}),
);
if (retention.Retention?.Mode === "GOVERNANCE") {
await client.send(
new DeleteObjectCommand({
Bucket: bucket,
Key,
VersionId,
BypassGovernanceRetention: true,
}),
);
}
} catch (err) {
console.log(
`Unable to fetch object lock retention for <span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mrow><mi>K</mi><mi>e</mi><mi>y</mi></mrow><mi>i</mi><mi>n</mi></mrow><annotation encoding="application/x-tex">{Key} in </annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.8778em;vertical-align:-0.1944em;"></span><span class="mord"><span class="mord mathnormal" style="margin-right:0.03588em;">Key</span></span><span class="mord mathnormal">in</span></span></span></span>{bucket}: '${err.message}'`,
);
}
await client.send(
new DeleteObjectCommand({
Bucket: bucket,
Key,
VersionId,
}),
);
}
await client.send(new DeleteBucketCommand({ Bucket: bucket }));
console.log(`Delete for ${bucket} complete.`);
}
});
export { confirmCleanup, cleanupAction };
- For API details, see the following topics in AWS SDK for JavaScript API Reference.