import * as pulumi from "@pulumi/pulumi"; /** * The Tenant resource represents the service producer's view of a service instance created for a consumer. It enables the association between the service producer's managed resources and the end consumer. * * > **Warning:** This resource is in beta, and should be used with the terraform-provider-google-beta provider. * See Provider Versions for more details on beta resources. * * ## Example Usage * * ### Saas Runtime Tenant Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const exampleSaas = new gcp.saasruntime.SaaS("example_saas", { * saasId: "example-saas", * location: "global", * locations: [{ * name: "us-central1", * }], * }); * const example = new gcp.saasruntime.Tenant("example", { * location: "global", * tenantId: "example-tenant", * saas: exampleSaas.id, * consumerResource: "//compute.googleapis.com/projects/example-project/zones/us-central1-a/instances/example-instance", * }); * ``` * * ## Import * * Tenant can be imported using any of these accepted formats: * * * `projects/{{project}}/locations/{{location}}/tenants/{{tenant_id}}` * * `{{project}}/{{location}}/{{tenant_id}}` * * `{{location}}/{{tenant_id}}` * * When using the `pulumi import` command, Tenant can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:saasruntime/tenant:Tenant default projects/{{project}}/locations/{{location}}/tenants/{{tenant_id}} * $ pulumi import gcp:saasruntime/tenant:Tenant default {{project}}/{{location}}/{{tenant_id}} * $ pulumi import gcp:saasruntime/tenant:Tenant default {{location}}/{{tenant_id}} * ``` */ export declare class Tenant extends pulumi.CustomResource { /** * Get an existing Tenant 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, state?: TenantState, opts?: pulumi.CustomResourceOptions): Tenant; /** * Returns true if the given object is an instance of Tenant. 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 Tenant; /** * Annotations is an unstructured key-value map stored with a resource that * may be set by external tools to store and retrieve arbitrary metadata. * They are not queryable and should be preserved when modifying objects. * More info: https://kubernetes.io/docs/user-guide/annotations * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource. */ readonly annotations: pulumi.Output<{ [key: string]: string; } | undefined>; /** * A reference to the consumer resource this SaaS Tenant is representing. * The relationship with a consumer resource can be used by SaaS Runtime for * retrieving consumer-defined settings and policies such as maintenance * policies (using Unified Maintenance Policy API). */ readonly consumerResource: pulumi.Output; /** * The timestamp when the resource was created. */ readonly createTime: pulumi.Output; /** * All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. */ readonly effectiveAnnotations: pulumi.Output<{ [key: string]: string; }>; /** * 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; }>; /** * The labels on the resource, which can be used for categorization. * similar to Kubernetes resource labels. * **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>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ readonly location: pulumi.Output; /** * Identifier. The resource name (full URI of the resource) following the standard naming * scheme: * "projects/{project}/locations/{location}/tenants/{tenant}" */ readonly name: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * A reference to the Saas that defines the product (managed service) that * the producer wants to manage with SaaS Runtime. Part of the * SaaS Runtime common data model. */ readonly saas: pulumi.Output; /** * The ID value for the new tenant. */ readonly tenantId: pulumi.Output; /** * The unique identifier of the resource. UID is unique in the time * and space for this resource within the scope of the service. It is * typically generated by the server on successful creation of a resource * and must not be changed. UID is used to uniquely identify resources * with resource name reuses. This should be a UUID4. */ readonly uid: pulumi.Output; /** * The timestamp when the resource was last updated. Any * change to the resource made by users must refresh this value. * Changes to a resource made by the service should refresh this value. */ readonly updateTime: pulumi.Output; /** * Create a Tenant 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: TenantArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Tenant resources. */ export interface TenantState { /** * Annotations is an unstructured key-value map stored with a resource that * may be set by external tools to store and retrieve arbitrary metadata. * They are not queryable and should be preserved when modifying objects. * More info: https://kubernetes.io/docs/user-guide/annotations * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource. */ annotations?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A reference to the consumer resource this SaaS Tenant is representing. * The relationship with a consumer resource can be used by SaaS Runtime for * retrieving consumer-defined settings and policies such as maintenance * policies (using Unified Maintenance Policy API). */ consumerResource?: pulumi.Input; /** * The timestamp when the resource was created. */ createTime?: pulumi.Input; /** * All of annotations (key/value pairs) present on the resource in GCP, including the annotations configured through Terraform, other clients and services. */ effectiveAnnotations?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * 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; }>; /** * The labels on the resource, which can be used for categorization. * similar to Kubernetes resource labels. * **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; }>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location?: pulumi.Input; /** * Identifier. The resource name (full URI of the resource) following the standard naming * scheme: * "projects/{project}/locations/{location}/tenants/{tenant}" */ name?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A reference to the Saas that defines the product (managed service) that * the producer wants to manage with SaaS Runtime. Part of the * SaaS Runtime common data model. */ saas?: pulumi.Input; /** * The ID value for the new tenant. */ tenantId?: pulumi.Input; /** * The unique identifier of the resource. UID is unique in the time * and space for this resource within the scope of the service. It is * typically generated by the server on successful creation of a resource * and must not be changed. UID is used to uniquely identify resources * with resource name reuses. This should be a UUID4. */ uid?: pulumi.Input; /** * The timestamp when the resource was last updated. Any * change to the resource made by users must refresh this value. * Changes to a resource made by the service should refresh this value. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a Tenant resource. */ export interface TenantArgs { /** * Annotations is an unstructured key-value map stored with a resource that * may be set by external tools to store and retrieve arbitrary metadata. * They are not queryable and should be preserved when modifying objects. * More info: https://kubernetes.io/docs/user-guide/annotations * **Note**: This field is non-authoritative, and will only manage the annotations present in your configuration. * Please refer to the field `effectiveAnnotations` for all of the annotations present on the resource. */ annotations?: pulumi.Input<{ [key: string]: pulumi.Input; }>; /** * A reference to the consumer resource this SaaS Tenant is representing. * The relationship with a consumer resource can be used by SaaS Runtime for * retrieving consumer-defined settings and policies such as maintenance * policies (using Unified Maintenance Policy API). */ consumerResource?: pulumi.Input; /** * The labels on the resource, which can be used for categorization. * similar to Kubernetes resource labels. * **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; }>; /** * Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122. */ location: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * A reference to the Saas that defines the product (managed service) that * the producer wants to manage with SaaS Runtime. Part of the * SaaS Runtime common data model. */ saas: pulumi.Input; /** * The ID value for the new tenant. */ tenantId: pulumi.Input; }