@cdktf/provider-google
Version:
Prebuilt google Provider for Terraform CDK (cdktf)
295 lines (294 loc) • 13.8 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataplexLakeConfig extends cdktf.TerraformMetaArguments {
/**
* Optional. Description of the lake.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#description DataplexLake#description}
*/
readonly description?: string;
/**
* Optional. User friendly display name.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#display_name DataplexLake#display_name}
*/
readonly displayName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#id DataplexLake#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;
/**
* Optional. User-defined labels for the lake.
*
* **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.13.0/docs/resources/dataplex_lake#labels DataplexLake#labels}
*/
readonly labels?: {
[key: string]: string;
};
/**
* The location for the resource
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#location DataplexLake#location}
*/
readonly location: string;
/**
* The name of the lake.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#name DataplexLake#name}
*/
readonly name: string;
/**
* The project for the resource
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#project DataplexLake#project}
*/
readonly project?: string;
/**
* metastore block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#metastore DataplexLake#metastore}
*/
readonly metastore?: DataplexLakeMetastore;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#timeouts DataplexLake#timeouts}
*/
readonly timeouts?: DataplexLakeTimeouts;
}
export interface DataplexLakeAssetStatus {
}
export declare function dataplexLakeAssetStatusToTerraform(struct?: DataplexLakeAssetStatus): any;
export declare function dataplexLakeAssetStatusToHclTerraform(struct?: DataplexLakeAssetStatus): any;
export declare class DataplexLakeAssetStatusOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): DataplexLakeAssetStatus | undefined;
set internalValue(value: DataplexLakeAssetStatus | undefined);
get activeAssets(): number;
get securityPolicyApplyingAssets(): number;
get updateTime(): string;
}
export declare class DataplexLakeAssetStatusList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): DataplexLakeAssetStatusOutputReference;
}
export interface DataplexLakeMetastoreStatus {
}
export declare function dataplexLakeMetastoreStatusToTerraform(struct?: DataplexLakeMetastoreStatus): any;
export declare function dataplexLakeMetastoreStatusToHclTerraform(struct?: DataplexLakeMetastoreStatus): any;
export declare class DataplexLakeMetastoreStatusOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param complexObjectIndex the index of this item in the list
* @param complexObjectIsFromSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, complexObjectIndex: number, complexObjectIsFromSet: boolean);
get internalValue(): DataplexLakeMetastoreStatus | undefined;
set internalValue(value: DataplexLakeMetastoreStatus | undefined);
get endpoint(): string;
get message(): string;
get state(): string;
get updateTime(): string;
}
export declare class DataplexLakeMetastoreStatusList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
/**
* @param terraformResource The parent resource
* @param terraformAttribute The attribute on the parent resource this class is referencing
* @param wrapsSet whether the list is wrapping a set (will add tolist() to be able to access an item via an index)
*/
constructor(terraformResource: cdktf.IInterpolatingParent, terraformAttribute: string, wrapsSet: boolean);
/**
* @param index the index of the item to return
*/
get(index: number): DataplexLakeMetastoreStatusOutputReference;
}
export interface DataplexLakeMetastore {
/**
* Optional. A relative reference to the Dataproc Metastore (https://cloud.google.com/dataproc-metastore/docs) service associated with the lake: `projects/{project_id}/locations/{location_id}/services/{service_id}`
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#service DataplexLake#service}
*/
readonly service?: string;
}
export declare function dataplexLakeMetastoreToTerraform(struct?: DataplexLakeMetastoreOutputReference | DataplexLakeMetastore): any;
export declare function dataplexLakeMetastoreToHclTerraform(struct?: DataplexLakeMetastoreOutputReference | DataplexLakeMetastore): any;
export declare class DataplexLakeMetastoreOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
/**
* @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(): DataplexLakeMetastore | undefined;
set internalValue(value: DataplexLakeMetastore | undefined);
private _service?;
get service(): string;
set service(value: string);
resetService(): void;
get serviceInput(): string | undefined;
}
export interface DataplexLakeTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#create DataplexLake#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#delete DataplexLake#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#update DataplexLake#update}
*/
readonly update?: string;
}
export declare function dataplexLakeTimeoutsToTerraform(struct?: DataplexLakeTimeouts | cdktf.IResolvable): any;
export declare function dataplexLakeTimeoutsToHclTerraform(struct?: DataplexLakeTimeouts | cdktf.IResolvable): any;
export declare class DataplexLakeTimeoutsOutputReference 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(): DataplexLakeTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DataplexLakeTimeouts | 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/dataplex_lake google_dataplex_lake}
*/
export declare class DataplexLake extends cdktf.TerraformResource {
static readonly tfResourceType = "google_dataplex_lake";
/**
* Generates CDKTF code for importing a DataplexLake 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 DataplexLake to import
* @param importFromId The id of the existing DataplexLake that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/google/6.13.0/docs/resources/dataplex_lake#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataplexLake 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/dataplex_lake google_dataplex_lake} 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 DataplexLakeConfig
*/
constructor(scope: Construct, id: string, config: DataplexLakeConfig);
private _assetStatus;
get assetStatus(): DataplexLakeAssetStatusList;
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 _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;
private _metastoreStatus;
get metastoreStatus(): DataplexLakeMetastoreStatusList;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _project?;
get project(): string;
set project(value: string);
resetProject(): void;
get projectInput(): string | undefined;
get serviceAccount(): string;
get state(): string;
private _terraformLabels;
get terraformLabels(): cdktf.StringMap;
get uid(): string;
get updateTime(): string;
private _metastore;
get metastore(): DataplexLakeMetastoreOutputReference;
putMetastore(value: DataplexLakeMetastore): void;
resetMetastore(): void;
get metastoreInput(): DataplexLakeMetastore | undefined;
private _timeouts;
get timeouts(): DataplexLakeTimeoutsOutputReference;
putTimeouts(value: DataplexLakeTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DataplexLakeTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}