@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
159 lines • 6.08 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Manages Cloud Observability settings for a project.
*
* > **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
*
* ### Observability Project Settings Basic Global
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
* import * as time from "@pulumiverse/time";
*
* const project = new gcp.organizations.Project("project", {
* projectId: "tf-test_41898",
* name: "tf-test_63399",
* orgId: "123456789",
* deletionPolicy: "DELETE",
* });
* const observabilityApi = new gcp.projects.Service("observability_api", {
* project: project.projectId,
* service: "observability.googleapis.com",
* disableOnDestroy: false,
* });
* // Wait for the project to be created and recognized by the Observability API
* const waitForSettingsPropagation = new time.Sleep("wait_for_settings_propagation", {createDuration: "90s"}, {
* dependsOn: [observabilityApi],
* });
* const primaryGlobal = new gcp.observability.ProjectSettings("primary_global", {
* location: "global",
* project: project.projectId,
* defaultStorageLocation: "eu",
* }, {
* dependsOn: [waitForSettingsPropagation],
* });
* ```
*
* ## Import
*
* ProjectSettings can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/settings`
* * `{{project}}/{{location}}`
* * `{{location}}`
*
* When using the `pulumi import` command, ProjectSettings can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:observability/projectSettings:ProjectSettings default projects/{{project}}/locations/{{location}}/settings
* $ pulumi import gcp:observability/projectSettings:ProjectSettings default {{project}}/{{location}}
* $ pulumi import gcp:observability/projectSettings:ProjectSettings default {{location}}
* ```
*/
export declare class ProjectSettings extends pulumi.CustomResource {
/**
* Get an existing ProjectSettings 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?: ProjectSettingsState, opts?: pulumi.CustomResourceOptions): ProjectSettings;
/**
* Returns true if the given object is an instance of ProjectSettings. 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 ProjectSettings;
/**
* The default storage location for new resources, e.g. buckets. Only valid for global location.
*/
readonly defaultStorageLocation: pulumi.Output<string | undefined>;
/**
* The default Cloud KMS key to use for new resources. Only valid for regional locations.
*/
readonly kmsKeyName: pulumi.Output<string | undefined>;
/**
* The location of the settings.
*/
readonly location: pulumi.Output<string>;
/**
* The resource name of the settings.
*/
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>;
/**
* The service account used by Cloud Observability for this project.
*/
readonly serviceAccountId: pulumi.Output<string>;
/**
* Create a ProjectSettings 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: ProjectSettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ProjectSettings resources.
*/
export interface ProjectSettingsState {
/**
* The default storage location for new resources, e.g. buckets. Only valid for global location.
*/
defaultStorageLocation?: pulumi.Input<string | undefined>;
/**
* The default Cloud KMS key to use for new resources. Only valid for regional locations.
*/
kmsKeyName?: pulumi.Input<string | undefined>;
/**
* The location of the settings.
*/
location?: pulumi.Input<string | undefined>;
/**
* The resource name of the settings.
*/
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>;
/**
* The service account used by Cloud Observability for this project.
*/
serviceAccountId?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a ProjectSettings resource.
*/
export interface ProjectSettingsArgs {
/**
* The default storage location for new resources, e.g. buckets. Only valid for global location.
*/
defaultStorageLocation?: pulumi.Input<string | undefined>;
/**
* The default Cloud KMS key to use for new resources. Only valid for regional locations.
*/
kmsKeyName?: pulumi.Input<string | undefined>;
/**
* The location of the settings.
*/
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>;
}
//# sourceMappingURL=projectSettings.d.ts.map