@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
156 lines • 6.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A resource that manages the creation of the default Google Cloud Storage bucket
* for a Firebase project.
*
* > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider.
* See Provider Versions for more details on beta resources.
*
* To get more information about DefaultBucket, see:
*
* * [API documentation](https://firebase.google.com/docs/reference/rest/storage/rest/v1alpha/projects.defaultBucket)
* * How-to Guides
* * [Official Documentation](https://firebase.google.com/docs/storage/)
*
* ## Example Usage
*
* ### Firebasestorage Default Bucket Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.firebase.StorageDefaultBucket("default", {
* project: "my-project-name",
* location: "us-central1",
* });
* ```
*
* ## Import
*
* DefaultBucket can be imported using any of these accepted formats:
*
* * `projects/{{project}}/defaultBucket`
* * `{{project}}`
*
* When using the `pulumi import` command, DefaultBucket can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:firebase/storageDefaultBucket:StorageDefaultBucket default projects/{{project}}/defaultBucket
* $ pulumi import gcp:firebase/storageDefaultBucket:StorageDefaultBucket default {{project}}
* ```
*/
export declare class StorageDefaultBucket extends pulumi.CustomResource {
/**
* Get an existing StorageDefaultBucket 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?: StorageDefaultBucketState, opts?: pulumi.CustomResourceOptions): StorageDefaultBucket;
/**
* Returns true if the given object is an instance of StorageDefaultBucket. 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 StorageDefaultBucket;
/**
* The resource name of the underlying Google Cloud Storage bucket.
* Structure is documented below.
*/
readonly buckets: pulumi.Output<outputs.firebase.StorageDefaultBucketBucket[]>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* The ID of the location where the default Google Cloud Storage bucket will be created.
*/
readonly location: pulumi.Output<string>;
/**
* (Output)
* The 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 StorageDefaultBucket 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: StorageDefaultBucketArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering StorageDefaultBucket resources.
*/
export interface StorageDefaultBucketState {
/**
* The resource name of the underlying Google Cloud Storage bucket.
* Structure is documented below.
*/
buckets?: pulumi.Input<pulumi.Input<inputs.firebase.StorageDefaultBucketBucket>[] | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The ID of the location where the default Google Cloud Storage bucket will be created.
*/
location?: pulumi.Input<string | undefined>;
/**
* (Output)
* The resource name of the bucket in the format
* projects/PROJECT_IDENTIFIER/buckets/BUCKET_ID
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a StorageDefaultBucket resource.
*/
export interface StorageDefaultBucketArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* The ID of the location where the default Google Cloud Storage bucket will be created.
*/
location: 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 | undefined>;
}
//# sourceMappingURL=storageDefaultBucket.d.ts.map