Class SetBucketPolicyRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.s3.model.SetBucketPolicyRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class SetBucketPolicyRequest extends AmazonWebServiceRequest implements Serializable
Sets the policy associated with the specified bucket. Only the owner of the bucket can set a bucket policy. If a policy already exists for the specified bucket, the new policy replaces the existing policy.

Bucket policies provide access control management at the bucket level for both the bucket resource and contained object resources. Only one policy can be specified per-bucket.

See the Amazon S3 developer guide for more information on forming bucket polices.

See Also:
  • Constructor Details

    • SetBucketPolicyRequest

      public SetBucketPolicyRequest(String bucketName, String policyText)
      Creates a new request object, ready to be executed to set an Amazon S3 bucket's policy.
      Parameters:
      bucketName - The name of the Amazon S3 bucket whose policy is being set.
      policyText - The policy to apply to the specified bucket.
  • Method Details

    • getBucketName

      public String getBucketName()
      Returns the name of the Amazon S3 bucket whose policy is being set.
      Returns:
      The name of the Amazon S3 bucket whose policy is being set.
    • setBucketName

      public void setBucketName(String bucketName)
      Sets the name of the Amazon S3 bucket whose policy is being set.
      Parameters:
      bucketName - The name of the Amazon S3 bucket whose policy is being set.
    • withBucketName

      public SetBucketPolicyRequest withBucketName(String bucketName)
      Sets the name of the Amazon S3 bucket whose policy is being set, and returns the updated request object so that additional method calls can be chained together.
      Parameters:
      bucketName - The name of the Amazon S3 bucket whose policy is being set.
      Returns:
      The updated request object so that additional method calls can be chained together.
    • getPolicyText

      public String getPolicyText()
      Returns the policy to apply to the specified bucket.
      Returns:
      The policy to apply to the specified bucket.
    • setPolicyText

      public void setPolicyText(String policyText)
      Sets the policy to apply to the specified bucket.
      Parameters:
      policyText - The policy to apply to the specified bucket.
    • withPolicyText

      public SetBucketPolicyRequest withPolicyText(String policyText)
      Sets the policy to apply to the specified bucket, and returns the updated request object so that additional method calls can be chained together.
      Parameters:
      policyText - The policy to apply to the specified bucket.
      Returns:
      The updated request object, so that additional method calls can be chained together.