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

Class PutAccessPointPolicyRequest

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.PutAccessPointPolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutAccessPointPolicyRequest.Builder,PutAccessPointPolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutAccessPointPolicyRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The Amazon Web Services account ID for owner of the bucket associated with the specified access point.
static PutAccessPointPolicyRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name()	The name of the access point that you want to associate with the specified policy.
String	policy()	The policy that you want to apply to the specified access point.
List<SdkField<?>>	sdkFields()
static Class<? extends PutAccessPointPolicyRequest.Builder>	serializableBuilderClass()
PutAccessPointPolicyRequest.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 for owner of the bucket associated with the specified access point.

Returns:

The Amazon Web Services account ID for owner of the bucket associated with the specified access point.

name

public final String name()

The name of the access point that you want to associate with the specified policy.

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 access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.

Returns:

The name of the access point that you want to associate with the specified policy.

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 access point accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/accesspoint/<my-accesspoint-name> . For example, to access the access point reports-ap 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/accesspoint/reports-ap. The value must be URL encoded.

policy

public final String policy()

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

Returns:

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing data access with Amazon S3 access points in the Amazon S3 User Guide.

toBuilder

public PutAccessPointPolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutAccessPointPolicyRequest.Builder,PutAccessPointPolicyRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static PutAccessPointPolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutAccessPointPolicyRequest.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