com.amazonaws.services.s3.model

Class SetBucketWebsiteConfigurationRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.s3.model.SetBucketWebsiteConfigurationRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, ExpectedBucketOwnerRequest, Serializable, Cloneable

public class SetBucketWebsiteConfigurationRequest
extends AmazonWebServiceRequest
implements Serializable, ExpectedBucketOwnerRequest

Request object for the parameters to set 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:PutBucketWebsite permission. By default, only the bucket owner can configure the website attached to a bucket. However, bucket owners can allow other users to set the website configuration by writing a bucket policy granting them the S3:PutBucketWebsite permission.

See Also:

AmazonS3.setBucketWebsiteConfiguration(SetBucketWebsiteConfigurationRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetBucketWebsiteConfigurationRequest(String bucketName, BucketWebsiteConfiguration configuration) Creates a new request object, ready to be executed to set the specified bucket's website configuration.

Method Summary

Modifier and Type	Method and Description
String	getBucketName() Returns the name of the bucket whose website configuration is being set.
BucketWebsiteConfiguration	getConfiguration() Returns the website configuration to send as part of this request.
String	getExpectedBucketOwner() Returns he account id of the expected bucket owner.
void	setBucketName(String bucketName) Sets the name of the bucket whose website configuration is to be updated.
void	setConfiguration(BucketWebsiteConfiguration configuration) Sets the website configuration to send as part of this request.
void	setExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.
SetBucketWebsiteConfigurationRequest	withBucketName(String bucketName) Sets the name of the bucket whose website configuration is being set and returns this updated request object so that additional method calls can be chained together.
SetBucketWebsiteConfigurationRequest	withConfiguration(BucketWebsiteConfiguration configuration) Sets the website configuration to send as part of this request, and returns this updated request object so that additional method calls can be chained together.
SetBucketWebsiteConfigurationRequest	withExpectedBucketOwner(String expectedBucketOwner) Set the account id of the expected bucket owner.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, clone, 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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SetBucketWebsiteConfigurationRequest

public SetBucketWebsiteConfigurationRequest(String bucketName,
                                            BucketWebsiteConfiguration configuration)

Creates a new request object, ready to be executed to set the specified bucket's website configuration.

Parameters:

bucketName - The name of the bucket whose website configuration is being set.

configuration - The new configuration for the specified bucket.

Method Detail

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 SetBucketWebsiteConfigurationRequest 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

setBucketName

public void setBucketName(String bucketName)

Sets the name of the bucket whose website configuration is to be updated.

Parameters:

bucketName - The name of the bucket whose website configuration is being set.

getBucketName

public String getBucketName()

Returns the name of the bucket whose website configuration is being set.

Returns:

The name of the bucket whose website configuration is being set.

withBucketName

public SetBucketWebsiteConfigurationRequest withBucketName(String bucketName)

Sets the name of the bucket whose website configuration is being set 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 set.

Returns:

This updated request object so that additional method calls can be chained together.

setConfiguration

public void setConfiguration(BucketWebsiteConfiguration configuration)

Sets the website configuration to send as part of this request.

Parameters:

configuration - The new website configuration to set for the specified bucket.

getConfiguration

public BucketWebsiteConfiguration getConfiguration()

Returns the website configuration to send as part of this request.

Returns:

The new website configuration to set for the specified bucket.

withConfiguration

public SetBucketWebsiteConfigurationRequest withConfiguration(BucketWebsiteConfiguration configuration)

Sets the website configuration to send as part of this request, and returns this updated request object so that additional method calls can be chained together.

Parameters:

configuration - The new website configuration to set for the specified bucket.

Returns:

This updated request object so that additional method calls can be chained together.