software.amazon.awssdk.services.s3control.model

Class CreateAccessPointRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAccessPointRequest.Builder,CreateAccessPointRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAccessPointRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Web Services account ID for the owner of the bucket for which you want to create an access point.
String	bucket() The name of the bucket that you want to associate this access point with.
static CreateAccessPointRequest.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 you want to assign to this access point.
PublicAccessBlockConfiguration	publicAccessBlockConfiguration() The PublicAccessBlock configuration that you want to apply to the access point.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAccessPointRequest.Builder>	serializableBuilderClass()
CreateAccessPointRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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 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 the owner of the bucket for which you want to create an access point.

Returns:

The Amazon Web Services account ID for the owner of the bucket for which you want to create an access point.

name

public final String name()

The name you want to assign to this access point.

Returns:

The name you want to assign to this access point.

bucket

public final 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.

Returns:

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.

vpcConfiguration

public final 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.

Returns:

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.

publicAccessBlockConfiguration

public final PublicAccessBlockConfiguration publicAccessBlockConfiguration()

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

Returns:

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

toBuilder

public CreateAccessPointRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAccessPointRequest.Builder,CreateAccessPointRequest>

Specified by:

toBuilder in class S3ControlRequest

builder

public static CreateAccessPointRequest.Builder builder()

serializableBuilderClass

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