BucketWebsiteConfiguration class
Provides an S3 bucket website configuration resource. For more information, see Hosting Websites on S3.
> This resource cannot be used with S3 directory buckets.
Example Usage
With routingRule configured
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.BucketWebsiteConfiguration("example", {
indexDocument: {
suffix: "index.html",
},
errorDocument: {
key: "error.html",
},
routingRules: [{
condition: {
keyPrefixEquals: "docs/",
},
redirect: {
replaceKeyPrefixWith: "documents/",
},
}],
bucket: exampleAwsS3Bucket.id,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.BucketWebsiteConfiguration("example",
index_document={
"suffix": "index.html",
},
error_document={
"key": "error.html",
},
routing_rules=[{
"condition": {
"key_prefix_equals": "docs/",
},
"redirect": {
"replace_key_prefix_with": "documents/",
},
}],
bucket=example_aws_s3_bucket["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.BucketWebsiteConfiguration("example", new()
{
IndexDocument = new Aws.S3.Inputs.BucketWebsiteConfigurationIndexDocumentArgs
{
Suffix = "index.html",
},
ErrorDocument = new Aws.S3.Inputs.BucketWebsiteConfigurationErrorDocumentArgs
{
Key = "error.html",
},
RoutingRules = new[]
{
new Aws.S3.Inputs.BucketWebsiteConfigurationRoutingRuleArgs
{
Condition = new Aws.S3.Inputs.BucketWebsiteConfigurationRoutingRuleConditionArgs
{
KeyPrefixEquals = "docs/",
},
Redirect = new Aws.S3.Inputs.BucketWebsiteConfigurationRoutingRuleRedirectArgs
{
ReplaceKeyPrefixWith = "documents/",
},
},
},
Bucket = exampleAwsS3Bucket.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewBucketWebsiteConfiguration(ctx, "example", &s3.BucketWebsiteConfigurationArgs{
IndexDocument: &s3.BucketWebsiteConfigurationIndexDocumentArgs{
Suffix: pulumi.String("index.html"),
},
ErrorDocument: &s3.BucketWebsiteConfigurationErrorDocumentArgs{
Key: pulumi.String("error.html"),
},
RoutingRules: s3.BucketWebsiteConfigurationRoutingRuleArray{
&s3.BucketWebsiteConfigurationRoutingRuleArgs{
Condition: &s3.BucketWebsiteConfigurationRoutingRuleConditionArgs{
KeyPrefixEquals: pulumi.String("docs/"),
},
Redirect: &s3.BucketWebsiteConfigurationRoutingRuleRedirectArgs{
ReplaceKeyPrefixWith: pulumi.String("documents/"),
},
},
},
Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucketwebsiteconfiguration" "example" {
index_document = {
suffix = "index.html"
}
error_document = {
key = "error.html"
}
routing_rules {
condition = {
key_prefix_equals = "docs/"
}
redirect = {
replace_key_prefix_with = "documents/"
}
}
bucket = exampleAwsS3Bucket.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketWebsiteConfiguration;
import com.pulumi.aws.s3.BucketWebsiteConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationIndexDocumentArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationErrorDocumentArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationRoutingRuleArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationRoutingRuleConditionArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationRoutingRuleRedirectArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new BucketWebsiteConfiguration("example", BucketWebsiteConfigurationArgs.builder()
.indexDocument(BucketWebsiteConfigurationIndexDocumentArgs.builder()
.suffix("index.html")
.build())
.errorDocument(BucketWebsiteConfigurationErrorDocumentArgs.builder()
.key("error.html")
.build())
.routingRules(BucketWebsiteConfigurationRoutingRuleArgs.builder()
.condition(BucketWebsiteConfigurationRoutingRuleConditionArgs.builder()
.keyPrefixEquals("docs/")
.build())
.redirect(BucketWebsiteConfigurationRoutingRuleRedirectArgs.builder()
.replaceKeyPrefixWith("documents/")
.build())
.build())
.bucket(exampleAwsS3Bucket.id())
.build());
}
}
resources:
example:
type: aws:s3:BucketWebsiteConfiguration
properties:
indexDocument:
suffix: index.html
errorDocument:
key: error.html
routingRules:
- condition:
keyPrefixEquals: docs/
redirect:
replaceKeyPrefixWith: documents/
bucket: ${exampleAwsS3Bucket.id}
With routingRules configured
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.s3.BucketWebsiteConfiguration("example", {
indexDocument: {
suffix: "index.html",
},
errorDocument: {
key: "error.html",
},
bucket: exampleAwsS3Bucket.id,
routingRuleDetails: `[{
\\"Condition\\": {
\\"KeyPrefixEquals\\": \\"docs/\\"
},
\\"Redirect\\": {
\\"ReplaceKeyPrefixWith\\": \\"\\"
}
}]
`,
});
import pulumi
import pulumi_aws as aws
example = aws.s3.BucketWebsiteConfiguration("example",
index_document={
"suffix": "index.html",
},
error_document={
"key": "error.html",
},
bucket=example_aws_s3_bucket["id"],
routing_rule_details="""[{
\"Condition\": {
\"KeyPrefixEquals\": \"docs/\"
},
\"Redirect\": {
\"ReplaceKeyPrefixWith\": \"\"
}
}]
""")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.S3.BucketWebsiteConfiguration("example", new()
{
IndexDocument = new Aws.S3.Inputs.BucketWebsiteConfigurationIndexDocumentArgs
{
Suffix = "index.html",
},
ErrorDocument = new Aws.S3.Inputs.BucketWebsiteConfigurationErrorDocumentArgs
{
Key = "error.html",
},
Bucket = exampleAwsS3Bucket.Id,
RoutingRuleDetails = @"[{
\""Condition\"": {
\""KeyPrefixEquals\"": \""docs/\""
},
\""Redirect\"": {
\""ReplaceKeyPrefixWith\"": \""\""
}
}]
",
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/s3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := s3.NewBucketWebsiteConfiguration(ctx, "example", &s3.BucketWebsiteConfigurationArgs{
IndexDocument: &s3.BucketWebsiteConfigurationIndexDocumentArgs{
Suffix: pulumi.String("index.html"),
},
ErrorDocument: &s3.BucketWebsiteConfigurationErrorDocumentArgs{
Key: pulumi.String("error.html"),
},
Bucket: pulumi.Any(exampleAwsS3Bucket.Id),
RoutingRuleDetails: pulumi.String(`[{
\"Condition\": {
\"KeyPrefixEquals\": \"docs/\"
},
\"Redirect\": {
\"ReplaceKeyPrefixWith\": \"\"
}
}]
`),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_s3_bucketwebsiteconfiguration" "example" {
index_document = {
suffix = "index.html"
}
error_document = {
key = "error.html"
}
bucket = exampleAwsS3Bucket.id
routing_rule_details = "[{\n \\\"Condition\\\": {\n \\\"KeyPrefixEquals\\\": \\\"docs/\\\"\n },\n \\\"Redirect\\\": {\n \\\"ReplaceKeyPrefixWith\\\": \\\"\\\"\n }\n}]\n"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.BucketWebsiteConfiguration;
import com.pulumi.aws.s3.BucketWebsiteConfigurationArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationIndexDocumentArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationErrorDocumentArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new BucketWebsiteConfiguration("example", BucketWebsiteConfigurationArgs.builder()
.indexDocument(BucketWebsiteConfigurationIndexDocumentArgs.builder()
.suffix("index.html")
.build())
.errorDocument(BucketWebsiteConfigurationErrorDocumentArgs.builder()
.key("error.html")
.build())
.bucket(exampleAwsS3Bucket.id())
.routingRuleDetails("""
[{
\"Condition\": {
\"KeyPrefixEquals\": \"docs/\"
},
\"Redirect\": {
\"ReplaceKeyPrefixWith\": \"\"
}
}]
""")
.build());
}
}
resources:
example:
type: aws:s3:BucketWebsiteConfiguration
properties:
indexDocument:
suffix: index.html
errorDocument:
key: error.html
bucket: ${exampleAwsS3Bucket.id}
routingRuleDetails: |
[{
\"Condition\": {
\"KeyPrefixEquals\": \"docs/\"
},
\"Redirect\": {
\"ReplaceKeyPrefixWith\": \"\"
}
}]
Import
Identity Schema
Required
bucket(String) S3 bucket name.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expectedBucketOwner separated by a comma (,):
Using pulumi import to import S3 bucket website configuration using the bucket or using the bucket and expectedBucketOwner separated by a comma (,). For example:
If the owner (account ID) of the source bucket is the same account used to configure the AWS Provider, import using the bucket:
$ pulumi import aws:s3/bucketWebsiteConfiguration:BucketWebsiteConfiguration example bucket-name
If the owner (account ID) of the source bucket differs from the account used to configure the AWS Provider, import using the bucket and expectedBucketOwner separated by a comma (,):
$ pulumi import aws:s3/bucketWebsiteConfiguration:BucketWebsiteConfiguration example bucket-name,123456789012
Constructors
- BucketWebsiteConfiguration(String name, {BucketWebsiteConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new BucketWebsiteConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this BucketWebsiteConfiguration. The set of arguments for BucketWebsiteConfiguration.optionsResource options controlling this resource's behavior. - BucketWebsiteConfiguration.reference(String urn)
- Creates a typed reference to an existing BucketWebsiteConfiguration resource.
Properties
-
bucket
↔ Output<
String> -
Name of the bucket.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
errorDocument
↔ Output<
BucketWebsiteConfigurationErrorDocument?> -
Name of the error document for the website. See below.
latefinal
-
expectedBucketOwner
↔ Output<
String?> -
Account ID of the expected bucket owner.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
-
indexDocument
↔ Output<
BucketWebsiteConfigurationIndexDocument?> -
Name of the index document for the website. See below.
latefinal
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
redirectAllRequestsTo
↔ Output<
BucketWebsiteConfigurationRedirectAllRequestsTo?> -
Redirect behavior for every request to this bucket's website endpoint. See below. Conflicts with
errorDocument,indexDocument, androutingRule.latefinal -
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
-
routingRuleDetails
↔ Output<
String> -
JSON array containing routing rules describing redirect behavior and when redirects are applied. Use this parameter when your routing rules contain empty String values (
"") as seen in the example above.latefinal -
routingRules
↔ Output<
List< BucketWebsiteConfigurationRoutingRule> > -
List of rules that define when a redirect is applied and the redirect behavior. See below.
latefinal
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
websiteDomain
↔ Output<
String> -
Domain of the website endpoint. This is used to create Route 53 alias records.
latefinal
-
websiteEndpoint
↔ Output<
String> -
Website endpoint.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {BucketWebsiteConfigurationState? state, CustomResourceOptions? options}) → BucketWebsiteConfiguration -
Gets an existing BucketWebsiteConfiguration resource's state with the given
nameandid.