@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
155 lines • 6.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Authoritatively manages metadata common to all instances for a project in GCE. For more information see
* [the official documentation](https://cloud.google.com/compute/docs/storing-retrieving-metadata)
* and
* [API](https://cloud.google.com/compute/docs/reference/latest/projects/setCommonInstanceMetadata).
*
* > **Note:** This resource manages all project-level metadata including project-level ssh keys.
* Keys unset in config but set on the server will be removed. If you want to manage only single
* key/value pairs within the project metadata rather than the entire set, then use
* google_compute_project_metadata_item.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.ProjectMetadata("default", {metadata: {
* foo: "bar",
* fizz: "buzz",
* "13": "42",
* }});
* ```
*
* ### Adding An SSH Key
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* //A key set in project metadata is propagated to every instance in the project.
* //This resource configuration is prone to causing frequent diffs as Google adds SSH Keys when the SSH Button is pressed in the console.
* //It is better to use OS Login instead.
* const mySshKey = new gcp.compute.ProjectMetadata("my_ssh_key", {metadata: {
* "ssh-keys": ` dev:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT dev
* foo:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILg6UtHDNyMNAh0GjaytsJdrUxjtLy3APXqZfNZhvCeT bar
* `,
* }});
* ```
*
* ## Import
*
* Project metadata can be imported using the project ID:
*
* * `{{project_id}}`
*
* When using the `pulumi import` command, project metadata can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/projectMetadata:ProjectMetadata default {{project_id}}
* ```
*/
export declare class ProjectMetadata extends pulumi.CustomResource {
/**
* Get an existing ProjectMetadata 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?: ProjectMetadataState, opts?: pulumi.CustomResourceOptions): ProjectMetadata;
/**
* Returns true if the given object is an instance of ProjectMetadata. 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 ProjectMetadata;
/**
* 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>;
/**
* A series of key value pairs.
*
* - - -
*/
readonly metadata: pulumi.Output<{
[key: string]: 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 ProjectMetadata 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: ProjectMetadataArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectMetadata resources.
*/
export interface ProjectMetadataState {
/**
* 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>;
/**
* A series of key value pairs.
*
* - - -
*/
metadata?: pulumi.Input<{
[key: string]: 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 ProjectMetadata resource.
*/
export interface ProjectMetadataArgs {
/**
* 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>;
/**
* A series of key value pairs.
*
* - - -
*/
metadata: pulumi.Input<{
[key: string]: 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=projectMetadata.d.ts.map