/* * Copyright 2018-2023 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 PutAccessPointPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The Amazon Web Services account ID for owner of the bucket associated with the specified access point. *
*/ private String accountId; /** ** 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.
*
* The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing data * access with Amazon S3 access points in the Amazon S3 User Guide. *
*/ private String policy; /** ** The Amazon Web Services account ID for owner of the bucket associated with the specified access point. *
* * @param accountId * The Amazon Web Services account ID for owner of the bucket associated with the specified access point. */ public void setAccountId(String accountId) { this.accountId = accountId; } /** ** The Amazon Web Services account ID for owner of the bucket associated with the specified access point. *
* * @return The Amazon Web Services account ID for owner of the bucket associated with the specified access point. */ public String getAccountId() { return this.accountId; } /** ** The Amazon Web Services account ID for owner of the bucket associated with the specified access point. *
* * @param accountId * The Amazon Web Services account ID for owner of the bucket associated with the specified access point. * @return Returns a reference to this object so that method calls can be chained together. */ public PutAccessPointPolicyRequest withAccountId(String accountId) { setAccountId(accountId); return this; } /** ** 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.
*
* 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.
*/
public void setName(String name) {
this.name = 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.
*
* 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.
*/
public String getName() {
return this.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.
*
* 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutAccessPointPolicyRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing data * access with Amazon S3 access points in the Amazon S3 User Guide. *
* * @param policy * The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing * data access with Amazon S3 access points in the Amazon S3 User Guide. */ public void setPolicy(String policy) { this.policy = policy; } /** ** The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing data * access with Amazon S3 access points in the Amazon S3 User Guide. *
* * @return The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing * data access with Amazon S3 access points in the Amazon S3 User Guide. */ public String getPolicy() { return this.policy; } /** ** The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing data * access with Amazon S3 access points in the Amazon S3 User Guide. *
* * @param policy * The policy that you want to apply to the specified access point. For more information about access point * policies, see Managing * data access with Amazon S3 access points in the Amazon S3 User Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public PutAccessPointPolicyRequest withPolicy(String policy) { setPolicy(policy); 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 (getPolicy() != null) sb.append("Policy: ").append(getPolicy()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof PutAccessPointPolicyRequest == false) return false; PutAccessPointPolicyRequest other = (PutAccessPointPolicyRequest) 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.getPolicy() == null ^ this.getPolicy() == null) return false; if (other.getPolicy() != null && other.getPolicy().equals(this.getPolicy()) == 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 + ((getPolicy() == null) ? 0 : getPolicy().hashCode()); return hashCode; } @Override public PutAccessPointPolicyRequest clone() { return (PutAccessPointPolicyRequest) super.clone(); } }