Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. logging
  5. getOrganizationSettings
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.logging.getOrganizationSettings

Explore with Pulumi AI

gcp logo
Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-gcp

    Describes the settings associated with a organization.

    To get more information about LoggingOrganizationSettings, see:

    Example Usage

    Logging Organization Settings Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const settings = gcp.logging.getOrganizationSettings({
    organization: "my-organization-name",
});

    import pulumi
import pulumi_gcp as gcp

settings = gcp.logging.get_organization_settings(organization="my-organization-name")

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/logging"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := logging.LookupOrganizationSettings(ctx, &logging.LookupOrganizationSettingsArgs{
			Organization: "my-organization-name",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() => 
{
    var settings = Gcp.Logging.GetOrganizationSettings.Invoke(new()
    {
        Organization = "my-organization-name",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.logging.LoggingFunctions;
import com.pulumi.gcp.logging.inputs.GetOrganizationSettingsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var settings = LoggingFunctions.getOrganizationSettings(GetOrganizationSettingsArgs.builder()
            .organization("my-organization-name")
            .build());

    }
}

    variables:
  settings:
    fn::invoke:
      Function: gcp:logging:getOrganizationSettings
      Arguments:
        organization: my-organization-name

    Using getOrganizationSettings

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOrganizationSettings(args: GetOrganizationSettingsArgs, opts?: InvokeOptions): Promise<GetOrganizationSettingsResult>
function getOrganizationSettingsOutput(args: GetOrganizationSettingsOutputArgs, opts?: InvokeOptions): Output<GetOrganizationSettingsResult>
    def get_organization_settings(organization: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetOrganizationSettingsResult
def get_organization_settings_output(organization: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetOrganizationSettingsResult]
    func LookupOrganizationSettings(ctx *Context, args *LookupOrganizationSettingsArgs, opts ...InvokeOption) (*LookupOrganizationSettingsResult, error)
func LookupOrganizationSettingsOutput(ctx *Context, args *LookupOrganizationSettingsOutputArgs, opts ...InvokeOption) LookupOrganizationSettingsResultOutput

    > Note: This function is named LookupOrganizationSettings in the Go SDK.

    public static class GetOrganizationSettings 
{
    public static Task<GetOrganizationSettingsResult> InvokeAsync(GetOrganizationSettingsArgs args, InvokeOptions? opts = null)
    public static Output<GetOrganizationSettingsResult> Invoke(GetOrganizationSettingsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOrganizationSettingsResult> getOrganizationSettings(GetOrganizationSettingsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: gcp:logging/getOrganizationSettings:getOrganizationSettings
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Organization string
    The ID of the organization for which to retrieve settings.
    Organization string
    The ID of the organization for which to retrieve settings.
    organization String
    The ID of the organization for which to retrieve settings.
    organization string
    The ID of the organization for which to retrieve settings.
    organization str
    The ID of the organization for which to retrieve settings.
    organization String
    The ID of the organization for which to retrieve settings.

    getOrganizationSettings Result

    The following output properties are available:

    DisableDefaultSink bool
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    KmsServiceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    LoggingServiceAccountId string
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    Name string
    The resource name of the settings.
    Organization string
    StorageLocation string
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
    DisableDefaultSink bool
    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    KmsServiceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    LoggingServiceAccountId string
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    Name string
    The resource name of the settings.
    Organization string
    StorageLocation string
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
    disableDefaultSink Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsServiceAccountId String
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    loggingServiceAccountId String
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    name String
    The resource name of the settings.
    organization String
    storageLocation String
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
    disableDefaultSink boolean
    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.
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyName string
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsServiceAccountId string
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    loggingServiceAccountId string
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    name string
    The resource name of the settings.
    organization string
    storageLocation string
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
    disable_default_sink bool
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_name str
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kms_service_account_id str
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    logging_service_account_id str
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    name str
    The resource name of the settings.
    organization str
    storage_location str
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.
    disableDefaultSink Boolean
    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.
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyName String
    The resource name for the configured Cloud KMS key. KMS key name format: 'projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]' To enable CMEK for the bucket, set this field to a valid kmsKeyName for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key. The Cloud KMS key used by the bucket can be updated by changing the kmsKeyName to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked. See Enabling CMEK for Logging Buckets for more information.
    kmsServiceAccountId String
    The service account associated with a project for which CMEK will apply. Before enabling CMEK for a logging bucket, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account associated with the project for which CMEK will apply. See Enabling CMEK for Logging Buckets for more information.
    loggingServiceAccountId String
    The service account for the given container. Sinks use this service account as their writerIdentity if no custom service account is provided.
    name String
    The resource name of the settings.
    organization String
    storageLocation String
    The storage location that Cloud Logging will use to create new resources when a location is needed but not explicitly provided.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v8.9.3 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-gcp