com.amazonaws.services.s3control.model

Class CreateAccessPointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3control.model.CreateAccessPointRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAccessPointRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAccessPointRequest()

Method Summary

Modifier and Type	Method and Description
CreateAccessPointRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAccountId() The Amazon Web Services account ID for the account that owns the specified access point.
String	getBucket() The name of the bucket that you want to associate this access point with.
String	getBucketAccountId() The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
String	getName() The name you want to assign to this access point.
PublicAccessBlockConfiguration	getPublicAccessBlockConfiguration() The PublicAccessBlock configuration that you want to apply to the access point.
VpcConfiguration	getVpcConfiguration() If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
int	hashCode()
void	setAccountId(String accountId) The Amazon Web Services account ID for the account that owns the specified access point.
void	setBucket(String bucket) The name of the bucket that you want to associate this access point with.
void	setBucketAccountId(String bucketAccountId) The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
void	setName(String name) The name you want to assign to this access point.
void	setPublicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration) The PublicAccessBlock configuration that you want to apply to the access point.
void	setVpcConfiguration(VpcConfiguration vpcConfiguration) If you include this field, Amazon S3 restricts access to this access point to requests from the specified virtual private cloud (VPC).
String	toString() Returns a string representation of this object.
CreateAccessPointRequest	withAccountId(String accountId) The Amazon Web Services account ID for the account that owns the specified access point.
CreateAccessPointRequest	withBucket(String bucket) The name of the bucket that you want to associate this access point with.
CreateAccessPointRequest	withBucketAccountId(String bucketAccountId) The Amazon Web Services account ID associated with the S3 bucket associated with this access point.
CreateAccessPointRequest	withName(String name) The name you want to assign to this access point.
CreateAccessPointRequest	withPublicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration) The PublicAccessBlock configuration that you want to apply to the access point.
CreateAccessPointRequest	withVpcConfiguration(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 com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAccessPointRequest

public CreateAccessPointRequest()

Method Detail

setAccountId

public void setAccountId(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.

getAccountId

public String getAccountId()

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

Returns:

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

withAccountId

public CreateAccessPointRequest withAccountId(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.

setName

public void setName(String name)

The name you want to assign to this access point.

Parameters:

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

getName

public String getName()

The name you want to assign to this access point.

Returns:

The name you want to assign to this access point.

withName

public CreateAccessPointRequest withName(String name)

The name you want to assign to this access point.

Parameters:

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

Returns:

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

setBucket

public void setBucket(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.

getBucket

public String getBucket()

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.

withBucket

public CreateAccessPointRequest withBucket(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.

setVpcConfiguration

public void setVpcConfiguration(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.

getVpcConfiguration

public VpcConfiguration getVpcConfiguration()

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.

withVpcConfiguration

public CreateAccessPointRequest withVpcConfiguration(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.

setPublicAccessBlockConfiguration

public void setPublicAccessBlockConfiguration(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.

getPublicAccessBlockConfiguration

public PublicAccessBlockConfiguration getPublicAccessBlockConfiguration()

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.

withPublicAccessBlockConfiguration

public CreateAccessPointRequest withPublicAccessBlockConfiguration(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.

setBucketAccountId

public void setBucketAccountId(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.

getBucketAccountId

public String getBucketAccountId()

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:

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.

withBucketAccountId

public CreateAccessPointRequest withBucketAccountId(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAccessPointRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()