@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
211 lines • 8.36 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* A trace scope is a collection of resources whose traces are queried together
*
* ## Example Usage
*
* ### Observability Trace Scope Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const project = gcp.organizations.getProject({});
* const project_2 = new gcp.organizations.Project("project-2", {
* projectId: "tf-test_97523",
* name: "tf-test_31660",
* orgId: "123456789",
* deletionPolicy: "DELETE",
* });
* const observabilityTraceScope = new gcp.observability.TraceScope("observability_trace_scope", {
* traceScopeId: "test-scope",
* location: "global",
* resourceNames: [
* project.then(project => `projects/${project.projectId}`),
* pulumi.interpolate`projects/${project_2.projectId}`,
* ],
* description: "A trace scope configured with Terraform",
* }, {
* dependsOn: [project_2],
* });
* ```
*
* ## Import
*
* TraceScope can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/traceScopes/{{trace_scope_id}}`
* * `{{project}}/{{location}}/{{trace_scope_id}}`
* * `{{location}}/{{trace_scope_id}}`
*
* When using the `pulumi import` command, TraceScope can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:observability/traceScope:TraceScope default projects/{{project}}/locations/{{location}}/traceScopes/{{trace_scope_id}}
* $ pulumi import gcp:observability/traceScope:TraceScope default {{project}}/{{location}}/{{trace_scope_id}}
* $ pulumi import gcp:observability/traceScope:TraceScope default {{location}}/{{trace_scope_id}}
* ```
*/
export declare class TraceScope extends pulumi.CustomResource {
/**
* Get an existing TraceScope 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?: TraceScopeState, opts?: pulumi.CustomResourceOptions): TraceScope;
/**
* Returns true if the given object is an instance of TraceScope. 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 TraceScope;
/**
* The creation timestamp of the trace scope.
*/
readonly createTime: pulumi.Output<string>;
/**
* 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>;
/**
* Describes this trace scope.
* The maximum length of the description is 8000 characters.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* GCP region the TraceScope is stored in. Only `global` is supported.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The resource name of the trace scope.
* For example:
* projects/my-project/locations/global/traceScopes/my-trace-scope
*/
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>;
/**
* Names of the projects that are included in this trace scope.
* * `projects/[PROJECT_ID]`
* A trace scope can include a maximum of 20 projects.
*/
readonly resourceNames: pulumi.Output<string[]>;
/**
* A client-assigned identifier for the trace scope.
*/
readonly traceScopeId: pulumi.Output<string>;
/**
* The last update timestamp of the trace scope.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a TraceScope 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: TraceScopeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering TraceScope resources.
*/
export interface TraceScopeState {
/**
* The creation timestamp of the trace scope.
*/
createTime?: pulumi.Input<string | 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>;
/**
* Describes this trace scope.
* The maximum length of the description is 8000 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* GCP region the TraceScope is stored in. Only `global` is supported.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The resource name of the trace scope.
* For example:
* projects/my-project/locations/global/traceScopes/my-trace-scope
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* Names of the projects that are included in this trace scope.
* * `projects/[PROJECT_ID]`
* A trace scope can include a maximum of 20 projects.
*/
resourceNames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* A client-assigned identifier for the trace scope.
*/
traceScopeId?: pulumi.Input<string | undefined>;
/**
* The last update timestamp of the trace scope.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a TraceScope resource.
*/
export interface TraceScopeArgs {
/**
* 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>;
/**
* Describes this trace scope.
* The maximum length of the description is 8000 characters.
*/
description?: pulumi.Input<string | undefined>;
/**
* GCP region the TraceScope is stored in. Only `global` is supported.
*/
location: 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 | undefined>;
/**
* Names of the projects that are included in this trace scope.
* * `projects/[PROJECT_ID]`
* A trace scope can include a maximum of 20 projects.
*/
resourceNames: pulumi.Input<pulumi.Input<string>[]>;
/**
* A client-assigned identifier for the trace scope.
*/
traceScopeId: pulumi.Input<string>;
}
//# sourceMappingURL=traceScope.d.ts.map