com.amazonaws.services.s3.model

Class SetBucketAclRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.SetBucketAclRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class SetBucketAclRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Request object containing all the options for setting a bucket's Access Control List (ACL).

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketAclRequest(String bucketName, AccessControlList acl) Constructs a new SetBucketAclRequest object, ready to set the specified ACL on the specified bucket when this request is executed.
SetBucketAclRequest(String bucketName, CannedAccessControlList acl) Constructs a new SetBucketAclRequest object, ready to set the specified canned ACL on the specified bucket when this request is executed.

Method Summary

Modifier and Type	Method and Description
AccessControlList	getAcl() Returns the custom ACL to be applied to the specified bucket when this request is executed.
String	getBucketName() Returns the name of the bucket whose ACL will be modified by this request when executed.
CannedAccessControlList	getCannedAcl() Returns the canned ACL to be applied to the specified bucket when this request is executed.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
SetBucketAclRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, copyBaseTo, 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

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetBucketAclRequest

public SetBucketAclRequest(String bucketName,
                           AccessControlList acl)

Constructs a new SetBucketAclRequest object, ready to set the specified ACL on the specified bucket when this request is executed.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucketName - The name of the bucket, or access point ARN, whose ACL will be set by this request.

acl - The custom Access Control List containing the access rules to apply to the specified bucket when this request is executed.

SetBucketAclRequest

public SetBucketAclRequest(String bucketName,
                           CannedAccessControlList acl)

Constructs a new SetBucketAclRequest object, ready to set the specified canned ACL on the specified bucket when this request is executed.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com.

When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucketName - The name of the bucket, or access point ARN, whose ACL will be set by this request.

acl - The Canned Access Control List to apply to the specified bucket when this request is executed.

Method Detail

getBucketName

public String getBucketName()

Returns the name of the bucket whose ACL will be modified by this request when executed.

Returns:

The name of the bucket whose ACL will be modified by this request when executed.

getAcl

public AccessControlList getAcl()

Returns the custom ACL to be applied to the specified bucket when this request is executed. A request can use either a custom ACL or a canned ACL, but not both.

Returns:

The custom ACL to be applied to the specified bucket when this request is executed.

getCannedAcl

public CannedAccessControlList getCannedAcl()

Returns the canned ACL to be applied to the specified bucket when this request is executed. A request can use either a custom ACL or a canned ACL, but not both.

Returns:

The canned ACL to be applied to the specified bucket when this request is executed.

getExpectedBucketOwner

public String getExpectedBucketOwner()

Description copied from interface: ExpectedBucketOwnerRequest

Returns he account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

getExpectedBucketOwner in interface ExpectedBucketOwnerRequest

withExpectedBucketOwner

public SetBucketAclRequest withExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

withExpectedBucketOwner in interface ExpectedBucketOwnerRequest

setExpectedBucketOwner

public void setExpectedBucketOwner(String expectedBucketOwner)

Description copied from interface: ExpectedBucketOwnerRequest

Set the account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Specified by:

setExpectedBucketOwner in interface ExpectedBucketOwnerRequest