getBuckets function

Future<GetBucketsResult> getBuckets(
  1. GetBucketsArgs args, {
  2. InvokeOptions? options,
})

Provides details about AWS S3 (Simple Storage) buckets with optional filters.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.s3.getBuckets({});
import pulumi
import pulumi_aws as aws

example = aws.s3.get_buckets()
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.S3.GetBuckets.Invoke();

});
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.GetBuckets(ctx, &s3.GetBucketsArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_s3_getbuckets" "example" {
}
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.GetBucketsArgs;
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 example = S3Functions.getBuckets(GetBucketsArgs.builder()
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:s3:getBuckets
      arguments: {}

Full Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.s3.getBuckets({
    bucketRegion: "us-west-2",
    maxBuckets: 3,
    prefix: "tf-",
});
import pulumi
import pulumi_aws as aws

example = aws.s3.get_buckets(bucket_region="us-west-2",
    max_buckets=3,
    prefix="tf-")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = Aws.S3.GetBuckets.Invoke(new()
    {
        BucketRegion = "us-west-2",
        MaxBuckets = 3,
        Prefix = "tf-",
    });

});
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.GetBuckets(ctx, &s3.GetBucketsArgs{
			BucketRegion: pulumi.StringRef("us-west-2"),
			MaxBuckets:   pulumi.IntRef(3),
			Prefix:       pulumi.StringRef("tf-"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

data "aws_s3_getbuckets" "example" {
  bucket_region = "us-west-2"
  max_buckets   = 3
  prefix        = "tf-"
}
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.GetBucketsArgs;
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 example = S3Functions.getBuckets(GetBucketsArgs.builder()
            .bucketRegion("us-west-2")
            .maxBuckets(3)
            .prefix("tf-")
            .build());

    }
}
variables:
  example:
    fn::invoke:
      function: aws:s3:getBuckets
      arguments:
        bucketRegion: us-west-2
        maxBuckets: 3
        prefix: tf-

args Arguments passed to this invoke. Arguments for getBuckets. options Invoke options controlling this call.

Implementation

Future<GetBucketsResult> getBuckets(
  GetBucketsArgs args, {
  pulumi.InvokeOptions? options,
}) async {
  final deployment = pulumi.Deployment.instance;
  final result = await deployment.invoke<Map<String, dynamic>>(
    'aws:s3/getBuckets:getBuckets',
    args.toMap(),
    options: pulumi.toDeploymentInvokeOptions(options),
  );
  return GetBucketsResult.fromMap(result);
}