Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PutObjectLockConfigurationCommand

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

  • The DefaultRetention settings require both a mode and a period.

  • The DefaultRetention period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

  • You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact Amazon Web Services Support.

example

Use a bare-bones client and the command you need to make an API call.

import { S3Client, PutObjectLockConfigurationCommand } from "@aws-sdk/client-s3"; // ES Modules import
// const { S3Client, PutObjectLockConfigurationCommand } = require("@aws-sdk/client-s3"); // CommonJS import
const client = new S3Client(config);
const command = new PutObjectLockConfigurationCommand(input);
const response = await client.send(command);
see

PutObjectLockConfigurationCommandInput for command's input shape.

see

PutObjectLockConfigurationCommandOutput for command's response shape.

see

config for S3Client's config shape.

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly input

input: PutObjectLockConfigurationCommandInput

Readonly middlewareStack