UNPKG

@pulumi/gcp

Version:

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

175 lines 7.43 kB
import * as pulumi from "@pulumi/pulumi"; /** * An individual service. A service contains a name and optional metadata. * * To get more information about Service, see: * * * [API documentation](https://cloud.google.com/service-directory/docs/reference/rest/v1/projects.locations.namespaces.services) * * How-to Guides * * [Configuring a service](https://cloud.google.com/service-directory/docs/configuring-service-directory#configuring_a_service) * * ## Example Usage * * ### Service Directory Service Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const example = new gcp.servicedirectory.Namespace("example", { * namespaceId: "example-namespace", * location: "us-central1", * }); * const exampleService = new gcp.servicedirectory.Service("example", { * serviceId: "example-service", * namespace: example.id, * metadata: { * stage: "prod", * region: "us-central1", * }, * }); * ``` * * ## Import * * Service can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}}` * * `{{project}}/{{location}}/{{namespace_id}}/{{service_id}}` * * `{{location}}/{{namespace_id}}/{{service_id}}` * * When using the `pulumi import` command, Service can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:servicedirectory/service:Service default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}/services/{{service_id}} * $ pulumi import gcp:servicedirectory/service:Service default {{project}}/{{location}}/{{namespace_id}}/{{service_id}} * $ pulumi import gcp:servicedirectory/service:Service default {{location}}/{{namespace_id}}/{{service_id}} * ``` */ 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; /** * 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>; /** * Metadata for the service. This data can be consumed * by service clients. The entire metadata dictionary may contain * up to 2000 characters, spread across all key-value pairs. * Metadata that goes beyond any these limits will be rejected. */ readonly metadata: pulumi.Output<{ [key: string]: string; } | undefined>; /** * The resource name for the service in the * format `projects/*&#47;locations/*&#47;namespaces/*&#47;services/*`. */ readonly name: pulumi.Output<string>; /** * The resource name of the namespace this service will belong to. */ readonly namespace: pulumi.Output<string>; /** * The Resource ID must be 1-63 characters long, including digits, * lowercase letters or the hyphen character. */ readonly serviceId: 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 { /** * 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>; /** * Metadata for the service. This data can be consumed * by service clients. The entire metadata dictionary may contain * up to 2000 characters, spread across all key-value pairs. * Metadata that goes beyond any these limits will be rejected. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The resource name for the service in the * format `projects/*&#47;locations/*&#47;namespaces/*&#47;services/*`. */ name?: pulumi.Input<string | undefined>; /** * The resource name of the namespace this service will belong to. */ namespace?: pulumi.Input<string | undefined>; /** * The Resource ID must be 1-63 characters long, including digits, * lowercase letters or the hyphen character. */ serviceId?: pulumi.Input<string | undefined>; } /** * The set of arguments for constructing a Service resource. */ export interface ServiceArgs { /** * 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>; /** * Metadata for the service. This data can be consumed * by service clients. The entire metadata dictionary may contain * up to 2000 characters, spread across all key-value pairs. * Metadata that goes beyond any these limits will be rejected. */ metadata?: pulumi.Input<{ [key: string]: pulumi.Input<string>; } | undefined>; /** * The resource name of the namespace this service will belong to. */ namespace: pulumi.Input<string>; /** * The Resource ID must be 1-63 characters long, including digits, * lowercase letters or the hyphen character. */ serviceId: pulumi.Input<string>; } //# sourceMappingURL=service.d.ts.map