@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
182 lines • 7.86 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Describes a group of resources to read log entries from
*
* To get more information about LogScope, see:
*
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.locations.logScopes)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/logging/docs/apis)
*
* ## Example Usage
*
* ### Logging Log Scope Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const loggingLogScope = new gcp.logging.LogScope("logging_log_scope", {
* parent: "projects/my-project-name",
* location: "global",
* name: "projects/my-project-name/locations/global/logScopes/my-log-scope",
* resourceNames: [
* "projects/my-project-name",
* "projects/my-project-name/locations/global/buckets/_Default/views/view1",
* "projects/my-project-name/locations/global/buckets/_Default/views/view2",
* ],
* description: "A log scope configured with Terraform",
* });
* ```
*
* ## Import
*
* LogScope can be imported using any of these accepted formats:
*
* * `{{parent}}/locations/{{location}}/logScopes/{{name}}`
*
* When using the `pulumi import` command, LogScope can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:logging/logScope:LogScope default {{parent}}/locations/{{location}}/logScopes/{{name}}
* ```
*/
export declare class LogScope extends pulumi.CustomResource {
/**
* Get an existing LogScope 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?: LogScopeState, opts?: pulumi.CustomResourceOptions): LogScope;
/**
* Returns true if the given object is an instance of LogScope. 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 LogScope;
/**
* Output only. The creation timestamp of the log scopes.
*/
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 log scopes.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The location of the resource. The only supported location is global so far.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the log scope. For example: \`projects/my-project/locations/global/logScopes/my-log-scope\`
*/
readonly name: pulumi.Output<string>;
/**
* The parent of the resource.
*/
readonly parent: pulumi.Output<string>;
/**
* Names of one or more parent resources : * \`projects/[PROJECT_ID]\` May alternatively be one or more views : * \`projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\` A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
*/
readonly resourceNames: pulumi.Output<string[]>;
/**
* Output only. The last update timestamp of the log scopes.
*/
readonly updateTime: pulumi.Output<string>;
/**
* Create a LogScope 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: LogScopeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering LogScope resources.
*/
export interface LogScopeState {
/**
* Output only. The creation timestamp of the log scopes.
*/
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 log scopes.
*/
description?: pulumi.Input<string | undefined>;
/**
* The location of the resource. The only supported location is global so far.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the log scope. For example: \`projects/my-project/locations/global/logScopes/my-log-scope\`
*/
name?: pulumi.Input<string | undefined>;
/**
* The parent of the resource.
*/
parent?: pulumi.Input<string | undefined>;
/**
* Names of one or more parent resources : * \`projects/[PROJECT_ID]\` May alternatively be one or more views : * \`projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\` A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
*/
resourceNames?: pulumi.Input<pulumi.Input<string>[] | undefined>;
/**
* Output only. The last update timestamp of the log scopes.
*/
updateTime?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a LogScope resource.
*/
export interface LogScopeArgs {
/**
* 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 log scopes.
*/
description?: pulumi.Input<string | undefined>;
/**
* The location of the resource. The only supported location is global so far.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the log scope. For example: \`projects/my-project/locations/global/logScopes/my-log-scope\`
*/
name?: pulumi.Input<string | undefined>;
/**
* The parent of the resource.
*/
parent?: pulumi.Input<string | undefined>;
/**
* Names of one or more parent resources : * \`projects/[PROJECT_ID]\` May alternatively be one or more views : * \`projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]\` A log scope can include a maximum of 50 projects and a maximum of 100 resources in total.
*/
resourceNames: pulumi.Input<pulumi.Input<string>[]>;
}
//# sourceMappingURL=logScope.d.ts.map