Class GetBucketWebsiteConfigurationRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.s3.model.GetBucketWebsiteConfigurationRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class GetBucketWebsiteConfigurationRequest extends AmazonWebServiceRequest implements Serializable
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 theS3:GetBucketWebsite
permission.
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description GetBucketWebsiteConfigurationRequest(String bucketName)
Creates a new request object, ready to be executed to retrieve the bucket website configuration for the specified bucket.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getBucketName()
Returns the name of the bucket whose website configuration is being retrieved.void
setBucketName(String bucketName)
Sets the name of the bucket whose website configuration is being retrieved.GetBucketWebsiteConfigurationRequest
withBucketName(String 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.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Constructor Detail
-
GetBucketWebsiteConfigurationRequest
public GetBucketWebsiteConfigurationRequest(String bucketName)
Creates a new request object, ready to be executed to retrieve the bucket website configuration for the specified bucket.- Parameters:
bucketName
- The name of the bucket whose website configuration is being retrieved.
-
-
Method Detail
-
setBucketName
public void setBucketName(String bucketName)
Sets the name of the bucket whose website configuration is being retrieved.- Parameters:
bucketName
- The name of the bucket whose website configuration is being retrieved.
-
getBucketName
public String getBucketName()
Returns the name of the bucket whose website configuration is being retrieved.- Returns:
- The name of the bucket whose website configuration is being retrieved.
-
withBucketName
public GetBucketWebsiteConfigurationRequest withBucketName(String 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.- Parameters:
bucketName
- The name of the bucket whose website configuration is being retrieved.- Returns:
- This updated request object, so that additional method calls can be chained together.
-
-