com.amazonaws.services.s3control.model.CreateAccessPointRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3control Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.s3control.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateAccessPointRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Web Services account ID for the account that owns the specified access point.
*
*/
private String accountId;
/**
*
* The name you want to assign to this access point.
*
*/
private String name;
/**
*
* 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.
*
*/
private String bucket;
/**
*
* 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.
*
*
*/
private VpcConfiguration vpcConfiguration;
/**
*
* The PublicAccessBlock configuration that you want to apply to the access point.
*
*/
private PublicAccessBlockConfiguration publicAccessBlockConfiguration;
/**
*
* 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.
*
*/
private String bucketAccountId;
/**
*
* The Amazon Web Services account ID for the account that owns the specified access point.
*
*
* @param accountId
* The Amazon Web Services account ID for the account that owns the specified access point.
*/
public void setAccountId(String accountId) {
this.accountId = accountId;
}
/**
*
* The Amazon Web Services account ID for the account that owns the specified access point.
*
*
* @return The Amazon Web Services account ID for the account that owns the specified access point.
*/
public String getAccountId() {
return this.accountId;
}
/**
*
* The Amazon Web Services account ID for the account that owns the specified access point.
*
*
* @param accountId
* The Amazon Web Services account ID for the account that owns the specified access point.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withAccountId(String accountId) {
setAccountId(accountId);
return this;
}
/**
*
* The name you want to assign to this access point.
*
*
* @param name
* The name you want to assign to this access point.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name you want to assign to this access point.
*
*
* @return The name you want to assign to this access point.
*/
public String getName() {
return this.name;
}
/**
*
* The name you want to assign to this access point.
*
*
* @param name
* The name you want to assign to this access point.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withName(String name) {
setName(name);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setBucket(String bucket) {
this.bucket = 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.
*
*
* @return 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.
*/
public String getBucket() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withBucket(String bucket) {
setBucket(bucket);
return this;
}
/**
*
* 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.
*
*
*
* @param 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.
*
*/
public void setVpcConfiguration(VpcConfiguration vpcConfiguration) {
this.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.
*
*
*
* @return 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.
*
*/
public VpcConfiguration getVpcConfiguration() {
return this.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.
*
*
*
* @param 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.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withVpcConfiguration(VpcConfiguration vpcConfiguration) {
setVpcConfiguration(vpcConfiguration);
return this;
}
/**
*
* The PublicAccessBlock configuration that you want to apply to the access point.
*
*
* @param publicAccessBlockConfiguration
* The PublicAccessBlock configuration that you want to apply to the access point.
*/
public void setPublicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration) {
this.publicAccessBlockConfiguration = publicAccessBlockConfiguration;
}
/**
*
* The PublicAccessBlock configuration that you want to apply to the access point.
*
*
* @return The PublicAccessBlock configuration that you want to apply to the access point.
*/
public PublicAccessBlockConfiguration getPublicAccessBlockConfiguration() {
return this.publicAccessBlockConfiguration;
}
/**
*
* The PublicAccessBlock configuration that you want to apply to the access point.
*
*
* @param publicAccessBlockConfiguration
* The PublicAccessBlock configuration that you want to apply to the access point.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withPublicAccessBlockConfiguration(PublicAccessBlockConfiguration publicAccessBlockConfiguration) {
setPublicAccessBlockConfiguration(publicAccessBlockConfiguration);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setBucketAccountId(String bucketAccountId) {
this.bucketAccountId = 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.
*
*
* @return 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.
*/
public String getBucketAccountId() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateAccessPointRequest withBucketAccountId(String bucketAccountId) {
setBucketAccountId(bucketAccountId);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAccountId() != null)
sb.append("AccountId: ").append(getAccountId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getBucket() != null)
sb.append("Bucket: ").append(getBucket()).append(",");
if (getVpcConfiguration() != null)
sb.append("VpcConfiguration: ").append(getVpcConfiguration()).append(",");
if (getPublicAccessBlockConfiguration() != null)
sb.append("PublicAccessBlockConfiguration: ").append(getPublicAccessBlockConfiguration()).append(",");
if (getBucketAccountId() != null)
sb.append("BucketAccountId: ").append(getBucketAccountId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateAccessPointRequest == false)
return false;
CreateAccessPointRequest other = (CreateAccessPointRequest) obj;
if (other.getAccountId() == null ^ this.getAccountId() == null)
return false;
if (other.getAccountId() != null && other.getAccountId().equals(this.getAccountId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getBucket() == null ^ this.getBucket() == null)
return false;
if (other.getBucket() != null && other.getBucket().equals(this.getBucket()) == false)
return false;
if (other.getVpcConfiguration() == null ^ this.getVpcConfiguration() == null)
return false;
if (other.getVpcConfiguration() != null && other.getVpcConfiguration().equals(this.getVpcConfiguration()) == false)
return false;
if (other.getPublicAccessBlockConfiguration() == null ^ this.getPublicAccessBlockConfiguration() == null)
return false;
if (other.getPublicAccessBlockConfiguration() != null
&& other.getPublicAccessBlockConfiguration().equals(this.getPublicAccessBlockConfiguration()) == false)
return false;
if (other.getBucketAccountId() == null ^ this.getBucketAccountId() == null)
return false;
if (other.getBucketAccountId() != null && other.getBucketAccountId().equals(this.getBucketAccountId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAccountId() == null) ? 0 : getAccountId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getBucket() == null) ? 0 : getBucket().hashCode());
hashCode = prime * hashCode + ((getVpcConfiguration() == null) ? 0 : getVpcConfiguration().hashCode());
hashCode = prime * hashCode + ((getPublicAccessBlockConfiguration() == null) ? 0 : getPublicAccessBlockConfiguration().hashCode());
hashCode = prime * hashCode + ((getBucketAccountId() == null) ? 0 : getBucketAccountId().hashCode());
return hashCode;
}
@Override
public CreateAccessPointRequest clone() {
return (CreateAccessPointRequest) super.clone();
}
}