GCPolicy

Creates a Google Cloud Bigtable GC Policy inside a family. For more information see the official documentation and API.

Create a GCPolicy Resource

new GCPolicy(name: string, args: GCPolicyArgs, opts?: CustomResourceOptions);

def GCPolicy(resource_name, opts=None, column_family=None, instance_name=None, max_ages=None, max_versions=None, mode=None, project=None, table=None, __props__=None);

func NewGCPolicy(ctx *Context, name string, args GCPolicyArgs, opts ...ResourceOption) (*GCPolicy, error)

public GCPolicy(string name, GCPolicyArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args GCPolicyArgs: 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 GCPolicyArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

GCPolicy Resource Properties

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

Inputs

The GCPolicy resource accepts the following input properties:

ColumnFamily string: The name of the column family.
InstanceName string: The name of the Bigtable instance.
Table string: The name of the table.
MaxAges List<GCPolicyMaxAgeArgs>: GC policy that applies to all cells older than the given age.
MaxVersions List<GCPolicyMaxVersionArgs>: GC policy that applies to all versions of a cell except for the most recent.
Mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

ColumnFamily string: The name of the column family.
InstanceName string: The name of the Bigtable instance.
Table string: The name of the table.
MaxAges []GCPolicyMaxAge: GC policy that applies to all cells older than the given age.
MaxVersions []GCPolicyMaxVersion: GC policy that applies to all versions of a cell except for the most recent.
Mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

columnFamily string: The name of the column family.
instanceName string: The name of the Bigtable instance.
table string: The name of the table.
maxAges GCPolicyMaxAge[]: GC policy that applies to all cells older than the given age.
maxVersions GCPolicyMaxVersion[]: GC policy that applies to all versions of a cell except for the most recent.
mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

column_family str: The name of the column family.
instance_name str: The name of the Bigtable instance.
table str: The name of the table.
max_ages List[GCPolicyMaxAge]: GC policy that applies to all cells older than the given age.
max_versions List[GCPolicyMaxVersion]: GC policy that applies to all versions of a cell except for the most recent.
mode str: If multiple policies are set, you should choose between UNION OR INTERSECTION.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing GCPolicy Resource

Get an existing GCPolicy 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?: GCPolicyState, opts?: CustomResourceOptions): GCPolicy

static get(resource_name, id, opts=None, column_family=None, instance_name=None, max_ages=None, max_versions=None, mode=None, project=None, table=None, __props__=None);

func GetGCPolicy(ctx *Context, name string, id IDInput, state *GCPolicyState, opts ...ResourceOption) (*GCPolicy, error)

public static GCPolicy Get(string name, Input<string> id, GCPolicyState? 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:

ColumnFamily string: The name of the column family.
InstanceName string: The name of the Bigtable instance.
MaxAges List<GCPolicyMaxAgeArgs>: GC policy that applies to all cells older than the given age.
MaxVersions List<GCPolicyMaxVersionArgs>: GC policy that applies to all versions of a cell except for the most recent.
Mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Table string: The name of the table.

ColumnFamily string: The name of the column family.
InstanceName string: The name of the Bigtable instance.
MaxAges []GCPolicyMaxAge: GC policy that applies to all cells older than the given age.
MaxVersions []GCPolicyMaxVersion: GC policy that applies to all versions of a cell except for the most recent.
Mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Table string: The name of the table.

columnFamily string: The name of the column family.
instanceName string: The name of the Bigtable instance.
maxAges GCPolicyMaxAge[]: GC policy that applies to all cells older than the given age.
maxVersions GCPolicyMaxVersion[]: GC policy that applies to all versions of a cell except for the most recent.
mode string: If multiple policies are set, you should choose between UNION OR INTERSECTION.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
table string: The name of the table.

column_family str: The name of the column family.
instance_name str: The name of the Bigtable instance.
max_ages List[GCPolicyMaxAge]: GC policy that applies to all cells older than the given age.
max_versions List[GCPolicyMaxVersion]: GC policy that applies to all versions of a cell except for the most recent.
mode str: If multiple policies are set, you should choose between UNION OR INTERSECTION.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
table str: The name of the table.

Supporting Types

GCPolicyMaxAge

See the input and output API doc for this type.

Days int: Number of days before applying GC policy.

Days int: Number of days before applying GC policy.

days number: Number of days before applying GC policy.

days float: Number of days before applying GC policy.

GCPolicyMaxVersion

See the input and output API doc for this type.

Number int: Number of version before applying the GC policy.

Number int: Number of version before applying the GC policy.

number number: Number of version before applying the GC policy.

number float: Number of version before applying the GC policy.

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