com.amazonaws.services.s3.model.GetBucketWebsiteConfigurationRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-s3 Show documentation
/*
* Copyright 2011-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.s3.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.services.s3.AmazonS3;
/**
* Request object for the parameters to retrieve a bucket's website
* configuration.
*
* Bucket website configuration allows you to host your static websites entirely
* out of Amazon S3. To host your website in Amazon S3, create a bucket, upload
* your files, and configure it as a website. Once your bucket has been
* configured as a website, you can access all your content via the Amazon S3
* website endpoint. To ensure that the existing Amazon S3 REST API will
* continue to behave the same, regardless of whether or not your bucket has
* been configured to host a website, a new HTTP endpoint has been introduced
* where you can access your content. The bucket content you want to make
* available via the website must be publicly readable.
*
* For more information on how to host a website on Amazon S3, see: http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.
* html.
*
* This operation requires the S3:GetBucketWebsite permission. By
* default, only the bucket owner can read the bucket website configuration.
* However, bucket owners can allow other users to read the website
* configuration by writing a bucket policy granting them the
* S3:GetBucketWebsite permission.
*
* @see AmazonS3#getBucketWebsiteConfiguration(GetBucketWebsiteConfigurationRequest)
*/
public class GetBucketWebsiteConfigurationRequest extends AmazonWebServiceRequest implements Serializable, ExpectedBucketOwnerRequest {
/** The name of the bucket whose website configuration is being retrieved. */
private String bucketName;
private String expectedBucketOwner;
/**
* Creates a new request object, ready to be executed to retrieve the bucket
* website configuration for the specified bucket.
*
* @param bucketName
* The name of the bucket whose website configuration is being
* retrieved.
*/
public GetBucketWebsiteConfigurationRequest(String bucketName) {
this.bucketName = bucketName;
}
public String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public GetBucketWebsiteConfigurationRequest withExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public void setExpectedBucketOwner(String expectedBucketOwner) {
withExpectedBucketOwner(expectedBucketOwner);
}
/**
* Sets the name of the bucket whose website configuration is being
* retrieved.
*
* @param bucketName
* The name of the bucket whose website configuration is being
* retrieved.
*/
public void setBucketName(String bucketName) {
this.bucketName = bucketName;
}
/**
* Returns the name of the bucket whose website configuration is being
* retrieved.
*
* @return The name of the bucket whose website configuration is being
* retrieved.
*/
public String getBucketName() {
return bucketName;
}
/**
* Sets the name of the bucket whose website configuration is being
* retrieved, and returns this updated request object so that additional
* method calls can be chained together.
*
* @param bucketName
* The name of the bucket whose website configuration is being
* retrieved.
*
* @return This updated request object, so that additional method calls can
* be chained together.
*/
public GetBucketWebsiteConfigurationRequest withBucketName(String bucketName) {
setBucketName(bucketName);
return this;
}
}