@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
167 lines • 6.54 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* IcebergNamespaces are containers for Apache Iceberg Tables within an IcebergCatalog.
*
* ## Example Usage
*
* ### Biglake Iceberg Namespace
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const bucket = new gcp.storage.Bucket("bucket", {
* name: "example-bucket",
* location: "us-central1",
* forceDestroy: true,
* uniformBucketLevelAccess: true,
* });
* const catalog = new gcp.biglake.IcebergCatalog("catalog", {
* name: bucket.name,
* catalogType: "CATALOG_TYPE_GCS_BUCKET",
* });
* const myIcebergNamespace = new gcp.biglake.IcebergNamespace("my_iceberg_namespace", {
* catalog: catalog.name,
* namespaceId: "my_iceberg_namespace",
* properties: {
* key: "value",
* },
* });
* ```
*
* ## Import
*
* IcebergNamespace can be imported using any of these accepted formats:
*
* * `projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace_id}}`
* * `{{project}}/{{catalog}}/{{namespace_id}}`
* * `{{catalog}}/{{namespace_id}}`
*
* When using the `pulumi import` command, IcebergNamespace can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default projects/{{project}}/catalogs/{{catalog}}/namespaces/{{namespace_id}}
* $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default {{project}}/{{catalog}}/{{namespace_id}}
* $ pulumi import gcp:biglake/icebergNamespace:IcebergNamespace default {{catalog}}/{{namespace_id}}
* ```
*/
export declare class IcebergNamespace extends pulumi.CustomResource {
/**
* Get an existing IcebergNamespace 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?: IcebergNamespaceState, opts?: pulumi.CustomResourceOptions): IcebergNamespace;
/**
* Returns true if the given object is an instance of IcebergNamespace. 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 IcebergNamespace;
/**
* The name of the IcebergCatalog.
*/
readonly catalog: pulumi.Output<string>;
/**
* 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 unique identifier of the namespace.
*/
readonly namespaceId: 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>;
/**
* User-defined properties for the namespace.
*/
readonly properties: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a IcebergNamespace 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: IcebergNamespaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering IcebergNamespace resources.
*/
export interface IcebergNamespaceState {
/**
* The name of the IcebergCatalog.
*/
catalog?: pulumi.Input<string | 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 unique identifier of the namespace.
*/
namespaceId?: 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>;
/**
* User-defined properties for the namespace.
*/
properties?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a IcebergNamespace resource.
*/
export interface IcebergNamespaceArgs {
/**
* The name of the IcebergCatalog.
*/
catalog: pulumi.Input<string>;
/**
* 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 unique identifier of the namespace.
*/
namespaceId: 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>;
/**
* User-defined properties for the namespace.
*/
properties?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
//# sourceMappingURL=icebergNamespace.d.ts.map