import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * Provides details about AWS S3 (Simple Storage) buckets with optional filters. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.s3.getBuckets({}); * ``` * * ### Full Usage * * ```typescript * 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-", * }); * ``` */ export declare function getBuckets(args?: GetBucketsArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getBuckets. */ export interface GetBucketsArgs { /** * Limits the response to buckets that are located in the specified AWS Region. The AWS Region must be expressed according to the AWS Region code. */ bucketRegion?: string; /** * Maximum number of buckets returned. Unlike the AWS API parameter, this is a provider-level total cap. */ maxBuckets?: number; /** * Limits the response to bucket names that begin with the specified bucket name prefix. */ prefix?: string; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: string; } /** * A collection of values returned by getBuckets. */ export interface GetBucketsResult { /** * Bucket region. */ readonly bucketRegion?: string; /** * List of bucket objects: */ readonly buckets: outputs.s3.GetBucketsBucket[]; readonly maxBuckets?: number; readonly prefix?: string; readonly region: string; } /** * Provides details about AWS S3 (Simple Storage) buckets with optional filters. * * ## Example Usage * * ### Basic Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as aws from "@pulumi/aws"; * * const example = aws.s3.getBuckets({}); * ``` * * ### Full Usage * * ```typescript * 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-", * }); * ``` */ export declare function getBucketsOutput(args?: GetBucketsOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getBuckets. */ export interface GetBucketsOutputArgs { /** * Limits the response to buckets that are located in the specified AWS Region. The AWS Region must be expressed according to the AWS Region code. */ bucketRegion?: pulumi.Input; /** * Maximum number of buckets returned. Unlike the AWS API parameter, this is a provider-level total cap. */ maxBuckets?: pulumi.Input; /** * Limits the response to bucket names that begin with the specified bucket name prefix. */ prefix?: pulumi.Input; /** * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration. */ region?: pulumi.Input; } //# sourceMappingURL=getBuckets.d.ts.map