@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
128 lines (127 loc) • 6.27 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataAwsDbInstancesConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances#id DataAwsDbInstances#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/aws/5.84.0/docs/data-sources/db_instances#tags DataAwsDbInstances#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* filter block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances#filter DataAwsDbInstances#filter}
*/
readonly filter?: DataAwsDbInstancesFilter[] | cdktf.IResolvable;
}
export interface DataAwsDbInstancesFilter {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances#name DataAwsDbInstances#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances#values DataAwsDbInstances#values}
*/
readonly values: string[];
}
export declare function dataAwsDbInstancesFilterToTerraform(struct?: DataAwsDbInstancesFilter | cdktf.IResolvable): any;
export declare function dataAwsDbInstancesFilterToHclTerraform(struct?: DataAwsDbInstancesFilter | cdktf.IResolvable): any;
export declare class DataAwsDbInstancesFilterOutputReference extends cdktf.ComplexObject {
private isEmptyObject;
private resolvableValue?;
/**
* @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(): DataAwsDbInstancesFilter | cdktf.IResolvable | undefined;
set internalValue(value: DataAwsDbInstancesFilter | cdktf.IResolvable | undefined);
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _values?;
get values(): string[];
set values(value: string[]);
get valuesInput(): string[] | undefined;
}
export declare class DataAwsDbInstancesFilterList extends cdktf.ComplexList {
protected terraformResource: cdktf.IInterpolatingParent;
protected terraformAttribute: string;
protected wrapsSet: boolean;
internalValue?: DataAwsDbInstancesFilter[] | cdktf.IResolvable;
/**
* @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): DataAwsDbInstancesFilterOutputReference;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances aws_db_instances}
*/
export declare class DataAwsDbInstances extends cdktf.TerraformDataSource {
static readonly tfResourceType = "aws_db_instances";
/**
* Generates CDKTF code for importing a DataAwsDbInstances 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 DataAwsDbInstances to import
* @param importFromId The id of the existing DataAwsDbInstances that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/data-sources/db_instances#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataAwsDbInstances 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/aws/5.84.0/docs/data-sources/db_instances aws_db_instances} Data Source
*
* @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 DataAwsDbInstancesConfig = {}
*/
constructor(scope: Construct, id: string, config?: DataAwsDbInstancesConfig);
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get instanceArns(): string[];
get instanceIdentifiers(): string[];
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _filter;
get filter(): DataAwsDbInstancesFilterList;
putFilter(value: DataAwsDbInstancesFilter[] | cdktf.IResolvable): void;
resetFilter(): void;
get filterInput(): cdktf.IResolvable | DataAwsDbInstancesFilter[] | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}