Skip to content

Commit

Permalink
Finish updating get-started/aws to BucketV2 (#13321)
Browse files Browse the repository at this point in the history 
With BucketV2 instead of using the `website` argument the recommended setup is to use a side-by-side BucketWebsiteConfigurationV2 resource. The AWS getting started guide is updated to follow this recommendation.
  • Loading branch information
@t0yv0
t0yv0 authored Nov 12, 2024
1 parent 60c65a6 commit 93c7f7d
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 61 deletions.
106 changes: 57 additions & 49 deletions content/docs/iac/get-started/aws/deploy-changes.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,16 +124,17 @@ Now that `index.html` is in the bucket, update the program to turn the bucket in

## Update the program

Update the `Bucket` declaration to add a `website` property and make `index.html` the home page of the website:
Add a new `BucketWebsiteConfiguration` resource to make `index.html` the home page of the website:

{{< chooser language "javascript,typescript,python,go,csharp,java,yaml" / >}}

{{% choosable language "javascript,typescript" %}}

```typescript
const bucket = new aws.s3.Bucket("my-bucket", {
website: {
indexDocument: "index.html",
const website = new aws.s3.BucketWebsiteConfigurationV2("website", {
bucket: myBucket.id,
indexDocument: {
suffix: "index.html",
},
});
```
Expand All @@ -143,21 +144,22 @@ const bucket = new aws.s3.Bucket("my-bucket", {
{{% choosable language python %}}

```python
bucket = s3.Bucket("my-bucket",
website={
"index_document": "index.html",
},
)
website = aws.s3.BucketWebsiteConfigurationV2("website",
bucket=my_bucket.id,
index_document={
"suffix": "index.html",
})
```

{{% /choosable %}}

{{% choosable language go %}}

```go
bucket, err := s3.NewBucket(ctx, "my-bucket", &s3.BucketArgs{
Website: &s3.BucketWebsiteArgs{
IndexDocument: pulumi.String("index.html"),
website, err := s3.NewBucketWebsiteConfigurationV2(ctx, "website", &s3.BucketWebsiteConfigurationV2Args{
Bucket: myBucket.ID(),
IndexDocument: &s3.BucketWebsiteConfigurationV2IndexDocumentArgs{
Suffix: pulumi.String("index.html"),
},
})
if err != nil {
Expand All @@ -170,13 +172,12 @@ if err != nil {
{{% choosable language csharp %}}

```csharp
using Pulumi.Aws.S3.Inputs;

var bucket = new Bucket("my-bucket", new()
var website = new Aws.S3.BucketWebsiteConfigurationV2("website", new()
{
Website = new BucketWebsiteArgs
Bucket = myBucket.Id,
IndexDocument = new Aws.S3.Inputs.BucketWebsiteConfigurationV2IndexDocumentArgs
{
IndexDocument = "index.html",
Suffix = "index.html",
},
});
```
Expand All @@ -186,12 +187,14 @@ var bucket = new Bucket("my-bucket", new()
{{% choosable language java %}}

```java
import com.pulumi.aws.s3.BucketArgs;
import com.pulumi.aws.s3.inputs.BucketWebsiteArgs;

var bucket = new Bucket("my-bucket", BucketArgs.builder()
.website(BucketWebsiteArgs.builder()
.indexDocument("index.html")
import com.pulumi.aws.s3.BucketWebsiteConfigurationV2;
import com.pulumi.aws.s3.BucketWebsiteConfigurationV2Args;
import com.pulumi.aws.s3.inputs.BucketWebsiteConfigurationV2IndexDocumentArgs;

var website = new BucketWebsiteConfigurationV2("website", BucketWebsiteConafigurationV2Args.builder()
.bucket(myBucket.id())
.indexDocument(BucketWebsiteConfigurationV2IndexDocumentArgs.builder()
.suffix("index.html")
.build())
.build());
```
Expand All @@ -201,11 +204,12 @@ var bucket = new Bucket("my-bucket", BucketArgs.builder()
{{% choosable language yaml %}}

```yaml
my-bucket:
type: aws:s3:Bucket
website:
type: aws:s3:BucketWebsiteConfigurationV2
properties:
website:
indexDocument: index.html
bucket: ${my-bucket.id}
indexDocument:
suffix: index.html
```
{{% /choosable %}}
Expand Down Expand Up @@ -238,7 +242,7 @@ const bucketObject = new aws.s3.BucketObject("index.html", {
source: new pulumi.asset.FileAsset("./index.html"),
contentType: "text/html",
acl: "public-read",
}, { dependsOn: [publicAccessBlock,ownershipControls] });
}, { dependsOn: [publicAccessBlock,ownershipControls,website] });
```

{{% /choosable %}}
Expand All @@ -264,7 +268,7 @@ bucket_object = s3.BucketObject(
source=pulumi.FileAsset('index.html'),
content_type='text/html',
acl='public-read',
opts=pulumi.ResourceOptions(depends_on=[public_access_block, ownership_controls]),
opts=pulumi.ResourceOptions(depends_on=[public_access_block, ownership_controls, website]),
)
```

Expand Down Expand Up @@ -305,6 +309,7 @@ _, err = s3.NewBucketObject(ctx, "index.html", &s3.BucketObjectArgs{
}, pulumi.DependsOn([]pulumi.Resource{
publicAccessBlock,
ownershipControls,
website,
}))
if err != nil {
return err
Expand Down Expand Up @@ -343,6 +348,7 @@ var indexHtml = new BucketObject("index.html", new()
{
publicAccessBlock,
ownershipControls,
website,
},
});
```
Expand Down Expand Up @@ -380,7 +386,8 @@ var indexHtml = new BucketObject("index.html", BucketObjectArgs.builder()
.build(), CustomResourceOptions.builder()
.dependsOn(
publicAccessBlock,
ownershipControls)
ownershipControls,
website)
.build());
```

Expand Down Expand Up @@ -418,6 +425,7 @@ resources:
dependsOn:
- ${public-access-block}
- ${ownership-controls}
- ${website}
```

{{% /choosable %}}
Expand All @@ -429,31 +437,31 @@ Finally, at the end of the program, export the resulting bucket’s endpoint URL
{{% choosable language javascript %}}

```javascript
exports.bucketEndpoint = pulumi.interpolate`http://${bucket.websiteEndpoint}`;
exports.bucketEndpoint = pulumi.interpolate`http://${website.websiteEndpoint}`;
```

{{% /choosable %}}

{{% choosable language typescript %}}

```typescript
export const bucketEndpoint = pulumi.interpolate`http://${bucket.websiteEndpoint}`;
export const bucketEndpoint = pulumi.interpolate`http://${website.websiteEndpoint}`;
```

{{% /choosable %}}

{{% choosable language python %}}

```python
pulumi.export('bucket_endpoint', pulumi.Output.concat('http://', bucket.website_endpoint))
pulumi.export('bucket_endpoint', pulumi.Output.concat('http://', website.website_endpoint))
```

{{% /choosable %}}

{{% choosable language go %}}

```go
ctx.Export("bucketEndpoint", bucket.WebsiteEndpoint.ApplyT(func(websiteEndpoint string) (string, error) {
ctx.Export("bucketEndpoint", website.WebsiteEndpoint.ApplyT(func(websiteEndpoint string) (string, error) {
return fmt.Sprintf("http://%v", websiteEndpoint), nil
}).(pulumi.StringOutput))
```
Expand All @@ -466,7 +474,7 @@ ctx.Export("bucketEndpoint", bucket.WebsiteEndpoint.ApplyT(func(websiteEndpoint
return new Dictionary<string, object?>
{
// ...
["bucketEndpoint"] = bucket.WebsiteEndpoint.Apply(websiteEndpoint => $"http://{websiteEndpoint}"),
["bucketEndpoint"] = website.WebsiteEndpoint.Apply(websiteEndpoint => $"http://{websiteEndpoint}"),
};
```

Expand All @@ -476,7 +484,7 @@ return new Dictionary<string, object?>

```java
// ...
ctx.export("bucketEndpoint", bucket.websiteEndpoint().applyValue(websiteEndpoint -> String.format("http://%s", websiteEndpoint)));
ctx.export("bucketEndpoint", website.websiteEndpoint().applyValue(websiteEndpoint -> String.format("http://%s", websiteEndpoint)));
```

{{% /choosable %}}
Expand All @@ -486,7 +494,7 @@ ctx.export("bucketEndpoint", bucket.websiteEndpoint().applyValue(websiteEndpoint
```yaml
outputs:
# ...
bucketEndpoint: http://${my-bucket.websiteEndpoint}
bucketEndpoint: http://${website.websiteEndpoint}
```
{{% /choosable %}}
Expand All @@ -510,12 +518,12 @@ Again, you'll see a preview of the changes before they're deployed:
```
Previewing update (dev):
Type Name Plan Info
pulumi:pulumi:Stack quickstart-dev
~ ├─ aws:s3:Bucket my-bucket update [diff: +website]
+ ├─ aws:s3:BucketOwnershipControls ownership-controls create
+ ├─ aws:s3:BucketPublicAccessBlock public-access-block create
~ └─ aws:s3:BucketObject index.html update [diff: ~acl,contentType]
Type Name Plan Info
pulumi:pulumi:Stack quickstart-dev
+ ├─ aws:s3:BucketWebsiteConfigurationV2 website create
+ ├─ aws:s3:BucketOwnershipControls ownership-controls create
+ ├─ aws:s3:BucketPublicAccessBlock public-access-block create
~ └─ aws:s3:BucketObject index.html update [diff: ~acl,contentType]
Outputs:
+ bucketEndpoint: output<string>
Expand All @@ -537,12 +545,12 @@ Choose `yes` to perform the deployment:
Do you want to perform this update? yes
Updating (dev):
Type Name Status Info
pulumi:pulumi:Stack quickstart-dev
~ ├─ aws:s3:Bucket my-bucket updated (3s) [diff: +website]
+ ├─ aws:s3:BucketOwnershipControls ownership-controls created (0.84s)
+ ├─ aws:s3:BucketPublicAccessBlock public-access-block created (1s)
~ └─ aws:s3:BucketObject index.html updated (0.53s) [diff: ~acl,contentType]
Type Name Status Info
pulumi:pulumi:Stack. quickstart-dev
+ ├─ aws:s3:BucketWebsiteConfigurationV2 website created (0.51s)
+ ├─ aws:s3:BucketOwnershipControls. ownership-controls created (0.84s)
+ ├─ aws:s3:BucketPublicAccessBlock public-access-block created (1s)
~ └─ aws:s3:BucketObject index.html updated (0.53s) [diff: ~acl,contentType]
Outputs:
+ bucketEndpoint: "http://my-bucket-dfd6bd0.s3-website-us-east-1.amazonaws.com"
Expand Down
26 changes: 14 additions & 12 deletions content/docs/iac/get-started/aws/destroy-stack.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@ You'll be prompted to make sure you really want to delete these resources. This
```
Previewing destroy (dev):
Type Name Plan
- pulumi:pulumi:Stack quickstart-dev delete
- ├─ aws:s3:BucketObject index.html delete
- ├─ aws:s3:BucketOwnershipControls ownership-controls delete
- ├─ aws:s3:BucketPublicAccessBlock public-access-block delete
- └─ aws:s3:Bucket my-bucket delete
Type Name Status
- pulumi:pulumi:Stack quickstart-dev delete
- ├─ aws:s3:BucketObject index.html delete
- ├─ aws:s3:BucketOwnershipControls ownership-controls delete
- ├─ aws:s3:BucketPublicAccessBlock public-access-block delete
- ├─ aws:s3:BucketWebsiteConfigurationV2 website delete
- └─ aws:s3:BucketV2 my-bucket delete
Outputs:
- bucketEndpoint: "http://my-bucket-dfd6bd0.s3-website-us-east-1.amazonaws.com"
Expand All @@ -40,12 +41,13 @@ Resources:
Do you want to perform this destroy? yes
Destroying (dev):
Type Name Status
- pulumi:pulumi:Stack quickstart-dev deleted
- ├─ aws:s3:BucketObject index.html deleted (1s)
- ├─ aws:s3:BucketPublicAccessBlock public-access-block deleted (0.28s)
- ├─ aws:s3:BucketOwnershipControls ownership-controls deleted (0.47s)
- └─ aws:s3:Bucket my-bucket deleted (0.39s)
Type Name Status
- pulumi:pulumi:Stack quickstart-dev deleted (0.31s)
- ├─ aws:s3:BucketObject index.html deleted (1s)
- ├─ aws:s3:BucketPublicAccessBlock public-access-block deleted (0.67s)
- ├─ aws:s3:BucketWebsiteConfigurationV2 website deleted (0.88s)
- ├─ aws:s3:BucketOwnershipControls ownership-controls deleted (1s)
- └─ aws:s3:BucketV2 my-bucket deleted (0.58s)
Outputs:
- bucketEndpoint: "http://my-bucket-dfd6bd0.s3-website-us-east-1.amazonaws.com"
Expand Down

0 comments on commit 93c7f7d

Please sign in to comment.