@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
215 lines (214 loc) • 7.84 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A container for `services`. Namespaces allow administrators to group services
* together and define permissions for a collection of services.
*
* To get more information about Namespace, see:
*
* * [API documentation](https://cloud.google.com/service-directory/docs/reference/rest/v1beta1/projects.locations.namespaces)
* * How-to Guides
* * [Configuring a namespace](https://cloud.google.com/service-directory/docs/configuring-service-directory#configuring_a_namespace)
*
* ## Example Usage
*
* ### Service Directory Namespace 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",
* labels: {
* key: "value",
* foo: "bar",
* },
* });
* ```
*
* ## Import
*
* Namespace can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}`
*
* * `{{project}}/{{location}}/{{namespace_id}}`
*
* * `{{location}}/{{namespace_id}}`
*
* When using the `pulumi import` command, Namespace can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:servicedirectory/namespace:Namespace default projects/{{project}}/locations/{{location}}/namespaces/{{namespace_id}}
* ```
*
* ```sh
* $ pulumi import gcp:servicedirectory/namespace:Namespace default {{project}}/{{location}}/{{namespace_id}}
* ```
*
* ```sh
* $ pulumi import gcp:servicedirectory/namespace:Namespace default {{location}}/{{namespace_id}}
* ```
*/
export declare class Namespace extends pulumi.CustomResource {
/**
* Get an existing Namespace 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?: NamespaceState, opts?: pulumi.CustomResourceOptions): Namespace;
/**
* Returns true if the given object is an instance of Namespace. 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 Namespace;
/**
* 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;
}>;
/**
* Resource labels associated with this Namespace. No more than 64 user
* labels can be associated with a given resource. Label keys and values can
* be no longer than 63 characters.
*
* **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>;
/**
* The location for the Namespace.
* A full list of valid locations can be found by running
* `gcloud beta service-directory locations list`.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name for the namespace
* in the format `projects/*/locations/*/namespaces/*`.
*/
readonly name: pulumi.Output<string>;
/**
* The Resource ID must be 1-63 characters long, including digits,
* lowercase letters or the hyphen character.
*
*
* - - -
*/
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>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a Namespace 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: NamespaceArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Namespace resources.
*/
export interface NamespaceState {
/**
* 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>;
}>;
/**
* Resource labels associated with this Namespace. No more than 64 user
* labels can be associated with a given resource. Label keys and values can
* be no longer than 63 characters.
*
* **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>;
}>;
/**
* The location for the Namespace.
* A full list of valid locations can be found by running
* `gcloud beta service-directory locations list`.
*/
location?: pulumi.Input<string>;
/**
* The resource name for the namespace
* in the format `projects/*/locations/*/namespaces/*`.
*/
name?: pulumi.Input<string>;
/**
* The Resource ID must be 1-63 characters long, including digits,
* lowercase letters or the hyphen character.
*
*
* - - -
*/
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>;
/**
* 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 set of arguments for constructing a Namespace resource.
*/
export interface NamespaceArgs {
/**
* Resource labels associated with this Namespace. No more than 64 user
* labels can be associated with a given resource. Label keys and values can
* be no longer than 63 characters.
*
* **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>;
}>;
/**
* The location for the Namespace.
* A full list of valid locations can be found by running
* `gcloud beta service-directory locations list`.
*/
location: pulumi.Input<string>;
/**
* The Resource ID must be 1-63 characters long, including digits,
* lowercase letters or the hyphen character.
*
*
* - - -
*/
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>;
}