Package software.amazon.awssdk.services.s3control.model

Class PutBucketPolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3control.model.S3ControlRequest

software.amazon.awssdk.services.s3control.model.PutBucketPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutBucketPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The Amazon Web Services account ID of the Outposts bucket.
String	bucket()	Specifies the bucket.
static PutBucketPolicyRequest.Builder	builder()
Boolean	confirmRemoveSelfBucketAccess()	Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	policy()	The bucket policy as a JSON document.
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

accountId

public final String accountId()

The Amazon Web Services account ID of the Outposts bucket.

Returns:

The Amazon Web Services account ID of the Outposts bucket.

bucket

public final String bucket()

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

Returns:

Specifies the bucket.

For using this parameter with Amazon S3 on Outposts with the REST API, you must specify the name and the x-amz-outpost-id as well.

For using this parameter with S3 on Outposts with the Amazon Web Services SDK and CLI, you must specify the ARN of the bucket accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/bucket/<my-bucket-name> . For example, to access the bucket reports through Outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/bucket/reports. The value must be URL encoded.

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 is not supported by Amazon S3 on Outposts 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 is not supported by Amazon S3 on Outposts buckets.

policy

public final String policy()

The bucket policy as a JSON document.

Returns:

The bucket policy as a JSON document.

toBuilder

public PutBucketPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutBucketPolicyRequest.Builder,PutBucketPolicyRequest>

Specified by:

toBuilder in class S3ControlRequest

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