@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
162 lines (161 loc) • 8.03 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataCatalogTaxonomyConfig extends cdktf.TerraformMetaArguments {
/**
* A list of policy types that are activated for this taxonomy. If not set,
* defaults to an empty list. Possible values: ["POLICY_TYPE_UNSPECIFIED", "FINE_GRAINED_ACCESS_CONTROL"]
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#activated_policy_types DataCatalogTaxonomy#activated_policy_types}
*/
readonly activatedPolicyTypes?: string[];
/**
* Description of this taxonomy. It must: contain only unicode characters,
* tabs, newlines, carriage returns and page breaks; and be at most 2000 bytes
* long when encoded in UTF-8. If not set, defaults to an empty description.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#description DataCatalogTaxonomy#description}
*/
readonly description?: string;
/**
* User defined name of this taxonomy.
* The taxonomy display name must be unique within an organization.
* It must: contain only unicode letters, numbers, underscores, dashes
* and spaces; not start or end with spaces; and be at most 200 bytes
* long when encoded in UTF-8.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#display_name DataCatalogTaxonomy#display_name}
*/
readonly displayName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#id DataCatalogTaxonomy#id}
*
* Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
* If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
*/
readonly id?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#project DataCatalogTaxonomy#project}
*/
readonly project?: string;
/**
* Taxonomy location region.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#region DataCatalogTaxonomy#region}
*/
readonly region?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#timeouts DataCatalogTaxonomy#timeouts}
*/
readonly timeouts?: DataCatalogTaxonomyTimeouts;
}
export interface DataCatalogTaxonomyTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#create DataCatalogTaxonomy#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#delete DataCatalogTaxonomy#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#update DataCatalogTaxonomy#update}
*/
readonly update?: string;
}
export declare function dataCatalogTaxonomyTimeoutsToTerraform(struct?: DataCatalogTaxonomyTimeouts | cdktf.IResolvable): any;
export declare function dataCatalogTaxonomyTimeoutsToHclTerraform(struct?: DataCatalogTaxonomyTimeouts | cdktf.IResolvable): any;
export declare class DataCatalogTaxonomyTimeoutsOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string);
get internalValue(): DataCatalogTaxonomyTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DataCatalogTaxonomyTimeouts | cdktf.IResolvable | undefined);
private _create?;
get create(): string;
set create(value: string);
resetCreate(): void;
get createInput(): string | undefined;
private _delete?;
get delete(): string;
set delete(value: string);
resetDelete(): void;
get deleteInput(): string | undefined;
private _update?;
get update(): string;
set update(value: string);
resetUpdate(): void;
get updateInput(): string | undefined;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy google_data_catalog_taxonomy}
*/
export declare class DataCatalogTaxonomy extends cdktf.TerraformResource {
static readonly tfResourceType = "google_data_catalog_taxonomy";
/**
* Generates CDKTF code for importing a DataCatalogTaxonomy resource upon running "cdktf plan <stack-name>"
* @param scope The scope in which to define this construct
* @param importToId The construct id used in the generated config for the DataCatalogTaxonomy to import
* @param importFromId The id of the existing DataCatalogTaxonomy that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataCatalogTaxonomy to import is found
*/
static generateConfigForImport(scope: Construct, importToId: string, importFromId: string, provider?: cdktf.TerraformProvider): cdktf.ImportableResource;
/**
* Create a new {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/data_catalog_taxonomy google_data_catalog_taxonomy} Resource
*
* @param scope The scope in which to define this construct
* @param id The scoped construct ID. Must be unique amongst siblings in the same scope
* @param options DataCatalogTaxonomyConfig
*/
constructor(scope: Construct, id: string, config: DataCatalogTaxonomyConfig);
private _activatedPolicyTypes?;
get activatedPolicyTypes(): string[];
set activatedPolicyTypes(value: string[]);
resetActivatedPolicyTypes(): void;
get activatedPolicyTypesInput(): string[] | undefined;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
get displayNameInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get name(): string;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _timeouts;
get timeouts(): DataCatalogTaxonomyTimeoutsOutputReference;
putTimeouts(value: DataCatalogTaxonomyTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DataCatalogTaxonomyTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}