@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
271 lines (270 loc) • 13.3 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface DocdbClusterInstanceConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#apply_immediately DocdbClusterInstance#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_instance#auto_minor_version_upgrade DocdbClusterInstance#auto_minor_version_upgrade}
*/
readonly autoMinorVersionUpgrade?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#availability_zone DocdbClusterInstance#availability_zone}
*/
readonly availabilityZone?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#ca_cert_identifier DocdbClusterInstance#ca_cert_identifier}
*/
readonly caCertIdentifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#cluster_identifier DocdbClusterInstance#cluster_identifier}
*/
readonly clusterIdentifier: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#copy_tags_to_snapshot DocdbClusterInstance#copy_tags_to_snapshot}
*/
readonly copyTagsToSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#enable_performance_insights DocdbClusterInstance#enable_performance_insights}
*/
readonly enablePerformanceInsights?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#engine DocdbClusterInstance#engine}
*/
readonly engine?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#id DocdbClusterInstance#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_instance#identifier DocdbClusterInstance#identifier}
*/
readonly identifier?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#identifier_prefix DocdbClusterInstance#identifier_prefix}
*/
readonly identifierPrefix?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#instance_class DocdbClusterInstance#instance_class}
*/
readonly instanceClass: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#performance_insights_kms_key_id DocdbClusterInstance#performance_insights_kms_key_id}
*/
readonly performanceInsightsKmsKeyId?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#preferred_maintenance_window DocdbClusterInstance#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_instance#promotion_tier DocdbClusterInstance#promotion_tier}
*/
readonly promotionTier?: number;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#tags DocdbClusterInstance#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_instance#tags_all DocdbClusterInstance#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
/**
* timeouts block
*
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#timeouts DocdbClusterInstance#timeouts}
*/
readonly timeouts?: DocdbClusterInstanceTimeouts;
}
export interface DocdbClusterInstanceTimeouts {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#create DocdbClusterInstance#create}
*/
readonly create?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#delete DocdbClusterInstance#delete}
*/
readonly delete?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#update DocdbClusterInstance#update}
*/
readonly update?: string;
}
export declare function docdbClusterInstanceTimeoutsToTerraform(struct?: DocdbClusterInstanceTimeouts | cdktf.IResolvable): any;
export declare function docdbClusterInstanceTimeoutsToHclTerraform(struct?: DocdbClusterInstanceTimeouts | cdktf.IResolvable): any;
export declare class DocdbClusterInstanceTimeoutsOutputReference 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(): DocdbClusterInstanceTimeouts | cdktf.IResolvable | undefined;
set internalValue(value: DocdbClusterInstanceTimeouts | 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_instance aws_docdb_cluster_instance}
*/
export declare class DocdbClusterInstance extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_docdb_cluster_instance";
/**
* Generates CDKTF code for importing a DocdbClusterInstance 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 DocdbClusterInstance to import
* @param importFromId The id of the existing DocdbClusterInstance that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/5.84.0/docs/resources/docdb_cluster_instance#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the DocdbClusterInstance 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_instance aws_docdb_cluster_instance} 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 DocdbClusterInstanceConfig
*/
constructor(scope: Construct, id: string, config: DocdbClusterInstanceConfig);
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 _autoMinorVersionUpgrade?;
get autoMinorVersionUpgrade(): boolean | cdktf.IResolvable;
set autoMinorVersionUpgrade(value: boolean | cdktf.IResolvable);
resetAutoMinorVersionUpgrade(): void;
get autoMinorVersionUpgradeInput(): boolean | cdktf.IResolvable | undefined;
private _availabilityZone?;
get availabilityZone(): string;
set availabilityZone(value: string);
resetAvailabilityZone(): void;
get availabilityZoneInput(): string | undefined;
private _caCertIdentifier?;
get caCertIdentifier(): string;
set caCertIdentifier(value: string);
resetCaCertIdentifier(): void;
get caCertIdentifierInput(): string | undefined;
private _clusterIdentifier?;
get clusterIdentifier(): string;
set clusterIdentifier(value: string);
get clusterIdentifierInput(): string | undefined;
private _copyTagsToSnapshot?;
get copyTagsToSnapshot(): boolean | cdktf.IResolvable;
set copyTagsToSnapshot(value: boolean | cdktf.IResolvable);
resetCopyTagsToSnapshot(): void;
get copyTagsToSnapshotInput(): boolean | cdktf.IResolvable | undefined;
get dbSubnetGroupName(): string;
get dbiResourceId(): string;
private _enablePerformanceInsights?;
get enablePerformanceInsights(): boolean | cdktf.IResolvable;
set enablePerformanceInsights(value: boolean | cdktf.IResolvable);
resetEnablePerformanceInsights(): void;
get enablePerformanceInsightsInput(): boolean | cdktf.IResolvable | undefined;
get endpoint(): string;
private _engine?;
get engine(): string;
set engine(value: string);
resetEngine(): void;
get engineInput(): string | undefined;
get engineVersion(): string;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _identifier?;
get identifier(): string;
set identifier(value: string);
resetIdentifier(): void;
get identifierInput(): string | undefined;
private _identifierPrefix?;
get identifierPrefix(): string;
set identifierPrefix(value: string);
resetIdentifierPrefix(): void;
get identifierPrefixInput(): string | undefined;
private _instanceClass?;
get instanceClass(): string;
set instanceClass(value: string);
get instanceClassInput(): string | undefined;
get kmsKeyId(): string;
private _performanceInsightsKmsKeyId?;
get performanceInsightsKmsKeyId(): string;
set performanceInsightsKmsKeyId(value: string);
resetPerformanceInsightsKmsKeyId(): void;
get performanceInsightsKmsKeyIdInput(): string | undefined;
get port(): number;
get preferredBackupWindow(): string;
private _preferredMaintenanceWindow?;
get preferredMaintenanceWindow(): string;
set preferredMaintenanceWindow(value: string);
resetPreferredMaintenanceWindow(): void;
get preferredMaintenanceWindowInput(): string | undefined;
private _promotionTier?;
get promotionTier(): number;
set promotionTier(value: number);
resetPromotionTier(): void;
get promotionTierInput(): number | undefined;
get publiclyAccessible(): cdktf.IResolvable;
get storageEncrypted(): cdktf.IResolvable;
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;
get writer(): cdktf.IResolvable;
private _timeouts;
get timeouts(): DocdbClusterInstanceTimeoutsOutputReference;
putTimeouts(value: DocdbClusterInstanceTimeouts): void;
resetTimeouts(): void;
get timeoutsInput(): cdktf.IResolvable | DocdbClusterInstanceTimeouts | undefined;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}