@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
142 lines • 5.59 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* The Artifact Registry project config, used to configure platform logs that
* apply to a project.
*
* To get more information about ProjectConfig, see:
*
* * [API documentation](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations/getProjectConfig)
* * How-to Guides
* * [Access and use platform logs](https://cloud.google.com/artifact-registry/docs/platform-logs)
*
* > **Note:** A project config is automatically created for a given location. Creating a
* resource of this type will acquire and update the resource that already
* exists at the location. Deleting this resource will remove the config from
* your Terraform state but leave the resource as is.
* ## Example Usage
*
* ### Artifact Registry Project Config
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_config = new gcp.artifactregistry.ProjectConfig("my-config", {
* location: "us-central1",
* platformLogsConfig: {
* loggingState: "ENABLED",
* severityLevel: "INFO",
* },
* });
* ```
*
* ## Regional Endpoint Policies
*
* This resource supports Regional Endpoint Policies (REP). See the provider reference for more details on configuration.
*
* ## Import
*
* ProjectConfig can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/projectConfig`
* * `{{project}}/{{location}}`
* * `{{location}}`
*
* When using the `pulumi import` command, ProjectConfig can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:artifactregistry/projectConfig:ProjectConfig default projects/{{project}}/locations/{{location}}/projectConfig
* $ pulumi import gcp:artifactregistry/projectConfig:ProjectConfig default {{project}}/{{location}}
* $ pulumi import gcp:artifactregistry/projectConfig:ProjectConfig default {{location}}
* ```
*/
export declare class ProjectConfig extends pulumi.CustomResource {
/**
* Get an existing ProjectConfig 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?: ProjectConfigState, opts?: pulumi.CustomResourceOptions): ProjectConfig;
/**
* Returns true if the given object is an instance of ProjectConfig. 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 ProjectConfig;
/**
* The name of the location this config is located in.
*/
readonly location: pulumi.Output<string>;
/**
* The name of the project's config.
* Always of the form: projects/{project}/locations/{location}/projectConfig
*/
readonly name: pulumi.Output<string>;
/**
* Configuration for platform logs.
* Structure is documented below.
*/
readonly platformLogsConfig: pulumi.Output<outputs.artifactregistry.ProjectConfigPlatformLogsConfig | undefined>;
/**
* 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>;
/**
* Create a ProjectConfig 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?: ProjectConfigArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectConfig resources.
*/
export interface ProjectConfigState {
/**
* The name of the location this config is located in.
*/
location?: pulumi.Input<string | undefined>;
/**
* The name of the project's config.
* Always of the form: projects/{project}/locations/{location}/projectConfig
*/
name?: pulumi.Input<string | undefined>;
/**
* Configuration for platform logs.
* Structure is documented below.
*/
platformLogsConfig?: pulumi.Input<inputs.artifactregistry.ProjectConfigPlatformLogsConfig | 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>;
}
/**
* The set of arguments for constructing a ProjectConfig resource.
*/
export interface ProjectConfigArgs {
/**
* The name of the location this config is located in.
*/
location?: pulumi.Input<string | undefined>;
/**
* Configuration for platform logs.
* Structure is documented below.
*/
platformLogsConfig?: pulumi.Input<inputs.artifactregistry.ProjectConfigPlatformLogsConfig | 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>;
}
//# sourceMappingURL=projectConfig.d.ts.map