getBucket function
Provides details about a specific S3 bucket.
This resource may prove useful when setting up a Route53 record, or an origin for a CloudFront Distribution.
Example Usage
Route53 Record
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const selected = aws.s3.getBucket({
bucket: "bucket.test.com",
});
const testZone = aws.route53.getZone({
name: "test.com.",
});
const example = new aws.route53.Record("example", {
aliases: [{
name: selected.then(selected => selected.websiteDomain),
zoneId: selected.then(selected => selected.hostedZoneId),
}],
zoneId: testZone.then(testZone => testZone.id),
name: "bucket",
type: aws.route53.RecordType.A,
});
import pulumi
import pulumi_aws as aws
selected = aws.s3.get_bucket(bucket="bucket.test.com")
test_zone = aws.route53.get_zone(name="test.com.")
example = aws.route53.Record("example",
aliases=[{
"name": selected.website_domain,
"zone_id": selected.hosted_zone_id,
}],
zone_id=test_zone.id,
name="bucket",
type=aws.route53.RecordType.A)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var selected = Aws.S3.GetBucket.Invoke(new()
{
Bucket = "bucket.test.com",
});
var testZone = Aws.Route53.GetZone.Invoke(new()
{
Name = "test.com.",
});
var example = new Aws.Route53.Record("example", new()
{
Aliases = new[]
{
new Aws.Route53.Inputs.RecordAliasArgs
{
Name = selected.Apply(getBucketResult => getBucketResult.WebsiteDomain),
ZoneId = selected.Apply(getBucketResult => getBucketResult.HostedZoneId),
},
},
ZoneId = testZone.Apply(getZoneResult => getZoneResult.Id),
Name = "bucket",
Type = Aws.Route53.RecordType.A,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"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 {
selected, err := s3.LookupBucket(ctx, &s3.LookupBucketArgs{
Bucket: "bucket.test.com",
}, nil)
if err != nil {
return err
}
testZone, err := route53.LookupZone(ctx, &route53.LookupZoneArgs{
Name: pulumi.StringRef("test.com."),
}, nil)
if err != nil {
return err
}
_, err = route53.NewRecord(ctx, "example", &route53.RecordArgs{
Aliases: route53.RecordAliasArray{
&route53.RecordAliasArgs{
Name: pulumi.String(selected.WebsiteDomain),
ZoneId: pulumi.String(selected.HostedZoneId),
},
},
ZoneId: pulumi.String(testZone.Id),
Name: pulumi.String("bucket"),
Type: pulumi.String(route53.RecordTypeA),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_s3_getbucket" "selected" {
bucket = "bucket.test.com"
}
data "aws_route53_getzone" "testZone" {
name = "test.com."
}
resource "aws_route53_record" "example" {
aliases {
name = data.aws_s3_getbucket.selected.website_domain
zone_id = data.aws_s3_getbucket.selected.hosted_zone_id
}
zone_id = data.aws_route53_getzone.testZone.id
name = "bucket"
type = "A"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.S3Functions;
import com.pulumi.aws.s3.inputs.GetBucketArgs;
import com.pulumi.aws.route53.Route53Functions;
import com.pulumi.aws.route53.inputs.GetZoneArgs;
import com.pulumi.aws.route53.Record;
import com.pulumi.aws.route53.RecordArgs;
import com.pulumi.aws.route53.inputs.RecordAliasArgs;
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) {
final var selected = S3Functions.getBucket(GetBucketArgs.builder()
.bucket("bucket.test.com")
.build());
final var testZone = Route53Functions.getZone(GetZoneArgs.builder()
.name("test.com.")
.build());
var example = new Record("example", RecordArgs.builder()
.aliases(RecordAliasArgs.builder()
.name(selected.websiteDomain())
.zoneId(selected.hostedZoneId())
.build())
.zoneId(testZone.id())
.name("bucket")
.type("A")
.build());
}
}
resources:
example:
type: aws:route53:Record
properties:
aliases:
- name: ${selected.websiteDomain}
zoneId: ${selected.hostedZoneId}
zoneId: ${testZone.id}
name: bucket
type: A
variables:
selected:
fn::invoke:
function: aws:s3:getBucket
arguments:
bucket: bucket.test.com
testZone:
fn::invoke:
function: aws:route53:getZone
arguments:
name: test.com.
CloudFront Origin
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const selected = aws.s3.getBucket({
bucket: "a-test-bucket",
});
const test = new aws.cloudfront.Distribution("test", {origins: [{
domainName: selected.then(selected => selected.bucketDomainName),
originId: "s3-selected-bucket",
}]});
import pulumi
import pulumi_aws as aws
selected = aws.s3.get_bucket(bucket="a-test-bucket")
test = aws.cloudfront.Distribution("test", origins=[{
"domain_name": selected.bucket_domain_name,
"origin_id": "s3-selected-bucket",
}])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var selected = Aws.S3.GetBucket.Invoke(new()
{
Bucket = "a-test-bucket",
});
var test = new Aws.CloudFront.Distribution("test", new()
{
Origins = new[]
{
new Aws.CloudFront.Inputs.DistributionOriginArgs
{
DomainName = selected.Apply(getBucketResult => getBucketResult.BucketDomainName),
OriginId = "s3-selected-bucket",
},
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/cloudfront"
"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 {
selected, err := s3.LookupBucket(ctx, &s3.LookupBucketArgs{
Bucket: "a-test-bucket",
}, nil)
if err != nil {
return err
}
_, err = cloudfront.NewDistribution(ctx, "test", &cloudfront.DistributionArgs{
Origins: cloudfront.DistributionOriginArray{
&cloudfront.DistributionOriginArgs{
DomainName: pulumi.String(selected.BucketDomainName),
OriginId: pulumi.String("s3-selected-bucket"),
},
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_s3_getbucket" "selected" {
bucket = "a-test-bucket"
}
resource "aws_cloudfront_distribution" "test" {
origins {
domain_name = data.aws_s3_getbucket.selected.bucket_domain_name
origin_id = "s3-selected-bucket"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.s3.S3Functions;
import com.pulumi.aws.s3.inputs.GetBucketArgs;
import com.pulumi.aws.cloudfront.Distribution;
import com.pulumi.aws.cloudfront.DistributionArgs;
import com.pulumi.aws.cloudfront.inputs.DistributionOriginArgs;
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) {
final var selected = S3Functions.getBucket(GetBucketArgs.builder()
.bucket("a-test-bucket")
.build());
var test = new Distribution("test", DistributionArgs.builder()
.origins(DistributionOriginArgs.builder()
.domainName(selected.bucketDomainName())
.originId("s3-selected-bucket")
.build())
.build());
}
}
resources:
test:
type: aws:cloudfront:Distribution
properties:
origins:
- domainName: ${selected.bucketDomainName}
originId: s3-selected-bucket
variables:
selected:
fn::invoke:
function: aws:s3:getBucket
arguments:
bucket: a-test-bucket
args Arguments passed to this invoke. Arguments for getBucket.
options Invoke options controlling this call.
Implementation
Future<GetBucketResult> getBucket(
GetBucketArgs args, {
pulumi.InvokeOptions? options,
}) async {
final deployment = pulumi.Deployment.instance;
final result = await deployment.invoke<Map<String, dynamic>>(
'aws:s3/getBucket:getBucket',
args.toMap(),
options: pulumi.toDeploymentInvokeOptions(options),
);
return GetBucketResult.fromMap(result);
}