@pulumi/gcp/logging/organizationSettings.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * Default resource settings control whether CMEK is required for new log buckets. These settings also determine the storage location for the _Default and _Required log buckets, and whether the _Default sink is enabled or disabled.
 *
 * To get more information about OrganizationSettings, see:
 *
 * * [API documentation](https://cloud.google.com/logging/docs/reference/v2/rest/v2/TopLevel/getSettings)
 * * How-to Guides
 *     * [Configure default settings for organizations and folders](https://cloud.google.com/logging/docs/default-settings)
 *
 * ## Example Usage
 *
 * ### Logging Organization Settings All
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const settings = gcp.logging.getOrganizationSettings({
 *     organization: "123456789",
 * });
 * const iam = new gcp.kms.CryptoKeyIAMMember("iam", {
 *     cryptoKeyId: "kms-key",
 *     role: "roles/cloudkms.cryptoKeyEncrypterDecrypter",
 *     member: settings.then(settings => `serviceAccount:${settings.kmsServiceAccountId}`),
 * });
 * const example = new gcp.logging.OrganizationSettings("example", {
 *     disableDefaultSink: true,
 *     kmsKeyName: "kms-key",
 *     organization: "123456789",
 *     storageLocation: "us-central1",
 * }, {
 *     dependsOn: [iam],
 * });
 * ```
 *
 * ## Import
 *
 * OrganizationSettings can be imported using any of these accepted formats:
 *
 * * `organizations/{{organization}}/settings`
 *
 * * `{{organization}}`
 *
 * When using the `pulumi import` command, OrganizationSettings can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:logging/organizationSettings:OrganizationSettings default organizations/{{organization}}/settings
 * ```
 *
 * ```sh
 * $ pulumi import gcp:logging/organizationSettings:OrganizationSettings default {{organization}}
 * ```
 */
export declare class OrganizationSettings extends pulumi.CustomResource {
    /**
     * Get an existing OrganizationSettings 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?: OrganizationSettingsState, opts?: pulumi.CustomResourceOptions): OrganizationSettings;
    /**
     * Returns true if the given object is an instance of OrganizationSettings.  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 OrganizationSettings;
    /**
     * If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
     */
    readonly disableDefaultSink: pulumi.Output<boolean>;
    /**
     * The resource name for the configured Cloud KMS key.
     */
    readonly kmsKeyName: pulumi.Output<string>;
    /**
     * The service account that will be used by the Log Router to access your Cloud KMS key.
     */
    readonly kmsServiceAccountId: pulumi.Output<string>;
    /**
     * The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
     */
    readonly loggingServiceAccountId: pulumi.Output<string>;
    /**
     * The resource name of the settings.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The organization for which to retrieve or configure settings.
     *
     *
     * - - -
     */
    readonly organization: pulumi.Output<string>;
    /**
     * The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
     */
    readonly storageLocation: pulumi.Output<string>;
    /**
     * Create a OrganizationSettings 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: OrganizationSettingsArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OrganizationSettings resources.
 */
export interface OrganizationSettingsState {
    /**
     * If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
     */
    disableDefaultSink?: pulumi.Input<boolean>;
    /**
     * The resource name for the configured Cloud KMS key.
     */
    kmsKeyName?: pulumi.Input<string>;
    /**
     * The service account that will be used by the Log Router to access your Cloud KMS key.
     */
    kmsServiceAccountId?: pulumi.Input<string>;
    /**
     * The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
     */
    loggingServiceAccountId?: pulumi.Input<string>;
    /**
     * The resource name of the settings.
     */
    name?: pulumi.Input<string>;
    /**
     * The organization for which to retrieve or configure settings.
     *
     *
     * - - -
     */
    organization?: pulumi.Input<string>;
    /**
     * The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
     */
    storageLocation?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OrganizationSettings resource.
 */
export interface OrganizationSettingsArgs {
    /**
     * If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.
     */
    disableDefaultSink?: pulumi.Input<boolean>;
    /**
     * The resource name for the configured Cloud KMS key.
     */
    kmsKeyName?: pulumi.Input<string>;
    /**
     * The organization for which to retrieve or configure settings.
     *
     *
     * - - -
     */
    organization: pulumi.Input<string>;
    /**
     * The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
     */
    storageLocation?: pulumi.Input<string>;
}