OrganizationBucketConfig

Manages a organization-level logging bucket config. For more information see the official logging documentation and Storing Logs.

Note: Logging buckets are automatically created for a given folder, project, organization, billingAccount and cannot be deleted. Creating a resource of this type will acquire and update the resource that already exists at the desired location. These buckets cannot be removed so deleting this resource will remove the bucket config from your state but will leave the logging bucket unchanged. The buckets that are currently automatically created are “_Default” and “_Required”.

Create a OrganizationBucketConfig Resource

new OrganizationBucketConfig(name: string, args: OrganizationBucketConfigArgs, opts?: CustomResourceOptions);

def OrganizationBucketConfig(resource_name, opts=None, bucket_id=None, description=None, location=None, organization=None, retention_days=None, __props__=None);

func NewOrganizationBucketConfig(ctx *Context, name string, args OrganizationBucketConfigArgs, opts ...ResourceOption) (*OrganizationBucketConfig, error)

public OrganizationBucketConfig(string name, OrganizationBucketConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OrganizationBucketConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args OrganizationBucketConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OrganizationBucketConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

OrganizationBucketConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OrganizationBucketConfig resource accepts the following input properties:

BucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
Location string: The location of the bucket. The supported locations are: “global” “us-central1”
Organization string: The parent resource that contains the logging bucket.
Description string: Describes this bucket.
RetentionDays int: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

BucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
Location string: The location of the bucket. The supported locations are: “global” “us-central1”
Organization string: The parent resource that contains the logging bucket.
Description string: Describes this bucket.
RetentionDays int: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

bucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
location string: The location of the bucket. The supported locations are: “global” “us-central1”
organization string: The parent resource that contains the logging bucket.
description string: Describes this bucket.
retentionDays number: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

bucket_id str: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
location str: The location of the bucket. The supported locations are: “global” “us-central1”
organization str: The parent resource that contains the logging bucket.
description str: Describes this bucket.
retention_days float: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

Outputs

All input properties are implicitly available as output properties. Additionally, the OrganizationBucketConfig resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
LifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
Name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”

Id string: The provider-assigned unique ID for this managed resource.
LifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
Name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”

id string: The provider-assigned unique ID for this managed resource.
lifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”

id str: The provider-assigned unique ID for this managed resource.
lifecycle_state str: The bucket’s lifecycle such as active or deleted. See LifecycleState.
name str: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”

Look up an Existing OrganizationBucketConfig Resource

Get an existing OrganizationBucketConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OrganizationBucketConfigState, opts?: CustomResourceOptions): OrganizationBucketConfig

static get(resource_name, id, opts=None, bucket_id=None, description=None, lifecycle_state=None, location=None, name=None, organization=None, retention_days=None, __props__=None);

func GetOrganizationBucketConfig(ctx *Context, name string, id IDInput, state *OrganizationBucketConfigState, opts ...ResourceOption) (*OrganizationBucketConfig, error)

public static OrganizationBucketConfig Get(string name, Input<string> id, OrganizationBucketConfigState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

BucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
Description string: Describes this bucket.
LifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
Location string: The location of the bucket. The supported locations are: “global” “us-central1”
Name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”
Organization string: The parent resource that contains the logging bucket.
RetentionDays int: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

BucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
Description string: Describes this bucket.
LifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
Location string: The location of the bucket. The supported locations are: “global” “us-central1”
Name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”
Organization string: The parent resource that contains the logging bucket.
RetentionDays int: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

bucketId string: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
description string: Describes this bucket.
lifecycleState string: The bucket’s lifecycle such as active or deleted. See LifecycleState.
location string: The location of the bucket. The supported locations are: “global” “us-central1”
name string: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”
organization string: The parent resource that contains the logging bucket.
retentionDays number: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

bucket_id str: The name of the logging bucket. Logging automatically creates two log buckets: _Required and _Default.
description str: Describes this bucket.
lifecycle_state str: The bucket’s lifecycle such as active or deleted. See LifecycleState.
location str: The location of the bucket. The supported locations are: “global” “us-central1”
name str: The resource name of the bucket. For example: “organizations/my-organization-id/locations/my-location/buckets/my-bucket-id”
organization str: The parent resource that contains the logging bucket.
retention_days float: Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud