@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
198 lines • 8.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Allows management of a single API service for a Google Cloud project.
*
* For a list of services available, visit the [API library page](https://console.cloud.google.com/apis/library)
* or run `gcloud services list --available`.
*
* This resource requires the [Service Usage API](https://console.cloud.google.com/apis/library/serviceusage.googleapis.com)
* to use.
*
* To get more information about `gcp.projects.Service`, see:
*
* * [API documentation](https://cloud.google.com/service-usage/docs/reference/rest/v1/services)
* * How-to Guides
* * [Enabling and Disabling Services](https://cloud.google.com/service-usage/docs/enable-disable)
* * Terraform guidance
* * [User Guide - gcp.projects.Service](https://www.terraform.io/docs/providers/google/guides/google_project_service.html)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = new gcp.projects.Service("project", {
* project: "your-project-id",
* service: "iam.googleapis.com",
* });
* ```
*
* ## Import
*
* Project services can be imported using the `projectId` and `service`, e.g.
*
* * `{{project_id}}/{{service}}`
*
* When using the `pulumi import` command, project services can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:projects/service:Service default {{project_id}}/{{service}}
* ```
*
* Note that unlike other resources that fail if they already exist,
* `pulumi up` can be successfully used to verify already enabled services.
* This means that when importing existing resources into Terraform, you can either
* import the `gcp.projects.Service` resources or treat them as new
* infrastructure and run `pulumi up` to add them to state.
*/
export declare class Service extends pulumi.CustomResource {
/**
* Get an existing Service 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?: ServiceState, opts?: pulumi.CustomResourceOptions): Service;
/**
* Returns true if the given object is an instance of Service. 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 Service;
/**
* Beta
* If `true`, the usage of the service to be disabled will be checked and an error
* will be returned if the service to be disabled has usage in last 30 days.
*/
readonly checkIfServiceHasUsageOnDestroy: pulumi.Output<boolean | 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.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* If `true`, services that are enabled
* and which depend on this service should also be disabled when this service is
* destroyed. If `false` or unset, an error will be generated if any enabled
* services depend on this service when destroying it.
*/
readonly disableDependentServices: pulumi.Output<boolean | undefined>;
/**
* If `true`, disable the service when the
* Terraform resource is destroyed. If `false` or unset, the service will be left enabled when
* the Terraform resource is destroyed. It should generally only
* be `true` in configurations that manage the `gcp.organizations.Project` resource itself.
*/
readonly disableOnDestroy: pulumi.Output<boolean | undefined>;
/**
* The project ID. If not provided, the provider project
* is used.
*/
readonly project: pulumi.Output<string>;
/**
* The service to enable.
*/
readonly service: pulumi.Output<string>;
/**
* Create a Service 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: ServiceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Service resources.
*/
export interface ServiceState {
/**
* Beta
* If `true`, the usage of the service to be disabled will be checked and an error
* will be returned if the service to be disabled has usage in last 30 days.
*/
checkIfServiceHasUsageOnDestroy?: pulumi.Input<boolean | 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>;
/**
* If `true`, services that are enabled
* and which depend on this service should also be disabled when this service is
* destroyed. If `false` or unset, an error will be generated if any enabled
* services depend on this service when destroying it.
*/
disableDependentServices?: pulumi.Input<boolean | undefined>;
/**
* If `true`, disable the service when the
* Terraform resource is destroyed. If `false` or unset, the service will be left enabled when
* the Terraform resource is destroyed. It should generally only
* be `true` in configurations that manage the `gcp.organizations.Project` resource itself.
*/
disableOnDestroy?: pulumi.Input<boolean | undefined>;
/**
* The project ID. If not provided, the provider project
* is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The service to enable.
*/
service?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a Service resource.
*/
export interface ServiceArgs {
/**
* Beta
* If `true`, the usage of the service to be disabled will be checked and an error
* will be returned if the service to be disabled has usage in last 30 days.
*/
checkIfServiceHasUsageOnDestroy?: pulumi.Input<boolean | 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>;
/**
* If `true`, services that are enabled
* and which depend on this service should also be disabled when this service is
* destroyed. If `false` or unset, an error will be generated if any enabled
* services depend on this service when destroying it.
*/
disableDependentServices?: pulumi.Input<boolean | undefined>;
/**
* If `true`, disable the service when the
* Terraform resource is destroyed. If `false` or unset, the service will be left enabled when
* the Terraform resource is destroyed. It should generally only
* be `true` in configurations that manage the `gcp.organizations.Project` resource itself.
*/
disableOnDestroy?: pulumi.Input<boolean | undefined>;
/**
* The project ID. If not provided, the provider project
* is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The service to enable.
*/
service: pulumi.Input<string>;
}
//# sourceMappingURL=service.d.ts.map