aws-cdk-lib
Version:
Version 2 of the AWS Cloud Development Kit library
1,135 lines • 390 kB
TypeScript
import * as cdk from "../../core/lib";
import * as constructs from "constructs";
import * as cfn_parse from "../../core/lib/helpers-internal";
import { CustomDBEngineVersionReference, DBClusterParameterGroupReference, DBClusterReference, DBInstanceReference, DBParameterGroupReference, DBProxyEndpointReference, DBProxyReference, DBProxyTargetGroupReference, DBSecurityGroupIngressReference, DBSecurityGroupReference, DBShardGroupReference, DBSubnetGroupReference, EventSubscriptionReference, GlobalClusterReference, ICustomDBEngineVersionRef, IDBClusterParameterGroupRef, IDBClusterRef, IDBInstanceRef, IDBParameterGroupRef, IDBProxyEndpointRef, IDBProxyRef, IDBProxyTargetGroupRef, IDBSecurityGroupIngressRef, IDBSecurityGroupRef, IDBShardGroupRef, IDBSubnetGroupRef, IEventSubscriptionRef, IGlobalClusterRef, IIntegrationRef, IntegrationReference, IOptionGroupRef, OptionGroupReference } from "../../interfaces/generated/aws-rds-interfaces.generated";
import { aws_ec2 as ec2Refs, aws_iam as iamRefs, aws_kms as kmsRefs, aws_rds as rdsRefs, aws_sns as snsRefs } from "../../interfaces";
/**
* Creates a custom DB engine version (CEV).
*
* @cloudformationResource AWS::RDS::CustomDBEngineVersion
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html
*/
export declare class CfnCustomDBEngineVersion extends cdk.CfnResource implements cdk.IInspectable, ICustomDBEngineVersionRef, cdk.ITaggableV2 {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnCustomDBEngineVersion from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCustomDBEngineVersion;
/**
* Checks whether the given object is a CfnCustomDBEngineVersion
*/
static isCfnCustomDBEngineVersion(x: any): x is CfnCustomDBEngineVersion;
/**
* Tag Manager which manages the tags for this resource
*/
readonly cdkTagManager: cdk.TagManager;
/**
* The name of an Amazon S3 bucket that contains database installation files for your CEV.
*/
private _databaseInstallationFilesS3BucketName?;
/**
* The Amazon S3 directory that contains the database installation files for your CEV.
*/
private _databaseInstallationFilesS3Prefix?;
/**
* An optional description of your CEV.
*/
private _description?;
/**
* The database engine to use for your custom engine version (CEV).
*/
private _engine;
/**
* The name of your CEV.
*/
private _engineVersion;
/**
* A value that indicates the ID of the AMI.
*/
private _imageId?;
/**
* The AWS KMS key identifier for an encrypted CEV.
*/
private _kmsKeyId?;
/**
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
*/
private _manifest?;
/**
* The ARN of a CEV to use as a source for creating a new CEV.
*/
private _sourceCustomDbEngineVersionIdentifier?;
/**
* A value that indicates the status of a custom engine version (CEV).
*/
private _status?;
/**
* A list of tags.
*/
private _tags?;
/**
* Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
*/
private _useAwsProvidedLatestImage?;
/**
* Create a new `AWS::RDS::CustomDBEngineVersion`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props: CfnCustomDBEngineVersionProps);
get customDbEngineVersionRef(): CustomDBEngineVersionReference;
/**
* The name of an Amazon S3 bucket that contains database installation files for your CEV.
*/
get databaseInstallationFilesS3BucketName(): string | undefined;
/**
* The name of an Amazon S3 bucket that contains database installation files for your CEV.
*/
set databaseInstallationFilesS3BucketName(value: string | undefined);
/**
* The Amazon S3 directory that contains the database installation files for your CEV.
*/
get databaseInstallationFilesS3Prefix(): string | undefined;
/**
* The Amazon S3 directory that contains the database installation files for your CEV.
*/
set databaseInstallationFilesS3Prefix(value: string | undefined);
/**
* An optional description of your CEV.
*/
get description(): string | undefined;
/**
* An optional description of your CEV.
*/
set description(value: string | undefined);
/**
* The database engine to use for your custom engine version (CEV).
*/
get engine(): string;
/**
* The database engine to use for your custom engine version (CEV).
*/
set engine(value: string);
/**
* The name of your CEV.
*/
get engineVersion(): string;
/**
* The name of your CEV.
*/
set engineVersion(value: string);
/**
* A value that indicates the ID of the AMI.
*/
get imageId(): string | undefined;
/**
* A value that indicates the ID of the AMI.
*/
set imageId(value: string | undefined);
/**
* The AWS KMS key identifier for an encrypted CEV.
*/
get kmsKeyId(): string | undefined;
/**
* The AWS KMS key identifier for an encrypted CEV.
*/
set kmsKeyId(value: string | undefined);
/**
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
*/
get manifest(): string | undefined;
/**
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
*/
set manifest(value: string | undefined);
/**
* The ARN of a CEV to use as a source for creating a new CEV.
*/
get sourceCustomDbEngineVersionIdentifier(): string | undefined;
/**
* The ARN of a CEV to use as a source for creating a new CEV.
*/
set sourceCustomDbEngineVersionIdentifier(value: string | undefined);
/**
* A value that indicates the status of a custom engine version (CEV).
*/
get status(): string | undefined;
/**
* A value that indicates the status of a custom engine version (CEV).
*/
set status(value: string | undefined);
/**
* A list of tags.
*/
get tags(): Array<cdk.CfnTag> | undefined;
/**
* A list of tags.
*/
set tags(value: Array<cdk.CfnTag> | undefined);
/**
* Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
*/
get useAwsProvidedLatestImage(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
*/
set useAwsProvidedLatestImage(value: boolean | cdk.IResolvable | undefined);
/**
* The ARN of the custom engine version.
*
* @cloudformationAttribute DBEngineVersionArn
*/
get attrDbEngineVersionArn(): string;
protected get cfnProperties(): Record<string, any>;
/**
* Examines the CloudFormation resource and discloses attributes
*
* @param inspector tree inspector to collect and process attributes
*/
inspect(inspector: cdk.TreeInspector): void;
protected renderProperties(props: Record<string, any>): Record<string, any>;
}
/**
* Properties for defining a `CfnCustomDBEngineVersion`
*
* @struct
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html
*/
export interface CfnCustomDBEngineVersionProps {
/**
* The name of an Amazon S3 bucket that contains database installation files for your CEV.
*
* For example, a valid bucket name is `my-custom-installation-files` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3bucketname
*/
readonly databaseInstallationFilesS3BucketName?: string;
/**
* The Amazon S3 directory that contains the database installation files for your CEV.
*
* For example, a valid bucket name is `123456789012/cev1` . If this setting isn't specified, no prefix is assumed.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-databaseinstallationfiless3prefix
*/
readonly databaseInstallationFilesS3Prefix?: string;
/**
* An optional description of your CEV.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-description
*/
readonly description?: string;
/**
* The database engine to use for your custom engine version (CEV).
*
* Valid values:
*
* - `custom-oracle-ee`
* - `custom-oracle-ee-cdb`
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engine
*/
readonly engine: string;
/**
* The name of your CEV.
*
* The name format is `major version.customized_string` . For example, a valid CEV name is `19.my_cev1` . This setting is required for RDS Custom for Oracle, but optional for Amazon RDS. The combination of `Engine` and `EngineVersion` is unique per customer per Region.
*
* *Constraints:* Minimum length is 1. Maximum length is 60.
*
* *Pattern:* `^[a-z0-9_.-]{1,60$` }
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-engineversion
*/
readonly engineVersion: string;
/**
* A value that indicates the ID of the AMI.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-imageid
*/
readonly imageId?: string;
/**
* The AWS KMS key identifier for an encrypted CEV.
*
* A symmetric encryption KMS key is required for RDS Custom, but optional for Amazon RDS.
*
* If you have an existing symmetric encryption KMS key in your account, you can use it with RDS Custom. No further action is necessary. If you don't already have a symmetric encryption KMS key in your account, follow the instructions in [Creating a symmetric encryption KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/create-keys.html#create-symmetric-cmk) in the *AWS Key Management Service Developer Guide* .
*
* You can choose the same symmetric encryption key when you create a CEV and a DB instance, or choose different keys.
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-kmskeyid
*/
readonly kmsKeyId?: string;
/**
* The CEV manifest, which is a JSON document that describes the installation .zip files stored in Amazon S3. Specify the name/value pairs in a file or a quoted string. RDS Custom applies the patches in the order in which they are listed.
*
* The following JSON fields are valid:
*
* - **MediaImportTemplateVersion** - Version of the CEV manifest. The date is in the format `YYYY-MM-DD` .
* - **databaseInstallationFileNames** - Ordered list of installation files for the CEV.
* - **opatchFileNames** - Ordered list of OPatch installers used for the Oracle DB engine.
* - **psuRuPatchFileNames** - The PSU and RU patches for this CEV.
* - **OtherPatchFileNames** - The patches that are not in the list of PSU and RU patches. Amazon RDS applies these patches after applying the PSU and RU patches.
*
* For more information, see [Creating the CEV manifest](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.preparing.manifest) in the *Amazon RDS User Guide* .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-manifest
*/
readonly manifest?: string;
/**
* The ARN of a CEV to use as a source for creating a new CEV.
*
* You can specify a different Amazon Machine Imagine (AMI) by using either `Source` or `UseAwsProvidedLatestImage` . You can't specify a different JSON manifest when you specify `SourceCustomDbEngineVersionIdentifier` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-sourcecustomdbengineversionidentifier
*/
readonly sourceCustomDbEngineVersionIdentifier?: string;
/**
* A value that indicates the status of a custom engine version (CEV).
*
* @default - "available"
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-status
*/
readonly status?: string;
/**
* A list of tags.
*
* For more information, see [Tagging Amazon RDS Resources](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html) in the *Amazon RDS User Guide.*
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-tags
*/
readonly tags?: Array<cdk.CfnTag>;
/**
* Specifies whether to use the latest service-provided Amazon Machine Image (AMI) for the CEV.
*
* If you specify `UseAwsProvidedLatestImage` , you can't also specify `ImageId` .
*
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-customdbengineversion.html#cfn-rds-customdbengineversion-useawsprovidedlatestimage
*/
readonly useAwsProvidedLatestImage?: boolean | cdk.IResolvable;
}
/**
* The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.
*
* For more information about creating an Aurora DB cluster, see [Creating an Amazon Aurora DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.CreateInstance.html) in the *Amazon Aurora User Guide* .
*
* For more information about creating a Multi-AZ DB cluster, see [Creating a Multi-AZ DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html) in the *Amazon RDS User Guide* .
*
* > You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.
*
* *Updating DB clusters*
*
* When properties labeled " *Update requires:* [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement) " are updated, AWS CloudFormation first creates a replacement DB cluster, then changes references from other dependent resources to point to the replacement DB cluster, and finally deletes the old DB cluster.
*
* > We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB cluster. To preserve your data, perform the following procedure:
* >
* > - Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.
* > - Create a snapshot of the DB cluster. For more information, see [Creating a DB cluster snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_CreateSnapshotCluster.html) .
* > - If you want to restore your DB cluster using a DB cluster snapshot, modify the updated template with your DB cluster changes and add the `SnapshotIdentifier` property with the ID of the DB cluster snapshot that you want to use.
* >
* > After you restore a DB cluster with a `SnapshotIdentifier` property, you must specify the same `SnapshotIdentifier` property for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the DB cluster snapshot again, and the data in the database is not changed. However, if you don't specify the `SnapshotIdentifier` property, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB cluster is restored from the specified `SnapshotIdentifier` property, and the original DB cluster is deleted.
* > - Update the stack.
*
* Currently, when you are updating the stack for an Aurora Serverless DB cluster, you can't include changes to any other properties when you specify one of the following properties: `PreferredBackupWindow` , `PreferredMaintenanceWindow` , and `Port` . This limitation doesn't apply to provisioned DB clusters.
*
* For more information about updating other properties of this resource, see `[ModifyDBCluster](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBCluster.html)` . For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .
*
* *Deleting DB clusters*
*
* The default `DeletionPolicy` for `AWS::RDS::DBCluster` resources is `Snapshot` . For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
*
* @cloudformationResource AWS::RDS::DBCluster
* @stability external
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html
*/
export declare class CfnDBCluster extends cdk.CfnResource implements cdk.IInspectable, IDBClusterRef, cdk.ITaggable {
/**
* The CloudFormation resource type name for this resource class.
*/
static readonly CFN_RESOURCE_TYPE_NAME: string;
/**
* Build a CfnDBCluster from CloudFormation properties
*
* A factory method that creates a new instance of this class from an object
* containing the CloudFormation properties of this resource.
* Used in the @aws-cdk/cloudformation-include module.
*
* @internal
*/
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnDBCluster;
/**
* Checks whether the given object is a CfnDBCluster
*/
static isCfnDBCluster(x: any): x is CfnDBCluster;
static arnForDBCluster(resource: IDBClusterRef): string;
/**
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
*/
private _allocatedStorage?;
/**
* Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
*/
private _associatedRoles?;
/**
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
*/
private _autoMinorVersionUpgrade?;
/**
* A list of Availability Zones (AZs) where instances in the DB cluster can be created.
*/
private _availabilityZones?;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to `0` .
*/
private _backtrackWindow?;
/**
* The number of days for which automated backups are retained.
*/
private _backupRetentionPeriod?;
/**
* Specifies the scalability mode of the Aurora DB cluster.
*/
private _clusterScalabilityType?;
/**
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
*/
private _copyTagsToSnapshot?;
/**
* The mode of Database Insights to enable for the DB cluster.
*/
private _databaseInsightsMode?;
/**
* The name of your database.
*/
private _databaseName?;
/**
* The DB cluster identifier. This parameter is stored as a lowercase string.
*/
private _dbClusterIdentifier?;
/**
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge` . Not all DB instance classes are available in all AWS Regions , or for all database engines.
*/
private _dbClusterInstanceClass?;
/**
* The name of the DB cluster parameter group to associate with this DB cluster.
*/
private _dbClusterParameterGroupName?;
/**
* The name of the DB parameter group to apply to all instances of the DB cluster.
*/
private _dbInstanceParameterGroupName?;
/**
* A DB subnet group that you want to associate with this DB cluster.
*/
private _dbSubnetGroupName?;
/**
* Reserved for future use.
*/
private _dbSystemId?;
/**
* Specifies whether to remove automated backups immediately after the DB cluster is deleted.
*/
private _deleteAutomatedBackups?;
/**
* A value that indicates whether the DB cluster has deletion protection enabled.
*/
private _deletionProtection?;
/**
* Indicates the directory ID of the Active Directory to create the DB cluster.
*/
private _domain?;
/**
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
*/
private _domainIamRoleName?;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
*/
private _enableCloudwatchLogsExports?;
/**
* Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
*/
private _enableGlobalWriteForwarding?;
/**
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
*/
private _enableHttpEndpoint?;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
*/
private _enableIamDatabaseAuthentication?;
/**
* Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
*/
private _enableLocalWriteForwarding?;
/**
* The name of the database engine to be used for this DB cluster.
*/
private _engine?;
/**
* The life cycle type for this DB cluster.
*/
private _engineLifecycleSupport?;
/**
* The DB engine mode of the DB cluster, either `provisioned` or `serverless` .
*/
private _engineMode?;
/**
* The version number of the database engine to use.
*/
private _engineVersion?;
/**
* If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
*/
private _globalClusterIdentifier?;
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
*/
private _iops?;
/**
* The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
*/
private _kmsKeyId?;
/**
* Specifies whether to manage the master user password with AWS Secrets Manager.
*/
private _manageMasterUserPassword?;
/**
* Specifies the authentication type for the master user.
*/
private _masterUserAuthenticationType?;
/**
* The name of the master user for the DB cluster.
*/
private _masterUsername?;
/**
* The master password for the DB instance.
*/
private _masterUserPassword?;
/**
* The secret managed by RDS in AWS Secrets Manager for the master user password.
*/
private _masterUserSecret?;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
*/
private _monitoringInterval?;
/**
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
*/
private _monitoringRoleArn?;
/**
* The network type of the DB cluster.
*/
private _networkType?;
/**
* Specifies whether to turn on Performance Insights for the DB cluster.
*/
private _performanceInsightsEnabled?;
/**
* The AWS KMS key identifier for encryption of Performance Insights data.
*/
private _performanceInsightsKmsKeyId?;
/**
* The number of days to retain Performance Insights data.
*/
private _performanceInsightsRetentionPeriod?;
/**
* The port number on which the DB instances in the DB cluster accept connections.
*/
private _port?;
/**
* The daily time range during which automated backups are created.
*/
private _preferredBackupWindow?;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*/
private _preferredMaintenanceWindow?;
/**
* Specifies whether the DB cluster is publicly accessible.
*/
private _publiclyAccessible?;
/**
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
*/
private _replicationSourceIdentifier?;
/**
* The date and time to restore the DB cluster to.
*/
private _restoreToTime?;
/**
* The type of restore to be performed. You can specify one of the following values:.
*/
private _restoreType?;
/**
* The scaling configuration of an Aurora Serverless v1 DB cluster.
*/
private _scalingConfiguration?;
/**
* The scaling configuration of an Aurora Serverless V2 DB cluster.
*/
private _serverlessV2ScalingConfiguration?;
/**
* The identifier for the DB snapshot or DB cluster snapshot to restore from.
*/
private _snapshotIdentifier?;
/**
* When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
*/
private _sourceDbClusterIdentifier?;
/**
* The resource ID of the source DB cluster from which to restore.
*/
private _sourceDbClusterResourceId?;
/**
* The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` .
*/
private _sourceRegion?;
/**
* Indicates whether the DB cluster is encrypted.
*/
private _storageEncrypted?;
/**
* The storage type to associate with the DB cluster.
*/
private _storageType?;
/**
* Tag Manager which manages the tags for this resource
*/
readonly tags: cdk.TagManager;
/**
* Tags to assign to the DB cluster.
*/
private _tagsRaw?;
/**
* A value that indicates whether to restore the DB cluster to the latest restorable backup time.
*/
private _useLatestRestorableTime?;
/**
* A list of EC2 VPC security groups to associate with this DB cluster.
*/
private _vpcSecurityGroupIds?;
/**
* Create a new `AWS::RDS::DBCluster`.
*
* @param scope Scope in which this resource is defined
* @param id Construct identifier for this resource (unique in its scope)
* @param props Resource properties
*/
constructor(scope: constructs.Construct, id: string, props?: CfnDBClusterProps);
get dbClusterRef(): DBClusterReference;
/**
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
*/
get allocatedStorage(): number | undefined;
/**
* The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster.
*/
set allocatedStorage(value: number | undefined);
/**
* Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
*/
get associatedRoles(): Array<CfnDBCluster.DBClusterRoleProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
/**
* Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster.
*/
set associatedRoles(value: Array<CfnDBCluster.DBClusterRoleProperty | cdk.IResolvable> | cdk.IResolvable | undefined);
/**
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
*/
get autoMinorVersionUpgrade(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window.
*/
set autoMinorVersionUpgrade(value: boolean | cdk.IResolvable | undefined);
/**
* A list of Availability Zones (AZs) where instances in the DB cluster can be created.
*/
get availabilityZones(): Array<string> | undefined;
/**
* A list of Availability Zones (AZs) where instances in the DB cluster can be created.
*/
set availabilityZones(value: Array<string> | undefined);
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to `0` .
*/
get backtrackWindow(): number | undefined;
/**
* The target backtrack window, in seconds. To disable backtracking, set this value to `0` .
*/
set backtrackWindow(value: number | undefined);
/**
* The number of days for which automated backups are retained.
*/
get backupRetentionPeriod(): number | undefined;
/**
* The number of days for which automated backups are retained.
*/
set backupRetentionPeriod(value: number | undefined);
/**
* Specifies the scalability mode of the Aurora DB cluster.
*/
get clusterScalabilityType(): string | undefined;
/**
* Specifies the scalability mode of the Aurora DB cluster.
*/
set clusterScalabilityType(value: string | undefined);
/**
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
*/
get copyTagsToSnapshot(): boolean | cdk.IResolvable | undefined;
/**
* A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster.
*/
set copyTagsToSnapshot(value: boolean | cdk.IResolvable | undefined);
/**
* The mode of Database Insights to enable for the DB cluster.
*/
get databaseInsightsMode(): string | undefined;
/**
* The mode of Database Insights to enable for the DB cluster.
*/
set databaseInsightsMode(value: string | undefined);
/**
* The name of your database.
*/
get databaseName(): string | undefined;
/**
* The name of your database.
*/
set databaseName(value: string | undefined);
/**
* The DB cluster identifier. This parameter is stored as a lowercase string.
*/
get dbClusterIdentifier(): string | undefined;
/**
* The DB cluster identifier. This parameter is stored as a lowercase string.
*/
set dbClusterIdentifier(value: string | undefined);
/**
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge` . Not all DB instance classes are available in all AWS Regions , or for all database engines.
*/
get dbClusterInstanceClass(): string | undefined;
/**
* The compute and memory capacity of each DB instance in the Multi-AZ DB cluster, for example `db.m6gd.xlarge` . Not all DB instance classes are available in all AWS Regions , or for all database engines.
*/
set dbClusterInstanceClass(value: string | undefined);
/**
* The name of the DB cluster parameter group to associate with this DB cluster.
*/
get dbClusterParameterGroupName(): string | undefined;
/**
* The name of the DB cluster parameter group to associate with this DB cluster.
*/
set dbClusterParameterGroupName(value: string | undefined);
/**
* The name of the DB parameter group to apply to all instances of the DB cluster.
*/
get dbInstanceParameterGroupName(): string | undefined;
/**
* The name of the DB parameter group to apply to all instances of the DB cluster.
*/
set dbInstanceParameterGroupName(value: string | undefined);
/**
* A DB subnet group that you want to associate with this DB cluster.
*/
get dbSubnetGroupName(): string | undefined;
/**
* A DB subnet group that you want to associate with this DB cluster.
*/
set dbSubnetGroupName(value: string | undefined);
/**
* Reserved for future use.
*/
get dbSystemId(): string | undefined;
/**
* Reserved for future use.
*/
set dbSystemId(value: string | undefined);
/**
* Specifies whether to remove automated backups immediately after the DB cluster is deleted.
*/
get deleteAutomatedBackups(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to remove automated backups immediately after the DB cluster is deleted.
*/
set deleteAutomatedBackups(value: boolean | cdk.IResolvable | undefined);
/**
* A value that indicates whether the DB cluster has deletion protection enabled.
*/
get deletionProtection(): boolean | cdk.IResolvable | undefined;
/**
* A value that indicates whether the DB cluster has deletion protection enabled.
*/
set deletionProtection(value: boolean | cdk.IResolvable | undefined);
/**
* Indicates the directory ID of the Active Directory to create the DB cluster.
*/
get domain(): string | undefined;
/**
* Indicates the directory ID of the Active Directory to create the DB cluster.
*/
set domain(value: string | undefined);
/**
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
*/
get domainIamRoleName(): string | undefined;
/**
* Specifies the name of the IAM role to use when making API calls to the Directory Service.
*/
set domainIamRoleName(value: string | undefined);
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
*/
get enableCloudwatchLogsExports(): Array<string> | undefined;
/**
* The list of log types that need to be enabled for exporting to CloudWatch Logs.
*/
set enableCloudwatchLogsExports(value: Array<string> | undefined);
/**
* Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
*/
get enableGlobalWriteForwarding(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to enable this DB cluster to forward write operations to the primary cluster of a global cluster (Aurora global database).
*/
set enableGlobalWriteForwarding(value: boolean | cdk.IResolvable | undefined);
/**
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
*/
get enableHttpEndpoint(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to enable the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.
*/
set enableHttpEndpoint(value: boolean | cdk.IResolvable | undefined);
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
*/
get enableIamDatabaseAuthentication(): boolean | cdk.IResolvable | undefined;
/**
* A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts.
*/
set enableIamDatabaseAuthentication(value: boolean | cdk.IResolvable | undefined);
/**
* Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
*/
get enableLocalWriteForwarding(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether read replicas can forward write operations to the writer DB instance in the DB cluster.
*/
set enableLocalWriteForwarding(value: boolean | cdk.IResolvable | undefined);
/**
* The name of the database engine to be used for this DB cluster.
*/
get engine(): string | undefined;
/**
* The name of the database engine to be used for this DB cluster.
*/
set engine(value: string | undefined);
/**
* The life cycle type for this DB cluster.
*/
get engineLifecycleSupport(): string | undefined;
/**
* The life cycle type for this DB cluster.
*/
set engineLifecycleSupport(value: string | undefined);
/**
* The DB engine mode of the DB cluster, either `provisioned` or `serverless` .
*/
get engineMode(): string | undefined;
/**
* The DB engine mode of the DB cluster, either `provisioned` or `serverless` .
*/
set engineMode(value: string | undefined);
/**
* The version number of the database engine to use.
*/
get engineVersion(): string | undefined;
/**
* The version number of the database engine to use.
*/
set engineVersion(value: string | undefined);
/**
* If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
*/
get globalClusterIdentifier(): string | undefined;
/**
* If you are configuring an Aurora global database cluster and want your Aurora DB cluster to be a secondary member in the global database cluster, specify the global cluster ID of the global database cluster.
*/
set globalClusterIdentifier(value: string | undefined);
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
*/
get iops(): number | undefined;
/**
* The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster.
*/
set iops(value: number | undefined);
/**
* The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
*/
get kmsKeyId(): string | undefined;
/**
* The Amazon Resource Name (ARN) of the AWS KMS key that is used to encrypt the database instances in the DB cluster, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` .
*/
set kmsKeyId(value: string | undefined);
/**
* Specifies whether to manage the master user password with AWS Secrets Manager.
*/
get manageMasterUserPassword(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to manage the master user password with AWS Secrets Manager.
*/
set manageMasterUserPassword(value: boolean | cdk.IResolvable | undefined);
/**
* Specifies the authentication type for the master user.
*/
get masterUserAuthenticationType(): string | undefined;
/**
* Specifies the authentication type for the master user.
*/
set masterUserAuthenticationType(value: string | undefined);
/**
* The name of the master user for the DB cluster.
*/
get masterUsername(): string | undefined;
/**
* The name of the master user for the DB cluster.
*/
set masterUsername(value: string | undefined);
/**
* The master password for the DB instance.
*/
get masterUserPassword(): string | undefined;
/**
* The master password for the DB instance.
*/
set masterUserPassword(value: string | undefined);
/**
* The secret managed by RDS in AWS Secrets Manager for the master user password.
*/
get masterUserSecret(): cdk.IResolvable | CfnDBCluster.MasterUserSecretProperty | undefined;
/**
* The secret managed by RDS in AWS Secrets Manager for the master user password.
*/
set masterUserSecret(value: cdk.IResolvable | CfnDBCluster.MasterUserSecretProperty | undefined);
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
*/
get monitoringInterval(): number | undefined;
/**
* The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster.
*/
set monitoringInterval(value: number | undefined);
/**
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
*/
get monitoringRoleArn(): string | undefined;
/**
* The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs.
*/
set monitoringRoleArn(value: string | undefined);
/**
* The network type of the DB cluster.
*/
get networkType(): string | undefined;
/**
* The network type of the DB cluster.
*/
set networkType(value: string | undefined);
/**
* Specifies whether to turn on Performance Insights for the DB cluster.
*/
get performanceInsightsEnabled(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether to turn on Performance Insights for the DB cluster.
*/
set performanceInsightsEnabled(value: boolean | cdk.IResolvable | undefined);
/**
* The AWS KMS key identifier for encryption of Performance Insights data.
*/
get performanceInsightsKmsKeyId(): string | undefined;
/**
* The AWS KMS key identifier for encryption of Performance Insights data.
*/
set performanceInsightsKmsKeyId(value: string | undefined);
/**
* The number of days to retain Performance Insights data.
*/
get performanceInsightsRetentionPeriod(): number | undefined;
/**
* The number of days to retain Performance Insights data.
*/
set performanceInsightsRetentionPeriod(value: number | undefined);
/**
* The port number on which the DB instances in the DB cluster accept connections.
*/
get port(): number | undefined;
/**
* The port number on which the DB instances in the DB cluster accept connections.
*/
set port(value: number | undefined);
/**
* The daily time range during which automated backups are created.
*/
get preferredBackupWindow(): string | undefined;
/**
* The daily time range during which automated backups are created.
*/
set preferredBackupWindow(value: string | undefined);
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*/
get preferredMaintenanceWindow(): string | undefined;
/**
* The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
*/
set preferredMaintenanceWindow(value: string | undefined);
/**
* Specifies whether the DB cluster is publicly accessible.
*/
get publiclyAccessible(): boolean | cdk.IResolvable | undefined;
/**
* Specifies whether the DB cluster is publicly accessible.
*/
set publiclyAccessible(value: boolean | cdk.IResolvable | undefined);
/**
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
*/
get replicationSourceIdentifier(): string | undefined;
/**
* The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica.
*/
set replicationSourceIdentifier(value: string | undefined);
/**
* The date and time to restore the DB cluster to.
*/
get restoreToTime(): string | undefined;
/**
* The date and time to restore the DB cluster to.
*/
set restoreToTime(value: string | undefined);
/**
* The type of restore to be performed. You can specify one of the following values:.
*/
get restoreType(): string | undefined;
/**
* The type of restore to be performed. You can specify one of the following values:.
*/
set restoreType(value: string | undefined);
/**
* The scaling configuration of an Aurora Serverless v1 DB cluster.
*/
get scalingConfiguration(): cdk.IResolvable | CfnDBCluster.ScalingConfigurationProperty | undefined;
/**
* The scaling configuration of an Aurora Serverless v1 DB cluster.
*/
set scalingConfiguration(value: cdk.IResolvable | CfnDBCluster.ScalingConfigurationProperty | undefined);
/**
* The scaling configuration of an Aurora Serverless V2 DB cluster.
*/
get serverlessV2ScalingConfiguration(): cdk.IResolvable | CfnDBCluster.ServerlessV2ScalingConfigurationProperty | undefined;
/**
* The scaling configuration of an Aurora Serverless V2 DB cluster.
*/
set serverlessV2ScalingConfiguration(value: cdk.IResolvable | CfnDBCluster.ServerlessV2ScalingConfigurationProperty | undefined);
/**
* The identifier for the DB snapshot or DB cluster snapshot to restore from.
*/
get snapshotIdentifier(): string | undefined;
/**
* The identifier for the DB snapshot or DB cluster snapshot to restore from.
*/
set snapshotIdentifier(value: string | undefined);
/**
* When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
*/
get sourceDbClusterIdentifier(): string | undefined;
/**
* When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore.
*/
set sourceDbClusterIdentifier(value: string | undefined);
/**
* The resource ID of the source DB cluster from which to restore.
*/
get sourceDbClusterResourceId(): string | undefined;
/**
* The resource ID of the source DB cluster from which to restore.
*/
set sourceDbClusterResourceId(value: string | undefined);
/**
* The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` .
*/
get sourceRegion(): string | undefined;
/**
* The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` .
*/
set sourceRegion(value: string | undefined);
/**
* Indicates whether the DB cluster is encrypted.
*/
get storageEncrypted(): boolean | cdk.IResolvable | undefined;
/**
* Indicates whether the DB cluster is encrypted.
*/
set storageEncrypted(value: boolean | cdk.IResolvable | undefined);
/**
* The storage type to associate with the DB cluster.
*/
get storageType(): string | undefined;
/**
* The storage type to associate with the DB cluster.
*/
set storageType(value: string | undefined);
/**
* Tags to assign to the DB cluster.
*/
get tagsRaw(): Array<cdk.CfnTag> | undefined;
/**
* Tags to assign to the DB cluster.
*/
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
/**
* A value that indicates whether to restore the DB cluster to the latest restorable backup time.
*/
get useLatestRestorableTime(): boolean | cdk.IResolvable | undefined;
/**
* A value that indicates whether to restore the DB cluster to the latest restorable backup time.
*/
set useLatestRestorableTime(value: boolean | cdk.IResolvable | undefined);
/**
* A list of EC2 VPC security groups to associate with this DB cluster.
*/
get vpcSecurityGroupIds(): Array<string> | undefined;
/**
* A list of EC2 VPC security groups to associate with this DB cluster.
*/
set vpcSecurityGroupIds(value: Array<string> | undefined);
/**
* The Amazon Resource Name (ARN) for the DB cluster.
*
* @cloudformationAttribute DBClusterArn
*/
get attrDbClusterArn(): string;
/**
* The AWS Region -unique, immutable identifier for the DB cluster. This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.
*
* @cloudformationAttribute DBClusterResourceId
*/
get attrDbClusterResourceId(): string;
/**
* The ``Endpoint`` return value specifies the connec