interface WebsiteConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.S3.Mixins.CfnBucketPropsMixin.WebsiteConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awss3/mixins#CfnBucketPropsMixin_WebsiteConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.s3.mixins.CfnBucketPropsMixin.WebsiteConfigurationProperty
Python	aws_cdk.mixins_preview.aws_s3.mixins.CfnBucketPropsMixin.WebsiteConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_s3 » mixins » CfnBucketPropsMixin » WebsiteConfigurationProperty

Specifies website configuration parameters for an Amazon S3 bucket.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as s3_mixins } from '@aws-cdk/mixins-preview/aws-s3';
const websiteConfigurationProperty: s3_mixins.CfnBucketPropsMixin.WebsiteConfigurationProperty = {
  errorDocument: 'errorDocument',
  indexDocument: 'indexDocument',
  redirectAllRequestsTo: {
    hostName: 'hostName',
    protocol: 'protocol',
  },
  routingRules: [{
    redirectRule: {
      hostName: 'hostName',
      httpRedirectCode: 'httpRedirectCode',
      protocol: 'protocol',
      replaceKeyPrefixWith: 'replaceKeyPrefixWith',
      replaceKeyWith: 'replaceKeyWith',
    },
    routingRuleCondition: {
      httpErrorCodeReturnedEquals: 'httpErrorCodeReturnedEquals',
      keyPrefixEquals: 'keyPrefixEquals',
    },
  }],
};

Properties

Name	Type	Description
errorDocument?	string	The name of the error document for the website.
indexDocument?	string	The name of the index document for the website.
redirectAllRequestsTo?	IResolvable | RedirectAllRequestsToProperty	The redirect behavior for every request to this bucket's website endpoint.
routingRules?	IResolvable | (IResolvable | RoutingRuleProperty)[]	Rules that define when a redirect is applied and the redirect behavior.

---

errorDocument?

Type: string (optional)

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

---

indexDocument?

Type: string (optional)

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

---

redirectAllRequestsTo?

Type: IResolvable | RedirectAllRequestsToProperty (optional)

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

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

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

---

routingRules?

Type: IResolvable | (IResolvable | RoutingRuleProperty)[] (optional)

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

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