@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
228 lines (227 loc) • 7.88 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ServiceBinding is the resource that defines a Service Directory Service to be used in a
* BackendService resource.
*
* To get more information about ServiceBinding, see:
*
* * [API documentation](https://cloud.google.com/traffic-director/docs/reference/network-services/rest/v1beta1/projects.locations.serviceBindings)
*
* ## Example Usage
*
* ### Network Services Service Binding Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.servicedirectory.Namespace("default", {
* namespaceId: "my-namespace",
* location: "us-central1",
* });
* const defaultService = new gcp.servicedirectory.Service("default", {
* serviceId: "my-service",
* namespace: _default.id,
* metadata: {
* stage: "prod",
* region: "us-central1",
* },
* });
* const defaultServiceBinding = new gcp.networkservices.ServiceBinding("default", {
* name: "my-service-binding",
* labels: {
* foo: "bar",
* },
* description: "my description",
* service: defaultService.id,
* });
* ```
*
* ## Import
*
* ServiceBinding can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/global/serviceBindings/{{name}}`
*
* * `{{project}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, ServiceBinding can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:networkservices/serviceBinding:ServiceBinding default projects/{{project}}/locations/global/serviceBindings/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:networkservices/serviceBinding:ServiceBinding default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:networkservices/serviceBinding:ServiceBinding default {{name}}
* ```
*/
export declare class ServiceBinding extends pulumi.CustomResource {
/**
* Get an existing ServiceBinding 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?: ServiceBindingState, opts?: pulumi.CustomResourceOptions): ServiceBinding;
/**
* Returns true if the given object is an instance of ServiceBinding. 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 ServiceBinding;
/**
* Time the ServiceBinding was created in UTC.
*/
readonly createTime: pulumi.Output<string>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Set of label tags associated with the ServiceBinding resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Name of the ServiceBinding resource.
*
*
* - - -
*/
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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The full Service Directory Service name of the format
* projects/*/locations/*/namespaces/*/services/*
*/
readonly service: pulumi.Output<string>;
/**
* Time the ServiceBinding was updated in UTC.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a ServiceBinding 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: ServiceBindingArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ServiceBinding resources.
*/
export interface ServiceBindingState {
/**
* Time the ServiceBinding was created in UTC.
*/
createTime?: pulumi.Input<string>;
/**
* A free-text description of the resource. Max length 1024 characters.
*/
description?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Set of label tags associated with the ServiceBinding resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the ServiceBinding resource.
*
*
* - - -
*/
name?: 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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The full Service Directory Service name of the format
* projects/*/locations/*/namespaces/*/services/*
*/
service?: pulumi.Input<string>;
/**
* Time the ServiceBinding was updated in UTC.
*/
updateTime?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ServiceBinding resource.
*/
export interface ServiceBindingArgs {
/**
* A free-text description of the resource. Max length 1024 characters.
*/
description?: pulumi.Input<string>;
/**
* Set of label tags associated with the ServiceBinding resource.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Name of the ServiceBinding resource.
*
*
* - - -
*/
name?: 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>;
/**
* The full Service Directory Service name of the format
* projects/*/locations/*/namespaces/*/services/*
*/
service: pulumi.Input<string>;
}