public class BucketWebsiteConfiguration extends Object implements Serializable
To host a static website in Amazon S3, create a bucket, upload your files, and set the bucket website configuration. 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 website content. The bucket content you want to make available via the website must be publicly readable.
To enable hosting websites, Amazon S3 introduces the following concepts/features:
For more information on how to host a website on Amazon S3, see: http://docs.amazonwebservices.com/AmazonS3/latest/dev/WebsiteHosting.html.
Constructor and Description |
---|
BucketWebsiteConfiguration()
Creates a new BucketWebsiteConfiguration.
|
BucketWebsiteConfiguration(String indexDocumentSuffix)
Creates a new BucketWebsiteConfiguration with the specified index
document suffix.
|
BucketWebsiteConfiguration(String indexDocumentSuffix,
String errorDocument)
Creates a new BucketWebsiteConfiguration with the specified index
document suffix and error document.
|
Modifier and Type | Method and Description |
---|---|
String |
getErrorDocument()
Returns the complete path to the document to serve for 4xx errors, or
null if no error document has been configured.
|
String |
getIndexDocumentSuffix()
Returns the document to serve when a directory is specified (ex:
index.html).
|
RedirectRule |
getRedirectAllRequestsTo()
Return the redirect information where all requests will be redirect to.
|
List<RoutingRule> |
getRoutingRules()
Return the list of routing rules that can be used for configuring
redirects if certain conditions are meet.
|
void |
setErrorDocument(String errorDocument)
Sets the complete path to the document to serve for 4xx errors.
|
void |
setIndexDocumentSuffix(String indexDocumentSuffix)
Sets the document to serve when a directory is specified (ex:
index.html).
|
void |
setRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
Sets the redirect information where all requests will be redirect to.
|
void |
setRoutingRules(List<RoutingRule> routingRules)
Set the list of routing rules that can be used for configuring redirects
if certain conditions are meet.
|
BucketWebsiteConfiguration |
withIndexDocumentSuffix(String indexDocumentSuffix)
Sets the document to serve when a directory is specified (ex:
index.html).
|
BucketWebsiteConfiguration |
withRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
Sets the redirect information where all requests will be redirect to and
returns a reference to this object(BucketWebsiteConfiguration) for method
chaining.
|
BucketWebsiteConfiguration |
withRoutingRules(List<RoutingRule> routingRules)
Set the list of routing rules that can be used for configuring redirects
if certain conditions are meet and returns a reference to this
object(BucketWebsiteConfiguration) for method chaining.
|
public BucketWebsiteConfiguration()
public BucketWebsiteConfiguration(String indexDocumentSuffix)
indexDocumentSuffix
- The document to serve when a directory is specified (ex:
index.html). This path is relative to the requested resource.public BucketWebsiteConfiguration(String indexDocumentSuffix, String errorDocument)
indexDocumentSuffix
- The document to serve when a directory is specified (ex:
index.html). This path is relative to the requested resource.errorDocument
- The complete path to the document to serve for 4xx errors.public String getIndexDocumentSuffix()
public BucketWebsiteConfiguration withIndexDocumentSuffix(String indexDocumentSuffix)
indexDocumentSuffix
- The document to serve when a directory is specified (ex:
index.html). This path is relative to the requested resource.public void setIndexDocumentSuffix(String indexDocumentSuffix)
indexDocumentSuffix
- The document to serve when a directory is specified (ex:
index.html). This path is relative to the requested resource.public String getErrorDocument()
public void setErrorDocument(String errorDocument)
errorDocument
- The complete path to the document to serve for 4xx errors.public void setRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
redirectAllRequestsTo
- The Redirect information where all requests will be redirect
to.public RedirectRule getRedirectAllRequestsTo()
public BucketWebsiteConfiguration withRedirectAllRequestsTo(RedirectRule redirectAllRequestsTo)
redirectAllRequestsTo
- The Redirect information where all requests will be redirect
to.public void setRoutingRules(List<RoutingRule> routingRules)
routingRules
- The list of routing rules that can be used for configuring
redirects.public List<RoutingRule> getRoutingRules()
public BucketWebsiteConfiguration withRoutingRules(List<RoutingRule> routingRules)
routingRules
- The list of routing rules that can be used for configuring
redirects.Copyright © 2022. All rights reserved.