java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.PutBucketPolicyRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutBucketPolicyRequest
extends S3Request
implements ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface PutBucketPolicyRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`bucket()`	The name of the bucket.
`static PutBucketPolicyRequest.Builder`	`builder()`
`ChecksumAlgorithm`	`checksumAlgorithm()`	Indicates the algorithm used to create the checksum for the request when you use the SDK.
`String`	`checksumAlgorithmAsString()`	Indicates the algorithm used to create the checksum for the request when you use the SDK.
`Boolean`	`confirmRemoveSelfBucketAccess()`	Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
`String`	`contentMD5()`	The MD5 hash of the request body.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()`	The account ID of the expected bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`policy()`	The bucket policy as a JSON document.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutBucketPolicyRequest.Builder>`	`serializableBuilderClass()`
`PutBucketPolicyRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bucket
```
public final String bucket()
```
    The name of the bucket.
    
    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
    
    Returns:
    
    The name of the bucket.
    
    Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region-code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren't supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must also follow the format bucket-base-name--zone-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide
  - contentMD5
```
public final String contentMD5()
```
    The MD5 hash of the request body.
    
    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The MD5 hash of the request body.
    
    For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.
    
    This functionality is not supported for directory buckets.
  - checksumAlgorithm
```
public final ChecksumAlgorithm checksumAlgorithm()
```
    Indicates the algorithm used to create the checksum for the request 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-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    Returns:
    
    Indicates the algorithm used to create the checksum for the request 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-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
    
    See Also:
    
    ChecksumAlgorithm
  - checksumAlgorithmAsString
```
public final String checksumAlgorithmAsString()
```
    Indicates the algorithm used to create the checksum for the request 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-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    Returns:
    
    Indicates the algorithm used to create the checksum for the request 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-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
    
    For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:
    
    CRC32
    
    CRC32C
    
    CRC64NVME
    
    SHA1
    
    SHA256
    
    For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 fails the request with a BadDigest error.
    
    For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that's used for performance.
    
    See Also:
    
    ChecksumAlgorithm
  - confirmRemoveSelfBucketAccess
```
public final Boolean confirmRemoveSelfBucketAccess()
```
    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
    
    This functionality is not supported for directory buckets.
  - policy
```
public final String policy()
```
    The bucket policy as a JSON document.
    
    For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession .
    
    Returns:
    
    The bucket policy as a JSON document.
    
    For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession.
  - expectedBucketOwner
```
public final String expectedBucketOwner()
```
    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).
    
    For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
    
    Returns:
    
    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).
    
    For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.
  - toBuilder
```
public PutBucketPolicyRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static PutBucketPolicyRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutBucketPolicyRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class PutBucketPolicyRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

bucket

contentMD5

checksumAlgorithm

checksumAlgorithmAsString

confirmRemoveSelfBucketAccess

policy

expectedBucketOwner

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField