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

Interface CreateAccessPointRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateAccessPointRequest

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

Method Summary

Modifier and Type	Method	Description
CreateAccessPointRequest.Builder	accountId(String accountId)	The Amazon Web Services account ID for the account that owns the specified access point.
CreateAccessPointRequest.Builder	bucket(String bucket)	The name of the bucket that you want to associate this access point with.
CreateAccessPointRequest.Builder	bucketAccountId(String bucketAccountId)	The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
CreateAccessPointRequest.Builder	name(String name)	The name you want to assign to this access point.
CreateAccessPointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateAccessPointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
default CreateAccessPointRequest.Builder	publicAccessBlockConfiguration(Consumer<PublicAccessBlockConfiguration.Builder> publicAccessBlockConfiguration)	The PublicAccessBlock configuration that you want to apply to the access point.
CreateAccessPointRequest.Builder	publicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration)	The PublicAccessBlock configuration that you want to apply to the access point.
default CreateAccessPointRequest.Builder	scope(Consumer<Scope.Builder> scope)	For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both.
CreateAccessPointRequest.Builder	scope(Scope scope)	For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both.
default CreateAccessPointRequest.Builder	vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)	If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
CreateAccessPointRequest.Builder	vpcConfiguration(VpcConfiguration vpcConfiguration)	If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

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

CreateAccessPointRequest.Builder accountId(String accountId)

The Amazon Web Services account ID for the account that owns the specified access point.

Parameters:

accountId - The Amazon Web Services account ID for the account that owns the specified access point.

Returns:

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

name

CreateAccessPointRequest.Builder name(String name)

The name you want to assign to this access point.

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Parameters:

name - The name you want to assign to this access point.

For directory buckets, the access point name must consist of a base name that you provide and suffix that includes the ZoneID (Amazon Web Services Availability Zone or Local Zone) of your bucket location, followed by --xa-s3. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Returns:

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

bucket

CreateAccessPointRequest.Builder bucket(String bucket)

The name of the bucket that you want to associate this access point with.

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.

Parameters:

bucket - The name of the bucket that you want to associate this access point with.

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:

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

vpcConfiguration

CreateAccessPointRequest.Builder vpcConfiguration(VpcConfiguration vpcConfiguration)

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Parameters:

vpcConfiguration - If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

Returns:

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

vpcConfiguration

default CreateAccessPointRequest.Builder vpcConfiguration(Consumer<VpcConfiguration.Builder> vpcConfiguration)

If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).

This is required for creating an access point for Amazon S3 on Outposts buckets.

This is a convenience method that creates an instance of the VpcConfiguration.Builder avoiding the need to create one manually via VpcConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vpcConfiguration(VpcConfiguration).

Parameters:

vpcConfiguration - a consumer that will call methods on VpcConfiguration.Builder

Returns:

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

See Also:

vpcConfiguration(VpcConfiguration)

publicAccessBlockConfiguration

CreateAccessPointRequest.Builder publicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration)

The PublicAccessBlock configuration that you want to apply to the access point.

Parameters:

publicAccessBlockConfiguration - The PublicAccessBlock configuration that you want to apply to the access point.

Returns:

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

publicAccessBlockConfiguration

default CreateAccessPointRequest.Builder publicAccessBlockConfiguration(Consumer<PublicAccessBlockConfiguration.Builder> publicAccessBlockConfiguration)

The PublicAccessBlock configuration that you want to apply to the access point.

This is a convenience method that creates an instance of the PublicAccessBlockConfiguration.Builder avoiding the need to create one manually via PublicAccessBlockConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to publicAccessBlockConfiguration(PublicAccessBlockConfiguration).

Parameters:

publicAccessBlockConfiguration - a consumer that will call methods on PublicAccessBlockConfiguration.Builder

Returns:

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

See Also:

publicAccessBlockConfiguration(PublicAccessBlockConfiguration)

bucketAccountId

CreateAccessPointRequest.Builder bucketAccountId(String bucketAccountId)

The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

Parameters:

bucketAccountId - The Amazon Web Services account ID associated with the S3 bucket associated with this access point.

For same account access point when your bucket and access point belong to the same account owner, the BucketAccountId is not required. For cross-account access point when your bucket and access point are not in the same account, the BucketAccountId is required.

Returns:

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

scope

CreateAccessPointRequest.Builder scope(Scope scope)

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Scope is not supported for access points for general purpose buckets.

Parameters:

scope - For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Scope is not supported for access points for general purpose buckets.

Returns:

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

scope

default CreateAccessPointRequest.Builder scope(Consumer<Scope.Builder> scope)

For directory buckets, you can filter access control to specific prefixes, API operations, or a combination of both. For more information, see Managing access to shared datasets in directory buckets with access points in the Amazon S3 User Guide.

Scope is not supported for access points for general purpose buckets.

This is a convenience method that creates an instance of the Scope.Builder avoiding the need to create one manually via Scope.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to scope(Scope).

Parameters:

scope - a consumer that will call methods on Scope.Builder

Returns:

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

See Also:

scope(Scope)

overrideConfiguration

CreateAccessPointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder