@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
86 lines (85 loc) • 4.45 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DataAwsOpensearchserverlessCollectionConfig extends cdktf.TerraformMetaArguments {
/**
* ID of the collection.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/opensearchserverless_collection#id DataAwsOpensearchserverlessCollection#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;
/**
* Name of the collection.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/opensearchserverless_collection#name DataAwsOpensearchserverlessCollection#name}
*/
readonly name?: string;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the [provider configuration](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#aws-configuration-reference).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/opensearchserverless_collection#region DataAwsOpensearchserverlessCollection#region}
*/
readonly region?: string;
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/opensearchserverless_collection aws_opensearchserverless_collection}
*/
export declare class DataAwsOpensearchserverlessCollection extends cdktf.TerraformDataSource {
static readonly tfResourceType = "aws_opensearchserverless_collection";
/**
* Generates CDKTF code for importing a DataAwsOpensearchserverlessCollection 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 DataAwsOpensearchserverlessCollection to import
* @param importFromId The id of the existing DataAwsOpensearchserverlessCollection that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/data-sources/opensearchserverless_collection#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DataAwsOpensearchserverlessCollection 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/6.25.0/docs/data-sources/opensearchserverless_collection aws_opensearchserverless_collection} 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 DataAwsOpensearchserverlessCollectionConfig = {}
*/
constructor(scope: Construct, id: string, config?: DataAwsOpensearchserverlessCollectionConfig);
get arn(): string;
get collectionEndpoint(): string;
get createdDate(): string;
get dashboardEndpoint(): string;
get description(): string;
get failureCode(): string;
get failureMessage(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
get kmsKeyArn(): string;
get lastModifiedDate(): string;
private _name?;
get name(): string;
set name(value: string);
resetName(): void;
get nameInput(): string | undefined;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
get standbyReplicas(): string;
private _tags;
get tags(): cdktf.StringMap;
get type(): string;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}