@cdktf/provider-aws
Version:
Prebuilt aws Provider for Terraform CDK (cdktf)
226 lines (225 loc) • 11.1 kB
TypeScript
/**
* Copyright (c) HashiCorp, Inc.
* SPDX-License-Identifier: MPL-2.0
*/
import { Construct } from 'constructs';
import * as cdktf from 'cdktf';
export interface LightsailDatabaseConfig extends cdktf.TerraformMetaArguments {
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#apply_immediately LightsailDatabase#apply_immediately}
*/
readonly applyImmediately?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#availability_zone LightsailDatabase#availability_zone}
*/
readonly availabilityZone?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#backup_retention_enabled LightsailDatabase#backup_retention_enabled}
*/
readonly backupRetentionEnabled?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#blueprint_id LightsailDatabase#blueprint_id}
*/
readonly blueprintId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#bundle_id LightsailDatabase#bundle_id}
*/
readonly bundleId: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#final_snapshot_name LightsailDatabase#final_snapshot_name}
*/
readonly finalSnapshotName?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#id LightsailDatabase#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/6.25.0/docs/resources/lightsail_database#master_database_name LightsailDatabase#master_database_name}
*/
readonly masterDatabaseName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#master_password LightsailDatabase#master_password}
*/
readonly masterPassword: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#master_username LightsailDatabase#master_username}
*/
readonly masterUsername: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#preferred_backup_window LightsailDatabase#preferred_backup_window}
*/
readonly preferredBackupWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#preferred_maintenance_window LightsailDatabase#preferred_maintenance_window}
*/
readonly preferredMaintenanceWindow?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#publicly_accessible LightsailDatabase#publicly_accessible}
*/
readonly publiclyAccessible?: boolean | cdktf.IResolvable;
/**
* 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/resources/lightsail_database#region LightsailDatabase#region}
*/
readonly region?: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#relational_database_name LightsailDatabase#relational_database_name}
*/
readonly relationalDatabaseName: string;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#skip_final_snapshot LightsailDatabase#skip_final_snapshot}
*/
readonly skipFinalSnapshot?: boolean | cdktf.IResolvable;
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#tags LightsailDatabase#tags}
*/
readonly tags?: {
[key: string]: string;
};
/**
* Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#tags_all LightsailDatabase#tags_all}
*/
readonly tagsAll?: {
[key: string]: string;
};
}
/**
* Represents a {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database aws_lightsail_database}
*/
export declare class LightsailDatabase extends cdktf.TerraformResource {
static readonly tfResourceType = "aws_lightsail_database";
/**
* Generates CDKTF code for importing a LightsailDatabase 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 LightsailDatabase to import
* @param importFromId The id of the existing LightsailDatabase that should be imported. Refer to the {@link https://registry.terraform.io/providers/hashicorp/aws/6.25.0/docs/resources/lightsail_database#import import section} in the documentation of this resource for the id to use
* @param provider? Optional instance of the provider where the LightsailDatabase 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/resources/lightsail_database aws_lightsail_database} 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 LightsailDatabaseConfig
*/
constructor(scope: Construct, id: string, config: LightsailDatabaseConfig);
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 _availabilityZone?;
get availabilityZone(): string;
set availabilityZone(value: string);
resetAvailabilityZone(): void;
get availabilityZoneInput(): string | undefined;
private _backupRetentionEnabled?;
get backupRetentionEnabled(): boolean | cdktf.IResolvable;
set backupRetentionEnabled(value: boolean | cdktf.IResolvable);
resetBackupRetentionEnabled(): void;
get backupRetentionEnabledInput(): boolean | cdktf.IResolvable | undefined;
private _blueprintId?;
get blueprintId(): string;
set blueprintId(value: string);
get blueprintIdInput(): string | undefined;
private _bundleId?;
get bundleId(): string;
set bundleId(value: string);
get bundleIdInput(): string | undefined;
get caCertificateIdentifier(): string;
get cpuCount(): number;
get createdAt(): string;
get diskSize(): number;
get engine(): string;
get engineVersion(): string;
private _finalSnapshotName?;
get finalSnapshotName(): string;
set finalSnapshotName(value: string);
resetFinalSnapshotName(): void;
get finalSnapshotNameInput(): string | undefined;
private _id?;
get id(): string;
set id(value: string);
resetId(): void;
get idInput(): string | undefined;
private _masterDatabaseName?;
get masterDatabaseName(): string;
set masterDatabaseName(value: string);
get masterDatabaseNameInput(): string | undefined;
get masterEndpointAddress(): string;
get masterEndpointPort(): number;
private _masterPassword?;
get masterPassword(): string;
set masterPassword(value: string);
get masterPasswordInput(): string | undefined;
private _masterUsername?;
get masterUsername(): string;
set masterUsername(value: string);
get masterUsernameInput(): 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 _publiclyAccessible?;
get publiclyAccessible(): boolean | cdktf.IResolvable;
set publiclyAccessible(value: boolean | cdktf.IResolvable);
resetPubliclyAccessible(): void;
get publiclyAccessibleInput(): boolean | cdktf.IResolvable | undefined;
get ramSize(): number;
private _region?;
get region(): string;
set region(value: string);
resetRegion(): void;
get regionInput(): string | undefined;
private _relationalDatabaseName?;
get relationalDatabaseName(): string;
set relationalDatabaseName(value: string);
get relationalDatabaseNameInput(): string | undefined;
get secondaryAvailabilityZone(): string;
private _skipFinalSnapshot?;
get skipFinalSnapshot(): boolean | cdktf.IResolvable;
set skipFinalSnapshot(value: boolean | cdktf.IResolvable);
resetSkipFinalSnapshot(): void;
get skipFinalSnapshotInput(): boolean | cdktf.IResolvable | undefined;
get supportCode(): string;
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;
protected synthesizeAttributes(): {
[name: string]: any;
};
protected synthesizeHclAttributes(): {
[name: string]: any;
};
}