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

Interface PutAccessPointPolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutAccessPointPolicyRequest.Builder,PutAccessPointPolicyRequest>, S3ControlRequest.Builder, SdkBuilder<PutAccessPointPolicyRequest.Builder,PutAccessPointPolicyRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutAccessPointPolicyRequest

@Mutable
@NotThreadSafe
public static interface PutAccessPointPolicyRequest.Builder
extends S3ControlRequest.Builder, SdkPojo, CopyableBuilder<PutAccessPointPolicyRequest.Builder,PutAccessPointPolicyRequest>

Method Summary

Modifier and Type	Method	Description
PutAccessPointPolicyRequest.Builder	accountId(String accountId)	The Amazon Web Services account ID for owner of the bucket associated with the specified access point.
PutAccessPointPolicyRequest.Builder	name(String name)	The name of the access point that you want to associate with the specified policy.
PutAccessPointPolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutAccessPointPolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutAccessPointPolicyRequest.Builder	policy(String policy)	The policy that you want to apply to the specified access point.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.s3control.model.S3ControlRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

accountId

PutAccessPointPolicyRequest.Builder accountId(String accountId)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

name

PutAccessPointPolicyRequest.Builder name(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

policy

PutAccessPointPolicyRequest.Builder policy(String policy)

The policy that you want to apply to the specified access point. For more information about access point policies, see Managing access to shared datasets in general purpose buckets with access points or Managing access to shared datasets in directory bucekts with access points in the Amazon S3 User Guide.

Parameters:

policy - The policy that you want to apply to the specified access point. For more information about access point policies, see Managing access to shared datasets in general purpose buckets with access points or Managing access to shared datasets in directory bucekts with access points in the Amazon S3 User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

PutAccessPointPolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutAccessPointPolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder