@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
186 lines (185 loc) • 8.35 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataplexGlossaryConfig extends cdktf.TerraformMetaArguments {
/**
* The user-mutable description of the glossary.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#description DataplexGlossary#description}
*/
readonly description?: string;
/**
* User friendly display name of the glossary. This is user-mutable. This will be same as the glossaryId, if not specified.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#display_name DataplexGlossary#display_name}
*/
readonly displayName?: string;
/**
* The glossary id for creation.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#glossary_id DataplexGlossary#glossary_id}
*/
readonly glossaryId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#id DataplexGlossary#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;
/**
* User-defined labels for the Glossary.
*
*
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field 'effective_labels' for all of the labels present on the resource.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#labels DataplexGlossary#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* The location where the glossary should reside.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#location DataplexGlossary#location}
*/
readonly location: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#project DataplexGlossary#project}
*/
readonly project?: string;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#timeouts DataplexGlossary#timeouts}
*/
readonly timeouts?: DataplexGlossaryTimeouts;
}
export interface DataplexGlossaryTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#create DataplexGlossary#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#delete DataplexGlossary#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#update DataplexGlossary#update}
*/
readonly update?: string;
}
export declare function dataplexGlossaryTimeoutsToTerraform(struct?: DataplexGlossaryTimeouts | cdktf.IResolvable): any;
export declare function dataplexGlossaryTimeoutsToHclTerraform(struct?: DataplexGlossaryTimeouts | cdktf.IResolvable): any;
export declare class DataplexGlossaryTimeoutsOutputReference 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(): DataplexGlossaryTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DataplexGlossaryTimeouts | 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.36.1/docs/resources/dataplex_glossary google_dataplex_glossary}
*/
export declare class DataplexGlossary extends cdktf.TerraformResource {
static readonly tfResourceType = "google_dataplex_glossary";
/**
* Generates CDKTF code for importing a DataplexGlossary 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 DataplexGlossary to import
* @param importFromId The id of the existing DataplexGlossary that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.36.1/docs/resources/dataplex_glossary#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataplexGlossary 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.36.1/docs/resources/dataplex_glossary google_dataplex_glossary} 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 DataplexGlossaryConfig
*/
constructor(scope: Construct, id: string, config: DataplexGlossaryConfig);
get categoryCount(): number;
get createTime(): string;
private _description?;
get description(): string;
set description(value: string);
resetDescription(): void;
get descriptionInput(): string | undefined;
private _displayName?;
get displayName(): string;
set displayName(value: string);
resetDisplayName(): void;
get displayNameInput(): string | undefined;
private _effectiveLabels;
get effectiveLabels(): cdktf.StringMap;
private _glossaryId?;
get glossaryId(): string;
set glossaryId(value: string);
get glossaryIdInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _labels?;
get labels(): {
[key: string]: string;
};
set labels(value: {
[key: string]: string;
});
resetLabels(): void;
get labelsInput(): {
[key: string]: string;
} | undefined;
private _location?;
get location(): string;
set location(value: string);
get locationInput(): string | undefined;
get name(): string;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
get termCount(): number;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
get uid(): string;
get updateTime(): string;
private _timeouts;
get timeouts(): DataplexGlossaryTimeoutsOutputReference;
putTimeouts(value: DataplexGlossaryTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DataplexGlossaryTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}