@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
220 lines (219 loc) • 10.9 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DocdbelasticClusterConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#admin_user_name DocdbelasticCluster#admin_user_name}
*/
readonly adminUserName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#admin_user_password DocdbelasticCluster#admin_user_password}
*/
readonly adminUserPassword: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#auth_type DocdbelasticCluster#auth_type}
*/
readonly authType: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#backup_retention_period DocdbelasticCluster#backup_retention_period}
*/
readonly backupRetentionPeriod?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#kms_key_id DocdbelasticCluster#kms_key_id}
*/
readonly kmsKeyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#name DocdbelasticCluster#name}
*/
readonly name: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#preferred_backup_window DocdbelasticCluster#preferred_backup_window}
*/
readonly preferredBackupWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#preferred_maintenance_window DocdbelasticCluster#preferred_maintenance_window}
*/
readonly preferredMaintenanceWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#shard_capacity DocdbelasticCluster#shard_capacity}
*/
readonly shardCapacity: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#shard_count DocdbelasticCluster#shard_count}
*/
readonly shardCount: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#subnet_ids DocdbelasticCluster#subnet_ids}
*/
readonly subnetIds?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#tags DocdbelasticCluster#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#vpc_security_group_ids DocdbelasticCluster#vpc_security_group_ids}
*/
readonly vpcSecurityGroupIds?: string[];
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#timeouts DocdbelasticCluster#timeouts}
*/
readonly timeouts?: DocdbelasticClusterTimeouts;
}
export interface DocdbelasticClusterTimeouts {
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#create DocdbelasticCluster#create}
*/
readonly create?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#delete DocdbelasticCluster#delete}
*/
readonly delete?: string;
/**
* A string that can be [parsed as a duration](https://pkg.go.dev/time#ParseDuration) consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#update DocdbelasticCluster#update}
*/
readonly update?: string;
}
export declare function docdbelasticClusterTimeoutsToTerraform(struct?: DocdbelasticClusterTimeouts | cdktf.IResolvable): any;
export declare function docdbelasticClusterTimeoutsToHclTerraform(struct?: DocdbelasticClusterTimeouts | cdktf.IResolvable): any;
export declare class DocdbelasticClusterTimeoutsOutputReference 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(): DocdbelasticClusterTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DocdbelasticClusterTimeouts | 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/aws/5.84.0/docs/resources/docdbelastic_cluster aws_docdbelastic_cluster}
*/
export declare class DocdbelasticCluster extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_docdbelastic_cluster";
/**
* Generates CDKTF code for importing a DocdbelasticCluster 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 DocdbelasticCluster to import
* @param importFromId The id of the existing DocdbelasticCluster that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdbelastic_cluster#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DocdbelasticCluster 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/resources/docdbelastic_cluster aws_docdbelastic_cluster} 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 DocdbelasticClusterConfig
*/
constructor(scope: Construct, id: string, config: DocdbelasticClusterConfig);
private _adminUserName?;
get adminUserName(): string;
set adminUserName(value: string);
get adminUserNameInput(): string | undefined;
private _adminUserPassword?;
get adminUserPassword(): string;
set adminUserPassword(value: string);
get adminUserPasswordInput(): string | undefined;
get arn(): string;
private _authType?;
get authType(): string;
set authType(value: string);
get authTypeInput(): string | undefined;
private _backupRetentionPeriod?;
get backupRetentionPeriod(): number;
set backupRetentionPeriod(value: number);
resetBackupRetentionPeriod(): void;
get backupRetentionPeriodInput(): number | undefined;
get endpoint(): string;
get id(): string;
private _kmsKeyId?;
get kmsKeyId(): string;
set kmsKeyId(value: string);
resetKmsKeyId(): void;
get kmsKeyIdInput(): string | undefined;
private _name?;
get name(): string;
set name(value: string);
get nameInput(): string | undefined;
private _preferredBackupWindow?;
get preferredBackupWindow(): string;
set preferredBackupWindow(value: string);
resetPreferredBackupWindow(): void;
get preferredBackupWindowInput(): string | undefined;
private _preferredMaintenanceWindow?;
get preferredMaintenanceWindow(): string;
set preferredMaintenanceWindow(value: string);
resetPreferredMaintenanceWindow(): void;
get preferredMaintenanceWindowInput(): string | undefined;
private _shardCapacity?;
get shardCapacity(): number;
set shardCapacity(value: number);
get shardCapacityInput(): number | undefined;
private _shardCount?;
get shardCount(): number;
set shardCount(value: number);
get shardCountInput(): number | undefined;
private _subnetIds?;
get subnetIds(): string[];
set subnetIds(value: string[]);
resetSubnetIds(): void;
get subnetIdsInput(): string[] | undefined;
private _tags?;
get tags(): {
[key: string]: string;
};
set tags(value: {
[key: string]: string;
});
resetTags(): void;
get tagsInput(): {
[key: string]: string;
} | undefined;
private _tagsAll;
get tagsAll(): cdktf.StringMap;
private _vpcSecurityGroupIds?;
get vpcSecurityGroupIds(): string[];
set vpcSecurityGroupIds(value: string[]);
resetVpcSecurityGroupIds(): void;
get vpcSecurityGroupIdsInput(): string[] | undefined;
private _timeouts;
get timeouts(): DocdbelasticClusterTimeoutsOutputReference;
putTimeouts(value: DocdbelasticClusterTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DocdbelasticClusterTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}