Package software.amazon.awscdk.services.s3

Interface CfnBucket.WebsiteConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnBucket.WebsiteConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnBucket

@Stability(Stable)
public static interface CfnBucket.WebsiteConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Specifies website configuration parameters for an Amazon S3 bucket.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.s3.*;
 WebsiteConfigurationProperty websiteConfigurationProperty = WebsiteConfigurationProperty.builder()
         .errorDocument("errorDocument")
         .indexDocument("indexDocument")
         .redirectAllRequestsTo(RedirectAllRequestsToProperty.builder()
                 .hostName("hostName")
                 // the properties below are optional
                 .protocol("protocol")
                 .build())
         .routingRules(List.of(RoutingRuleProperty.builder()
                 .redirectRule(RedirectRuleProperty.builder()
                         .hostName("hostName")
                         .httpRedirectCode("httpRedirectCode")
                         .protocol("protocol")
                         .replaceKeyPrefixWith("replaceKeyPrefixWith")
                         .replaceKeyWith("replaceKeyWith")
                         .build())
                 // the properties below are optional
                 .routingRuleCondition(RoutingRuleConditionProperty.builder()
                         .httpErrorCodeReturnedEquals("httpErrorCodeReturnedEquals")
                         .keyPrefixEquals("keyPrefixEquals")
                         .build())
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnBucket.WebsiteConfigurationProperty.Builder	A builder for CfnBucket.WebsiteConfigurationProperty
static final class	CfnBucket.WebsiteConfigurationProperty.Jsii$Proxy	An implementation for CfnBucket.WebsiteConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnBucket.WebsiteConfigurationProperty.Builder	builder()
default String	getErrorDocument()	The name of the error document for the website.
default String	getIndexDocument()	The name of the index document for the website.
default Object	getRedirectAllRequestsTo()	The redirect behavior for every request to this bucket's website endpoint.
default Object	getRoutingRules()	Rules that define when a redirect is applied and the redirect behavior.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getErrorDocument

@Stability(Stable)
@Nullable
default String getErrorDocument()

The name of the error document for the website.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-errordocument

getIndexDocument

@Stability(Stable)
@Nullable
default String getIndexDocument()

The name of the index document for the website.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-indexdocument

getRedirectAllRequestsTo

@Stability(Stable)
@Nullable
default Object getRedirectAllRequestsTo()

The redirect behavior for every request to this bucket's website endpoint.

If you specify this property, you can't specify any other property.

Returns union: either IResolvable or CfnBucket.RedirectAllRequestsToProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-redirectallrequeststo

getRoutingRules

@Stability(Stable)
@Nullable
default Object getRoutingRules()

Rules that define when a redirect is applied and the redirect behavior.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnBucket.RoutingRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-s3-bucket-websiteconfiguration.html#cfn-s3-bucket-websiteconfiguration-routingrules

builder

@Stability(Stable)
static CfnBucket.WebsiteConfigurationProperty.Builder builder()

Returns:

a CfnBucket.WebsiteConfigurationProperty.Builder of CfnBucket.WebsiteConfigurationProperty