@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
141 lines (140 loc) • 5.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages an organization-level logging exclusion. For more information see:
*
* * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/organizations.exclusions)
* * How-to Guides
* * [Excluding Logs](https://cloud.google.com/logging/docs/exclusions)
*
* > You can specify exclusions for log sinks created by the provider by using the exclusions field of `gcp.logging.OrganizationSink`
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_exclusion = new gcp.logging.OrganizationExclusion("my-exclusion", {
* name: "my-instance-debug-exclusion",
* orgId: "123456789",
* description: "Exclude GCE instance debug logs",
* filter: "resource.type = gce_instance AND severity <= DEBUG",
* });
* ```
*
* ## Import
*
* Organization-level logging exclusions can be imported using their URI, e.g.
*
* * `organizations/{{organization}}/exclusions/{{name}}`
*
* When using the `pulumi import` command, organization-level logging exclusions can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:logging/organizationExclusion:OrganizationExclusion default organizations/{{organization}}/exclusions/{{name}}
* ```
*/
export declare class OrganizationExclusion extends pulumi.CustomResource {
/**
* Get an existing OrganizationExclusion 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?: OrganizationExclusionState, opts?: pulumi.CustomResourceOptions): OrganizationExclusion;
/**
* Returns true if the given object is an instance of OrganizationExclusion. 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 OrganizationExclusion;
/**
* A human-readable description.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* Whether this exclusion rule should be disabled or not. This defaults to
* false.
*/
readonly disabled: pulumi.Output<boolean | undefined>;
/**
* The filter to apply when excluding logs. Only log entries that match the filter are excluded.
* See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to
* write a filter.
*/
readonly filter: pulumi.Output<string>;
/**
* The name of the logging exclusion.
*/
readonly name: pulumi.Output<string>;
/**
* The organization to create the exclusion in.
*/
readonly orgId: pulumi.Output<string>;
/**
* Create a OrganizationExclusion 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: OrganizationExclusionArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OrganizationExclusion resources.
*/
export interface OrganizationExclusionState {
/**
* A human-readable description.
*/
description?: pulumi.Input<string>;
/**
* Whether this exclusion rule should be disabled or not. This defaults to
* false.
*/
disabled?: pulumi.Input<boolean>;
/**
* The filter to apply when excluding logs. Only log entries that match the filter are excluded.
* See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to
* write a filter.
*/
filter?: pulumi.Input<string>;
/**
* The name of the logging exclusion.
*/
name?: pulumi.Input<string>;
/**
* The organization to create the exclusion in.
*/
orgId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a OrganizationExclusion resource.
*/
export interface OrganizationExclusionArgs {
/**
* A human-readable description.
*/
description?: pulumi.Input<string>;
/**
* Whether this exclusion rule should be disabled or not. This defaults to
* false.
*/
disabled?: pulumi.Input<boolean>;
/**
* The filter to apply when excluding logs. Only log entries that match the filter are excluded.
* See [Advanced Log Filters](https://cloud.google.com/logging/docs/view/advanced-filters) for information on how to
* write a filter.
*/
filter: pulumi.Input<string>;
/**
* The name of the logging exclusion.
*/
name?: pulumi.Input<string>;
/**
* The organization to create the exclusion in.
*/
orgId: pulumi.Input<string>;
}