@pulumi/gcp/firebase/storageBucket.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * An association between a Firebase project and a Google Cloud Storage bucket.
 * This association enables integration of Cloud Storage buckets with Firebase such as Firebase SDKS, Authentication, and Security Rules.
 *
 * To get more information about Bucket, see:
 *
 * * [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets)
 * * How-to Guides
 *     * [Official Documentation](https://firebase.google.com/docs/storage/)
 *
 * ## Example Usage
 *
 * ### Firebasestorage Bucket Basic
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = new gcp.storage.Bucket("default", {
 *     name: "test_bucket",
 *     location: "US",
 *     uniformBucketLevelAccess: true,
 * });
 * const defaultStorageBucket = new gcp.firebase.StorageBucket("default", {
 *     project: "my-project-name",
 *     bucketId: _default.id,
 * });
 * ```
 *
 * ## Import
 *
 * Bucket can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/buckets/{{bucket_id}}`
 *
 * * `{{project}}/{{bucket_id}}`
 *
 * * `{{bucket_id}}`
 *
 * When using the `pulumi import` command, Bucket can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:firebase/storageBucket:StorageBucket default projects/{{project}}/buckets/{{bucket_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:firebase/storageBucket:StorageBucket default {{project}}/{{bucket_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:firebase/storageBucket:StorageBucket default {{bucket_id}}
 * ```
 */
export declare class StorageBucket extends pulumi.CustomResource {
    /**
     * Get an existing StorageBucket resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: StorageBucketState, opts?: pulumi.CustomResourceOptions): StorageBucket;
    /**
     * Returns true if the given object is an instance of StorageBucket.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is StorageBucket;
    /**
     * Required. Immutable. The ID of the underlying Google Cloud Storage bucket
     */
    readonly bucketId: pulumi.Output<string | undefined>;
    /**
     * Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID
     */
    readonly name: pulumi.Output<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    readonly project: pulumi.Output<string>;
    /**
     * Create a StorageBucket resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args?: StorageBucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering StorageBucket resources.
 */
export interface StorageBucketState {
    /**
     * Required. Immutable. The ID of the underlying Google Cloud Storage bucket
     */
    bucketId?: pulumi.Input<string>;
    /**
     * Resource name of the bucket in the format projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID
     */
    name?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a StorageBucket resource.
 */
export interface StorageBucketArgs {
    /**
     * Required. Immutable. The ID of the underlying Google Cloud Storage bucket
     */
    bucketId?: pulumi.Input<string>;
    /**
     * The ID of the project in which the resource belongs.
     * If it is not provided, the provider project is used.
     */
    project?: pulumi.Input<string>;
}