@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
435 lines (434 loc) • 21.5 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DocdbClusterConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#allow_major_version_upgrade DocdbCluster#allow_major_version_upgrade}
*/
readonly allowMajorVersionUpgrade?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#apply_immediately DocdbCluster#apply_immediately}
*/
readonly applyImmediately?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#availability_zones DocdbCluster#availability_zones}
*/
readonly availabilityZones?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#backup_retention_period DocdbCluster#backup_retention_period}
*/
readonly backupRetentionPeriod?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#cluster_identifier DocdbCluster#cluster_identifier}
*/
readonly clusterIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#cluster_identifier_prefix DocdbCluster#cluster_identifier_prefix}
*/
readonly clusterIdentifierPrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#cluster_members DocdbCluster#cluster_members}
*/
readonly clusterMembers?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#db_cluster_parameter_group_name DocdbCluster#db_cluster_parameter_group_name}
*/
readonly dbClusterParameterGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#db_subnet_group_name DocdbCluster#db_subnet_group_name}
*/
readonly dbSubnetGroupName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#deletion_protection DocdbCluster#deletion_protection}
*/
readonly deletionProtection?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#enabled_cloudwatch_logs_exports DocdbCluster#enabled_cloudwatch_logs_exports}
*/
readonly enabledCloudwatchLogsExports?: string[];
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#engine DocdbCluster#engine}
*/
readonly engine?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#engine_version DocdbCluster#engine_version}
*/
readonly engineVersion?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#final_snapshot_identifier DocdbCluster#final_snapshot_identifier}
*/
readonly finalSnapshotIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#global_cluster_identifier DocdbCluster#global_cluster_identifier}
*/
readonly globalClusterIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#id DocdbCluster#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/resources/docdb_cluster#kms_key_id DocdbCluster#kms_key_id}
*/
readonly kmsKeyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#master_password DocdbCluster#master_password}
*/
readonly masterPassword?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#master_username DocdbCluster#master_username}
*/
readonly masterUsername?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#port DocdbCluster#port}
*/
readonly port?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#preferred_backup_window DocdbCluster#preferred_backup_window}
*/
readonly preferredBackupWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#preferred_maintenance_window DocdbCluster#preferred_maintenance_window}
*/
readonly preferredMaintenanceWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#skip_final_snapshot DocdbCluster#skip_final_snapshot}
*/
readonly skipFinalSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#snapshot_identifier DocdbCluster#snapshot_identifier}
*/
readonly snapshotIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#storage_encrypted DocdbCluster#storage_encrypted}
*/
readonly storageEncrypted?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#storage_type DocdbCluster#storage_type}
*/
readonly storageType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#tags DocdbCluster#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#tags_all DocdbCluster#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#vpc_security_group_ids DocdbCluster#vpc_security_group_ids}
*/
readonly vpcSecurityGroupIds?: string[];
/**
* restore_to_point_in_time block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#restore_to_point_in_time DocdbCluster#restore_to_point_in_time}
*/
readonly restoreToPointInTime?: DocdbClusterRestoreToPointInTime;
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#timeouts DocdbCluster#timeouts}
*/
readonly timeouts?: DocdbClusterTimeouts;
}
export interface DocdbClusterRestoreToPointInTime {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#restore_to_time DocdbCluster#restore_to_time}
*/
readonly restoreToTime?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#restore_type DocdbCluster#restore_type}
*/
readonly restoreType?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#source_cluster_identifier DocdbCluster#source_cluster_identifier}
*/
readonly sourceClusterIdentifier: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#use_latest_restorable_time DocdbCluster#use_latest_restorable_time}
*/
readonly useLatestRestorableTime?: boolean | cdktf.IResolvable;
}
export declare function docdbClusterRestoreToPointInTimeToTerraform(struct?: DocdbClusterRestoreToPointInTimeOutputReference | DocdbClusterRestoreToPointInTime): any;
export declare function docdbClusterRestoreToPointInTimeToHclTerraform(struct?: DocdbClusterRestoreToPointInTimeOutputReference | DocdbClusterRestoreToPointInTime): any;
export declare class DocdbClusterRestoreToPointInTimeOutputReference 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(): DocdbClusterRestoreToPointInTime | undefined;
set internalValue(value: DocdbClusterRestoreToPointInTime | undefined);
private _restoreToTime?;
get restoreToTime(): string;
set restoreToTime(value: string);
resetRestoreToTime(): void;
get restoreToTimeInput(): string | undefined;
private _restoreType?;
get restoreType(): string;
set restoreType(value: string);
resetRestoreType(): void;
get restoreTypeInput(): string | undefined;
private _sourceClusterIdentifier?;
get sourceClusterIdentifier(): string;
set sourceClusterIdentifier(value: string);
get sourceClusterIdentifierInput(): string | undefined;
private _useLatestRestorableTime?;
get useLatestRestorableTime(): boolean | cdktf.IResolvable;
set useLatestRestorableTime(value: boolean | cdktf.IResolvable);
resetUseLatestRestorableTime(): void;
get useLatestRestorableTimeInput(): boolean | cdktf.IResolvable | undefined;
}
export interface DocdbClusterTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#create DocdbCluster#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#delete DocdbCluster#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#update DocdbCluster#update}
*/
readonly update?: string;
}
export declare function docdbClusterTimeoutsToTerraform(struct?: DocdbClusterTimeouts | cdktf.IResolvable): any;
export declare function docdbClusterTimeoutsToHclTerraform(struct?: DocdbClusterTimeouts | cdktf.IResolvable): any;
export declare class DocdbClusterTimeoutsOutputReference 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(): DocdbClusterTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DocdbClusterTimeouts | 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/docdb_cluster aws_docdb_cluster}
*/
export declare class DocdbCluster extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_docdb_cluster";
/**
* Generates CDKTF code for importing a DocdbCluster 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 DocdbCluster to import
* @param importFromId The id of the existing DocdbCluster that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DocdbCluster 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/docdb_cluster aws_docdb_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 DocdbClusterConfig = {}
*/
constructor(scope: Construct, id: string, config?: DocdbClusterConfig);
private _allowMajorVersionUpgrade?;
get allowMajorVersionUpgrade(): boolean | cdktf.IResolvable;
set allowMajorVersionUpgrade(value: boolean | cdktf.IResolvable);
resetAllowMajorVersionUpgrade(): void;
get allowMajorVersionUpgradeInput(): boolean | cdktf.IResolvable | undefined;
private _applyImmediately?;
get applyImmediately(): boolean | cdktf.IResolvable;
set applyImmediately(value: boolean | cdktf.IResolvable);
resetApplyImmediately(): void;
get applyImmediatelyInput(): boolean | cdktf.IResolvable | undefined;
get arn(): string;
private _availabilityZones?;
get availabilityZones(): string[];
set availabilityZones(value: string[]);
resetAvailabilityZones(): void;
get availabilityZonesInput(): string[] | undefined;
private _backupRetentionPeriod?;
get backupRetentionPeriod(): number;
set backupRetentionPeriod(value: number);
resetBackupRetentionPeriod(): void;
get backupRetentionPeriodInput(): number | undefined;
private _clusterIdentifier?;
get clusterIdentifier(): string;
set clusterIdentifier(value: string);
resetClusterIdentifier(): void;
get clusterIdentifierInput(): string | undefined;
private _clusterIdentifierPrefix?;
get clusterIdentifierPrefix(): string;
set clusterIdentifierPrefix(value: string);
resetClusterIdentifierPrefix(): void;
get clusterIdentifierPrefixInput(): string | undefined;
private _clusterMembers?;
get clusterMembers(): string[];
set clusterMembers(value: string[]);
resetClusterMembers(): void;
get clusterMembersInput(): string[] | undefined;
get clusterResourceId(): string;
private _dbClusterParameterGroupName?;
get dbClusterParameterGroupName(): string;
set dbClusterParameterGroupName(value: string);
resetDbClusterParameterGroupName(): void;
get dbClusterParameterGroupNameInput(): string | undefined;
private _dbSubnetGroupName?;
get dbSubnetGroupName(): string;
set dbSubnetGroupName(value: string);
resetDbSubnetGroupName(): void;
get dbSubnetGroupNameInput(): string | undefined;
private _deletionProtection?;
get deletionProtection(): boolean | cdktf.IResolvable;
set deletionProtection(value: boolean | cdktf.IResolvable);
resetDeletionProtection(): void;
get deletionProtectionInput(): boolean | cdktf.IResolvable | undefined;
private _enabledCloudwatchLogsExports?;
get enabledCloudwatchLogsExports(): string[];
set enabledCloudwatchLogsExports(value: string[]);
resetEnabledCloudwatchLogsExports(): void;
get enabledCloudwatchLogsExportsInput(): string[] | undefined;
get endpoint(): string;
private _engine?;
get engine(): string;
set engine(value: string);
resetEngine(): void;
get engineInput(): string | undefined;
private _engineVersion?;
get engineVersion(): string;
set engineVersion(value: string);
resetEngineVersion(): void;
get engineVersionInput(): string | undefined;
private _finalSnapshotIdentifier?;
get finalSnapshotIdentifier(): string;
set finalSnapshotIdentifier(value: string);
resetFinalSnapshotIdentifier(): void;
get finalSnapshotIdentifierInput(): string | undefined;
private _globalClusterIdentifier?;
get globalClusterIdentifier(): string;
set globalClusterIdentifier(value: string);
resetGlobalClusterIdentifier(): void;
get globalClusterIdentifierInput(): string | undefined;
get hostedZoneId(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _kmsKeyId?;
get kmsKeyId(): string;
set kmsKeyId(value: string);
resetKmsKeyId(): void;
get kmsKeyIdInput(): string | undefined;
private _masterPassword?;
get masterPassword(): string;
set masterPassword(value: string);
resetMasterPassword(): void;
get masterPasswordInput(): string | undefined;
private _masterUsername?;
get masterUsername(): string;
set masterUsername(value: string);
resetMasterUsername(): void;
get masterUsernameInput(): string | undefined;
private _port?;
get port(): number;
set port(value: number);
resetPort(): void;
get portInput(): number | 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;
get readerEndpoint(): string;
private _skipFinalSnapshot?;
get skipFinalSnapshot(): boolean | cdktf.IResolvable;
set skipFinalSnapshot(value: boolean | cdktf.IResolvable);
resetSkipFinalSnapshot(): void;
get skipFinalSnapshotInput(): boolean | cdktf.IResolvable | undefined;
private _snapshotIdentifier?;
get snapshotIdentifier(): string;
set snapshotIdentifier(value: string);
resetSnapshotIdentifier(): void;
get snapshotIdentifierInput(): string | undefined;
private _storageEncrypted?;
get storageEncrypted(): boolean | cdktf.IResolvable;
set storageEncrypted(value: boolean | cdktf.IResolvable);
resetStorageEncrypted(): void;
get storageEncryptedInput(): boolean | cdktf.IResolvable | undefined;
private _storageType?;
get storageType(): string;
set storageType(value: string);
resetStorageType(): void;
get storageTypeInput(): 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(): {
[key: string]: string;
};
set tagsAll(value: {
[key: string]: string;
});
resetTagsAll(): void;
get tagsAllInput(): {
[key: string]: string;
} | undefined;
private _vpcSecurityGroupIds?;
get vpcSecurityGroupIds(): string[];
set vpcSecurityGroupIds(value: string[]);
resetVpcSecurityGroupIds(): void;
get vpcSecurityGroupIdsInput(): string[] | undefined;
private _restoreToPointInTime;
get restoreToPointInTime(): DocdbClusterRestoreToPointInTimeOutputReference;
putRestoreToPointInTime(value: DocdbClusterRestoreToPointInTime): void;
resetRestoreToPointInTime(): void;
get restoreToPointInTimeInput(): DocdbClusterRestoreToPointInTime | undefined;
private _timeouts;
get timeouts(): DocdbClusterTimeoutsOutputReference;
putTimeouts(value: DocdbClusterTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DocdbClusterTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}