@aws-sdk/client-s3

PutPublicAccessBlockCommandInput Interface

The input for PutPublicAccessBlockCommand.

Members

Name
Type
Details
Bucket Requiredstring | undefined

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

Note: To supply the Multi-region Access Point (MRAP) to Bucket, you need to install the "aws-sdk/signature-v4-crt" package to your project dependencies. For more information, please go to https://github.com/aws/aws-sdk-js-v3#known-issues

PublicAccessBlockConfiguration RequiredPublicAccessBlockConfiguration | undefined

The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of "Public"  in the Amazon S3 User Guide.

ChecksumAlgorithm ChecksumAlgorithm | undefined

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don't use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity  in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

ContentMD5 string | undefined

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

ExpectedBucketOwner string | undefined

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Full Signature

export interface PutPublicAccessBlockCommandInput extends PutPublicAccessBlockRequest