{ "author": { "name": "Amazon Web Services", "organization": true, "roles": [ "author" ], "url": "https://aws.amazon.com" }, "dependencies": { "@aws-cdk/aws-cloudwatch": "1.204.0", "@aws-cdk/aws-ec2": "1.204.0", "@aws-cdk/aws-events": "1.204.0", "@aws-cdk/aws-iam": "1.204.0", "@aws-cdk/aws-kms": "1.204.0", "@aws-cdk/aws-logs": "1.204.0", "@aws-cdk/aws-s3": "1.204.0", "@aws-cdk/aws-secretsmanager": "1.204.0", "@aws-cdk/core": "1.204.0", "@aws-cdk/cx-api": "1.204.0", "constructs": "^3.3.69" }, "dependencyClosure": { "@aws-cdk/assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.Assets", "packageId": "Amazon.CDK.Assets" }, "java": { "maven": { "artifactId": "cdk-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.assets" }, "js": { "npm": "@aws-cdk/assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.assets", "module": "aws_cdk.assets" } } }, "@aws-cdk/aws-applicationautoscaling": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ApplicationAutoScaling", "packageId": "Amazon.CDK.AWS.ApplicationAutoScaling" }, "java": { "maven": { "artifactId": "applicationautoscaling", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.applicationautoscaling" }, "js": { "npm": "@aws-cdk/aws-applicationautoscaling" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-applicationautoscaling", "module": "aws_cdk.aws_applicationautoscaling" } } }, "@aws-cdk/aws-autoscaling-common": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.AutoScaling.Common", "packageId": "Amazon.CDK.AWS.AutoScaling.Common" }, "java": { "maven": { "artifactId": "autoscaling-common", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.autoscaling.common" }, "js": { "npm": "@aws-cdk/aws-autoscaling-common" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-autoscaling-common", "module": "aws_cdk.aws_autoscaling_common" } } }, "@aws-cdk/aws-cloudwatch": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CloudWatch", "packageId": "Amazon.CDK.AWS.CloudWatch" }, "java": { "maven": { "artifactId": "cloudwatch", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.cloudwatch" }, "js": { "npm": "@aws-cdk/aws-cloudwatch" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-cloudwatch", "module": "aws_cdk.aws_cloudwatch" } } }, "@aws-cdk/aws-codeguruprofiler": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeGuruProfiler", "packageId": "Amazon.CDK.AWS.CodeGuruProfiler" }, "java": { "maven": { "artifactId": "codeguruprofiler", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codeguruprofiler" }, "js": { "npm": "@aws-cdk/aws-codeguruprofiler" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codeguruprofiler", "module": "aws_cdk.aws_codeguruprofiler" } } }, "@aws-cdk/aws-codestarnotifications": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.CodeStarNotifications", "packageId": "Amazon.CDK.AWS.CodeStarNotifications" }, "java": { "maven": { "artifactId": "codestarnotifications", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.codestarnotifications" }, "js": { "npm": "@aws-cdk/aws-codestarnotifications" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-codestarnotifications", "module": "aws_cdk.aws_codestarnotifications" } } }, "@aws-cdk/aws-ec2": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EC2", "packageId": "Amazon.CDK.AWS.EC2" }, "java": { "maven": { "artifactId": "ec2", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ec2" }, "js": { "npm": "@aws-cdk/aws-ec2" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ec2", "module": "aws_cdk.aws_ec2" } } }, "@aws-cdk/aws-ecr": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.ECR", "packageId": "Amazon.CDK.AWS.ECR" }, "java": { "maven": { "artifactId": "ecr", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr" }, "js": { "npm": "@aws-cdk/aws-ecr" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr", "module": "aws_cdk.aws_ecr" } } }, "@aws-cdk/aws-ecr-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Ecr.Assets", "packageId": "Amazon.CDK.ECR.Assets" }, "java": { "maven": { "artifactId": "ecr-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ecr.assets" }, "js": { "npm": "@aws-cdk/aws-ecr-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ecr-assets", "module": "aws_cdk.aws_ecr_assets" } } }, "@aws-cdk/aws-efs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.EFS", "packageId": "Amazon.CDK.AWS.EFS" }, "java": { "maven": { "artifactId": "efs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.efs" }, "js": { "npm": "@aws-cdk/aws-efs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-efs", "module": "aws_cdk.aws_efs" } } }, "@aws-cdk/aws-events": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Events", "packageId": "Amazon.CDK.AWS.Events" }, "java": { "maven": { "artifactId": "events", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.events" }, "js": { "npm": "@aws-cdk/aws-events" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-events", "module": "aws_cdk.aws_events" } } }, "@aws-cdk/aws-iam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.IAM", "packageId": "Amazon.CDK.AWS.IAM" }, "java": { "maven": { "artifactId": "iam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.iam" }, "js": { "npm": "@aws-cdk/aws-iam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-iam", "module": "aws_cdk.aws_iam" } } }, "@aws-cdk/aws-kms": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.KMS", "packageId": "Amazon.CDK.AWS.KMS" }, "java": { "maven": { "artifactId": "kms", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.kms" }, "js": { "npm": "@aws-cdk/aws-kms" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-kms", "module": "aws_cdk.aws_kms" } } }, "@aws-cdk/aws-lambda": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Lambda", "packageId": "Amazon.CDK.AWS.Lambda" }, "java": { "maven": { "artifactId": "lambda", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.lambda" }, "js": { "npm": "@aws-cdk/aws-lambda" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-lambda", "module": "aws_cdk.aws_lambda" } } }, "@aws-cdk/aws-logs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Logs", "packageId": "Amazon.CDK.AWS.Logs" }, "java": { "maven": { "artifactId": "logs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.logs" }, "js": { "npm": "@aws-cdk/aws-logs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-logs", "module": "aws_cdk.aws_logs" } } }, "@aws-cdk/aws-s3": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3", "packageId": "Amazon.CDK.AWS.S3" }, "java": { "maven": { "artifactId": "s3", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3" }, "js": { "npm": "@aws-cdk/aws-s3" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3", "module": "aws_cdk.aws_s3" } } }, "@aws-cdk/aws-s3-assets": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.S3.Assets", "packageId": "Amazon.CDK.AWS.S3.Assets" }, "java": { "maven": { "artifactId": "s3-assets", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.s3.assets" }, "js": { "npm": "@aws-cdk/aws-s3-assets" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-s3-assets", "module": "aws_cdk.aws_s3_assets" } } }, "@aws-cdk/aws-sam": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SAM", "packageId": "Amazon.CDK.AWS.SAM" }, "java": { "maven": { "artifactId": "sam", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sam" }, "js": { "npm": "@aws-cdk/aws-sam" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sam", "module": "aws_cdk.aws_sam" } } }, "@aws-cdk/aws-secretsmanager": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SecretsManager", "packageId": "Amazon.CDK.AWS.SecretsManager" }, "java": { "maven": { "artifactId": "secretsmanager", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.secretsmanager" }, "js": { "npm": "@aws-cdk/aws-secretsmanager" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-secretsmanager", "module": "aws_cdk.aws_secretsmanager" } } }, "@aws-cdk/aws-signer": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.Signer", "packageId": "Amazon.CDK.AWS.Signer" }, "java": { "maven": { "artifactId": "signer", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.signer" }, "js": { "npm": "@aws-cdk/aws-signer" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-signer", "module": "aws_cdk.aws_signer" } } }, "@aws-cdk/aws-sns": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SNS", "packageId": "Amazon.CDK.AWS.SNS" }, "java": { "maven": { "artifactId": "sns", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sns" }, "js": { "npm": "@aws-cdk/aws-sns" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sns", "module": "aws_cdk.aws_sns" } } }, "@aws-cdk/aws-sqs": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SQS", "packageId": "Amazon.CDK.AWS.SQS" }, "java": { "maven": { "artifactId": "sqs", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.sqs" }, "js": { "npm": "@aws-cdk/aws-sqs" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-sqs", "module": "aws_cdk.aws_sqs" } } }, "@aws-cdk/aws-ssm": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.SSM", "packageId": "Amazon.CDK.AWS.SSM" }, "java": { "maven": { "artifactId": "ssm", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.ssm" }, "js": { "npm": "@aws-cdk/aws-ssm" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-ssm", "module": "aws_cdk.aws_ssm" } } }, "@aws-cdk/cloud-assembly-schema": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CloudAssembly.Schema", "packageId": "Amazon.CDK.CloudAssembly.Schema" }, "java": { "maven": { "artifactId": "cdk-cloud-assembly-schema", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cloudassembly.schema" }, "js": { "npm": "@aws-cdk/cloud-assembly-schema" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cloud-assembly-schema", "module": "aws_cdk.cloud_assembly_schema" } } }, "@aws-cdk/core": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK", "packageId": "Amazon.CDK" }, "java": { "maven": { "artifactId": "core", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.core" }, "js": { "npm": "@aws-cdk/core" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.core", "module": "aws_cdk.core" } } }, "@aws-cdk/cx-api": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.CXAPI", "packageId": "Amazon.CDK.CXAPI" }, "java": { "maven": { "artifactId": "cdk-cx-api", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.cxapi" }, "js": { "npm": "@aws-cdk/cx-api" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.cx-api", "module": "aws_cdk.cx_api" } } }, "@aws-cdk/region-info": { "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.RegionInfo", "packageId": "Amazon.CDK.RegionInfo" }, "java": { "maven": { "artifactId": "cdk-region-info", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.regioninfo" }, "js": { "npm": "@aws-cdk/region-info" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.region-info", "module": "aws_cdk.region_info" } } }, "constructs": { "targets": { "dotnet": { "namespace": "Constructs", "packageId": "Constructs" }, "go": { "moduleName": "github.com/aws/constructs-go" }, "java": { "maven": { "artifactId": "constructs", "groupId": "software.constructs" }, "package": "software.constructs" }, "js": { "npm": "constructs" }, "python": { "distName": "constructs", "module": "constructs" } } } }, "description": "The CDK Construct Library for AWS::RDS", "docs": { "deprecated": "AWS CDK v1 has reached End-of-Support on 2023-06-01.\nThis package is no longer being updated, and users should migrate to AWS CDK v2.\n\nFor more information on how to migrate, see https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html", "stability": "stable" }, "homepage": "https://github.com/aws/aws-cdk", "jsiiVersion": "1.84.0 (build 5404dcf)", "keywords": [ "aws", "cdk", "constructs", "rds" ], "license": "Apache-2.0", "metadata": { "jsii": { "compiledWithDeprecationWarnings": true, "pacmak": { "hasDefaultInterfaces": true }, "rosetta": { "strict": true } } }, "name": "@aws-cdk/aws-rds", "readme": { "markdown": "# Amazon Relational Database Service Construct Library\n\n\n---\n\n![End-of-Support](https://img.shields.io/badge/End--of--Support-critical.svg?style=for-the-badge)\n\n> AWS CDK v1 has reached End-of-Support on 2023-06-01.\n> This package is no longer being updated, and users should migrate to AWS CDK v2.\n>\n> For more information on how to migrate, see the [_Migrating to AWS CDK v2_ guide][doc].\n>\n> [doc]: https://docs.aws.amazon.com/cdk/v2/guide/migrating-v2.html\n\n---\n\n\n\n```ts nofixture\nimport * as rds from '@aws-cdk/aws-rds';\n```\n\n## Starting a clustered database\n\nTo set up a clustered database (like Aurora), define a `DatabaseCluster`. You must\nalways launch a database in a VPC. Use the `vpcSubnets` attribute to control whether\nyour instances will be launched privately or publicly:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),\n credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password\n instanceProps: {\n // optional , defaults to t3.medium\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n },\n vpc,\n },\n});\n```\n\nIf there isn't a constant for the exact version you want to use,\nall of the `Version` classes have a static `of` method that can be used to create an arbitrary version.\n\n```ts\nconst customEngineVersion = rds.AuroraMysqlEngineVersion.of('5.7.mysql_aurora.2.08.1');\n```\n\nBy default, the master password will be generated and stored in AWS Secrets Manager with auto-generated description.\n\nYour cluster will be empty by default. To add a default database upon construction, specify the\n`defaultDatabaseName` attribute.\n\nUse `DatabaseClusterFromSnapshot` to create a cluster from a snapshot:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nnew rds.DatabaseClusterFromSnapshot(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),\n instanceProps: {\n vpc,\n },\n snapshotIdentifier: 'mySnapshot',\n});\n```\n\n## Starting an instance database\n\nTo set up a instance database, define a `DatabaseInstance`. You must\nalways launch a database in a VPC. Use the `vpcSubnets` attribute to control whether\nyour instances will be launched privately or publicly:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),\n credentials: rds.Credentials.fromGeneratedSecret('syscdk'), // Optional - will default to 'admin' username and generated password\n vpc,\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n }\n});\n```\n\nIf there isn't a constant for the exact engine version you want to use,\nall of the `Version` classes have a static `of` method that can be used to create an arbitrary version.\n\n```ts\nconst customEngineVersion = rds.OracleEngineVersion.of('19.0.0.0.ru-2020-04.rur-2020-04.r1', '19');\n```\n\nBy default, the master password will be generated and stored in AWS Secrets Manager.\n\nTo use the storage auto scaling option of RDS you can specify the maximum allocated storage.\nThis is the upper limit to which RDS can automatically scale the storage. More info can be found\n[here](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling)\nExample for max storage configuration:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),\n vpc,\n maxAllocatedStorage: 200,\n});\n```\n\nUse `DatabaseInstanceFromSnapshot` and `DatabaseInstanceReadReplica` to create an instance from snapshot or\na source database respectively:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n```\n\nAutomatic backups of read replica instances are only supported for MySQL and MariaDB. By default,\nautomatic backups are disabled for read replicas and can only be enabled (using `backupRetention`)\nif also enabled on the source instance.\n\nCreating a \"production\" Oracle database instance with option and parameter groups:\n\n```ts lit=test/integ.instance.lit.ts\n // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });\n\n```\nAdd XMLDB and OEM with option group\n```ts lit=test/integ.instance.lit.ts\n const optionGroup = new rds.OptionGroup(this, 'OptionGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n configurations: [\n {\n name: 'LOCATOR',\n },\n {\n name: 'OEM',\n port: 1158,\n vpc,\n },\n ],\n });\n\n // Allow connections to OEM\n optionGroup.optionConnections.OEM.connections.allowDefaultPortFromAnyIpv4();\n\n // Database instance with production values\n const instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n licenseModel: rds.LicenseModel.BRING_YOUR_OWN_LICENSE,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.MEDIUM),\n multiAz: true,\n storageType: rds.StorageType.IO1,\n credentials: rds.Credentials.fromUsername('syscdk'),\n vpc,\n databaseName: 'ORCL',\n storageEncrypted: true,\n backupRetention: cdk.Duration.days(7),\n monitoringInterval: cdk.Duration.seconds(60),\n enablePerformanceInsights: true,\n cloudwatchLogsExports: [\n 'trace',\n 'audit',\n 'alert',\n 'listener',\n ],\n cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,\n autoMinorVersionUpgrade: true, // required to be true if LOCATOR is used in the option group\n optionGroup,\n parameterGroup,\n removalPolicy: RemovalPolicy.DESTROY,\n });\n\n // Allow connections on default port from any IPV4\n instance.connections.allowDefaultPortFromAnyIpv4();\n\n // Rotate the master user password every 30 days\n instance.addRotationSingleUser();\n\n // Add alarm for high CPU\n new cloudwatch.Alarm(this, 'HighCPU', {\n metric: instance.metricCPUUtilization(),\n threshold: 90,\n evaluationPeriods: 1,\n });\n\n // Trigger Lambda function on instance availability events\n const fn = new lambda.Function(this, 'Function', {\n code: lambda.Code.fromInline('exports.handler = (event) => console.log(event);'),\n handler: 'index.handler',\n runtime: lambda.Runtime.NODEJS_14_X,\n });\n\n const availabilityRule = instance.onEvent('Availability', { target: new targets.LambdaFunction(fn) });\n availabilityRule.addEventPattern({\n detail: {\n EventCategories: [\n 'availability',\n ],\n },\n });\n```\n\n## Setting Public Accessibility\n\nYou can set public accessibility for the database instance or cluster using the `publiclyAccessible` property.\nIf you specify `true`, it creates an instance with a publicly resolvable DNS name, which resolves to a public IP address.\nIf you specify `false`, it creates an internal instance with a DNS name that resolves to a private IP address.\nThe default value depends on `vpcSubnets`.\nIt will be `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n// Setting public accessibility for DB instance\nnew rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.mysql({\n version: rds.MysqlEngineVersion.VER_8_0_19,\n }),\n vpc,\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n },\n publiclyAccessible: true,\n});\n\n// Setting public accessibility for DB cluster\nnew rds.DatabaseCluster(this, 'DatabaseCluster', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: {\n vpc,\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n },\n publiclyAccessible: true,\n },\n});\n```\n\n## Instance events\n\nTo define Amazon CloudWatch event rules for database instances, use the `onEvent`\nmethod:\n\n```ts\ndeclare const instance: rds.DatabaseInstance;\ndeclare const fn: lambda.Function;\nconst rule = instance.onEvent('InstanceEvent', { target: new targets.LambdaFunction(fn) });\n```\n\n## Login credentials\n\nBy default, database instances and clusters (with the exception of `DatabaseInstanceFromSnapshot` and `ServerlessClusterFromSnapshot`) will have `admin` user with an auto-generated password.\nAn alternative username (and password) may be specified for the admin user instead of the default.\n\nThe following examples use a `DatabaseInstance`, but the same usage is applicable to `DatabaseCluster`.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nnew rds.DatabaseInstance(this, 'InstanceWithUsername', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres'), // Creates an admin user of postgres with a generated password\n});\n\nnew rds.DatabaseInstance(this, 'InstanceWithUsernameAndPassword', {\n engine,\n vpc,\n credentials: rds.Credentials.fromPassword('postgres', SecretValue.ssmSecure('/dbPassword', '1')), // Use password from SSM\n});\n\nconst mySecret = secretsmanager.Secret.fromSecretName(this, 'DBSecret', 'myDBLoginInfo');\nnew rds.DatabaseInstance(this, 'InstanceWithSecretLogin', {\n engine,\n vpc,\n credentials: rds.Credentials.fromSecret(mySecret), // Get both username and password from existing secret\n});\n```\n\nSecrets generated by `fromGeneratedSecret()` can be customized:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstance(this, 'InstanceWithCustomizedSecret', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres', {\n secretName: 'my-cool-name',\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});\n```\n\n### Snapshot credentials\n\nAs noted above, Databases created with `DatabaseInstanceFromSnapshot` or `ServerlessClusterFromSnapshot` will not create user and auto-generated password by default because it's not possible to change the master username for a snapshot. Instead, they will use the existing username and password from the snapshot. You can still generate a new password - to generate a secret similarly to the other constructs, pass in credentials with `fromGeneratedSecret()` or `fromGeneratedPassword()`.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstanceFromSnapshot(this, 'InstanceFromSnapshotWithCustomizedSecret', {\n engine,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n credentials: rds.SnapshotCredentials.fromGeneratedSecret('username', {\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});\n```\n\n## Connecting\n\nTo control who can access the cluster or instance, use the `.connections` attribute. RDS databases have\na default port, so you don't need to specify the port:\n\n```ts\ndeclare const cluster: rds.DatabaseCluster;\ncluster.connections.allowFromAnyIpv4(ec2.Port.allTraffic(), 'Open to the world');\n```\n\nThe endpoints to access your database cluster will be available as the `.clusterEndpoint` and `.readerEndpoint`\nattributes:\n\n```ts\ndeclare const cluster: rds.DatabaseCluster;\nconst writeAddress = cluster.clusterEndpoint.socketAddress; // \"HOSTNAME:PORT\"\n```\n\nFor an instance database:\n\n```ts\ndeclare const instance: rds.DatabaseInstance;\nconst address = instance.instanceEndpoint.socketAddress; // \"HOSTNAME:PORT\"\n```\n\n## Rotating credentials\n\nWhen the master password is generated and stored in AWS Secrets Manager, it can be rotated automatically:\n\n```ts\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const instance: rds.DatabaseInstance;\ninstance.addRotationSingleUser({\n automaticallyAfter: cdk.Duration.days(7), // defaults to 30 days\n excludeCharacters: '!@#$%^&*', // defaults to the set \" %+~`#$&*()|[]{}:;<>?!'/@\\\"\\\\\"\n});\n```\n\n```ts lit=test/integ.cluster-rotation.lit.ts\nconst cluster = new rds.DatabaseCluster(stack, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: {\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),\n vpc,\n },\n});\n\ncluster.addRotationSingleUser();\n```\n\nThe multi user rotation scheme is also available:\n\n```ts\ndeclare const instance: rds.DatabaseInstance;\ndeclare const myImportedSecret: rds.DatabaseSecret;\ninstance.addRotationMultiUser('MyUser', {\n secret: myImportedSecret, // This secret must have the `masterarn` key\n});\n```\n\nIt's also possible to create user credentials together with the instance/cluster and add rotation:\n\n```ts\ndeclare const instance: rds.DatabaseInstance;\nconst myUserSecret = new rds.DatabaseSecret(this, 'MyUserSecret', {\n username: 'myuser',\n secretName: 'my-user-secret', // optional, defaults to a CloudFormation-generated name\n masterSecret: instance.secret,\n excludeCharacters: '{}[]()\\'\"/\\\\', // defaults to the set \" %+~`#$&*()|[]{}:;<>?!'/@\\\"\\\\\"\n});\nconst myUserSecretAttached = myUserSecret.attach(instance); // Adds DB connections information in the secret\n\ninstance.addRotationMultiUser('MyUser', { // Add rotation using the multi user scheme\n secret: myUserSecretAttached,\n});\n```\n\n**Note**: This user must be created manually in the database using the master credentials.\nThe rotation will start as soon as this user exists.\n\nAccess to the Secrets Manager API is required for the secret rotation. This can be achieved either with\ninternet connectivity (through NAT) or with a VPC interface endpoint. By default, the rotation Lambda function\nis deployed in the same subnets as the instance/cluster. If access to the Secrets Manager API is not possible from\nthose subnets or using the default API endpoint, use the `vpcSubnets` and/or `endpoint` options:\n\n```ts\ndeclare const instance: rds.DatabaseInstance;\ndeclare const myEndpoint: ec2.InterfaceVpcEndpoint;\n\ninstance.addRotationSingleUser({\n vpcSubnets: { subnetType: ec2.SubnetType.PRIVATE_WITH_NAT }, // Place rotation Lambda in private subnets\n endpoint: myEndpoint, // Use VPC interface endpoint\n});\n```\n\nSee also [@aws-cdk/aws-secretsmanager](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-secretsmanager/README.md) for credentials rotation of existing clusters/instances.\n\n## IAM Authentication\n\nYou can also authenticate to a database instance using AWS Identity and Access Management (IAM) database authentication;\nSee for more information\nand a list of supported versions and limitations.\n\n**Note**: `grantConnect()` does not currently work - see [this GitHub issue](https://github.com/aws/aws-cdk/issues/11851).\n\nThe following example shows enabling IAM authentication for a database instance and granting connection access to an IAM role.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),\n vpc,\n iamAuthentication: true, // Optional - will be automatically set if you call grantConnect().\n});\nconst role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });\ninstance.grantConnect(role); // Grant the role connection access to the DB.\n```\n\nThe following example shows granting connection access for RDS Proxy to an IAM role.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.\n```\n\n**Note**: In addition to the setup above, a database user will need to be created to support IAM auth.\nSee for setup instructions.\n\n## Kerberos Authentication\n\nYou can also authenticate using Kerberos to a database instance using AWS Managed Microsoft AD for authentication;\nSee for more information\nand a list of supported versions and limitations.\n\nThe following example shows enabling domain support for a database instance and creating an IAM role to access\nDirectory Services.\n\n```ts\ndeclare const vpc: ec2.Vpc;\nconst role = new iam.Role(this, 'RDSDirectoryServicesRole', {\n assumedBy: new iam.ServicePrincipal('rds.amazonaws.com'),\n managedPolicies: [\n iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AmazonRDSDirectoryServiceAccess'),\n ],\n});\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),\n vpc,\n domain: 'd-????????', // The ID of the domain for the instance to join.\n domainRole: role, // Optional - will be create automatically if not provided.\n});\n```\n\n**Note**: In addition to the setup above, you need to make sure that the database instance has network connectivity\nto the domain controllers. This includes enabling cross-VPC traffic if in a different VPC and setting up the\nappropriate security groups/network ACL to allow traffic between the database instance and domain controllers.\nOnce configured, see for details\non configuring users for each available database engine.\n\n## Metrics\n\nDatabase instances and clusters both expose metrics (`cloudwatch.Metric`):\n\n```ts\n// The number of database connections in use (average over 5 minutes)\ndeclare const instance: rds.DatabaseInstance;\nconst dbConnections = instance.metricDatabaseConnections();\n\n// Average CPU utilization over 5 minutes\ndeclare const cluster: rds.DatabaseCluster;\nconst cpuUtilization = cluster.metricCPUUtilization();\n\n// The average amount of time taken per disk I/O operation (average over 1 minute)\nconst readLatency = instance.metric('ReadLatency', { statistic: 'Average', period: Duration.seconds(60) });\n```\n\n## Enabling S3 integration\n\nData in S3 buckets can be imported to and exported from certain database engines using SQL queries. To enable this\nfunctionality, set the `s3ImportBuckets` and `s3ExportBuckets` properties for import and export respectively. When\nconfigured, the CDK automatically creates and configures IAM roles as required.\nAdditionally, the `s3ImportRole` and `s3ExportRole` properties can be used to set this role directly.\n\nYou can read more about loading data to (or from) S3 here:\n\n* Aurora MySQL - [import](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.LoadFromS3.html)\n and [export](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Integrating.SaveIntoS3.html).\n* Aurora PostgreSQL - [import](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html#USER_PostgreSQL.S3Import)\n and [export](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html).\n* Microsoft SQL Server - [import and export](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/SQLServer.Procedural.Importing.html)\n* PostgreSQL - [import](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html)\n and [export](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/postgresql-s3-export.html)\n* Oracle - [import and export](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html)\n\nThe following snippet sets up a database cluster with different S3 buckets where the data is imported and exported -\n\n```ts\nimport * as s3 from '@aws-cdk/aws-s3';\n\ndeclare const vpc: ec2.Vpc;\nconst importBucket = new s3.Bucket(this, 'importbucket');\nconst exportBucket = new s3.Bucket(this, 'exportbucket');\nnew rds.DatabaseCluster(this, 'dbcluster', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: {\n vpc,\n },\n s3ImportBuckets: [importBucket],\n s3ExportBuckets: [exportBucket],\n});\n```\n\n## Creating a Database Proxy\n\nAmazon RDS Proxy sits between your application and your relational database to efficiently manage\nconnections to the database and improve scalability of the application. Learn more about at [Amazon RDS Proxy](https://aws.amazon.com/rds/proxy/)\n\nThe following code configures an RDS Proxy for a `DatabaseInstance`.\n\n```ts\ndeclare const vpc: ec2.Vpc;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const secrets: secretsmanager.Secret[];\ndeclare const dbInstance: rds.DatabaseInstance;\n\nconst proxy = dbInstance.addProxy('proxy', {\n borrowTimeout: Duration.seconds(30),\n maxConnectionsPercent: 50,\n secrets,\n vpc,\n});\n```\n\n## Exporting Logs\n\nYou can publish database logs to Amazon CloudWatch Logs. With CloudWatch Logs, you can perform real-time analysis of the log data,\nstore the data in highly durable storage, and manage the data with the CloudWatch Logs Agent. This is available for both database\ninstances and clusters; the types of logs available depend on the database type and engine being used.\n\n```ts\nimport * as logs from '@aws-cdk/aws-logs';\ndeclare const myLogsPublishingRole: iam.Role;\ndeclare const vpc: ec2.Vpc;\n\n// Exporting logs from a cluster\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({\n version: rds.AuroraEngineVersion.VER_1_17_9, // different version class for each engine type\n }),\n instanceProps: {\n vpc,\n },\n cloudwatchLogsExports: ['error', 'general', 'slowquery', 'audit'], // Export all available MySQL-based logs\n cloudwatchLogsRetention: logs.RetentionDays.THREE_MONTHS, // Optional - default is to never expire logs\n cloudwatchLogsRetentionRole: myLogsPublishingRole, // Optional - a role will be created if not provided\n // ...\n});\n\n// Exporting logs from an instance\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.postgres({\n version: rds.PostgresEngineVersion.VER_12_3,\n }),\n vpc,\n cloudwatchLogsExports: ['postgresql'], // Export the PostgreSQL logs\n // ...\n});\n```\n\n## Option Groups\n\nSome DB engines offer additional features that make it easier to manage data and databases, and to provide additional security for your database.\nAmazon RDS uses option groups to enable and configure these features. An option group can specify features, called options,\nthat are available for a particular Amazon RDS DB instance.\n\n```ts\ndeclare const vpc: ec2.Vpc;\ndeclare const securityGroup: ec2.SecurityGroup;\n\nnew rds.OptionGroup(this, 'Options', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({\n version: rds.OracleEngineVersion.VER_19,\n }),\n configurations: [\n {\n name: 'OEM',\n port: 5500,\n vpc,\n securityGroups: [securityGroup], // Optional - a default group will be created if not provided.\n },\n ],\n});\n```\n\n## Parameter Groups\n\nDatabase parameters specify how the database is configured.\nFor example, database parameters can specify the amount of resources, such as memory, to allocate to a database.\nYou manage your database configuration by associating your DB instances with parameter groups.\nAmazon RDS defines parameter groups with default settings.\n\nYou can create your own parameter group for your cluster or instance and associate it with your database:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.sqlServerEe({\n version: rds.SqlServerEngineVersion.VER_11,\n }),\n parameters: {\n locks: '100',\n },\n});\n\nnew rds.DatabaseInstance(this, 'Database', {\n engine: rds.DatabaseInstanceEngine.SQL_SERVER_EE,\n vpc,\n parameterGroup,\n});\n```\n\nAnother way to specify parameters is to use the inline field `parameters` that creates an RDS parameter group for you.\nYou can use this if you do not want to reuse the parameter group instance for different instances:\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nnew rds.DatabaseInstance(this, 'Database', {\n engine: rds.DatabaseInstanceEngine.sqlServerEe({ version: rds.SqlServerEngineVersion.VER_11 }),\n vpc,\n parameters: {\n locks: '100',\n },\n});\n```\n\nYou cannot specify a parameter map and a parameter group at the same time.\n\n## Serverless\n\n[Amazon Aurora Serverless](https://aws.amazon.com/rds/aurora/serverless/) is an on-demand, auto-scaling configuration for Amazon\nAurora. The database will automatically start up, shut down, and scale capacity\nup or down based on your application's needs. It enables you to run your database\nin the cloud without managing any database instances.\n\nThe following example initializes an Aurora Serverless PostgreSql cluster.\nAurora Serverless clusters can specify scaling properties which will be used to\nautomatically scale the database cluster seamlessly based on the workload.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),\n vpc,\n scaling: {\n autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time\n minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)\n maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)\n }\n});\n```\n\nAurora Serverless Clusters do not support the following features:\n\n* Loading data from an Amazon S3 bucket\n* Saving data to an Amazon S3 bucket\n* Invoking an AWS Lambda function with an Aurora MySQL native function\n* Aurora replicas\n* Backtracking\n* Multi-master clusters\n* Database cloning\n* IAM database cloning\n* IAM database authentication\n* Restoring a snapshot from MySQL DB instance\n* Performance Insights\n* RDS Proxy\n\nRead more about the [limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\n\nLearn more about using Amazon Aurora Serverless by reading the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html)\n\nUse `ServerlessClusterFromSnapshot` to create a serverless cluster from a snapshot:\n\n```ts\ndeclare const vpc: ec2.Vpc;\nnew rds.ServerlessClusterFromSnapshot(this, 'Cluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n});\n```\n\n### Data API\n\nYou can access your Aurora Serverless DB cluster using the built-in Data API. The Data API doesn't require a persistent connection to the DB cluster. Instead, it provides a secure HTTP endpoint and integration with AWS SDKs.\n\nThe following example shows granting Data API access to a Lamba function.\n\n```ts\ndeclare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc, // this parameter is optional for serverless Clusters\n enableDataApi: true, // Optional - will be automatically set if you call grantDataApiAccess()\n});\n\ndeclare const code: lambda.Code;\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code,\n environment: {\n CLUSTER_ARN: cluster.clusterArn,\n SECRET_ARN: cluster.secret!.secretArn,\n },\n});\ncluster.grantDataApiAccess(fn);\n```\n\n**Note**: To invoke the Data API, the resource will need to read the secret associated with the cluster.\n\nTo learn more about using the Data API, see the [documentation](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html).\n\n### Default VPC\n\nThe `vpc` parameter is optional.\n\nIf not provided, the cluster will be created in the default VPC of the account and region.\nAs this VPC is not deployed with AWS CDK, you can't configure the `vpcSubnets`, `subnetGroup` or `securityGroups` of the Aurora Serverless Cluster.\nIf you want to provide one of `vpcSubnets`, `subnetGroup` or `securityGroups` parameter, please provide a `vpc`.\n" }, "repository": { "directory": "packages/@aws-cdk/aws-rds", "type": "git", "url": "https://github.com/aws/aws-cdk.git" }, "schema": "jsii/0.10.0", "targets": { "dotnet": { "iconUrl": "https://raw.githubusercontent.com/aws/aws-cdk/master/logo/default-256-dark.png", "namespace": "Amazon.CDK.AWS.RDS", "packageId": "Amazon.CDK.AWS.RDS" }, "java": { "maven": { "artifactId": "rds", "groupId": "software.amazon.awscdk" }, "package": "software.amazon.awscdk.services.rds" }, "js": { "npm": "@aws-cdk/aws-rds" }, "python": { "classifiers": [ "Framework :: AWS CDK", "Framework :: AWS CDK :: 1" ], "distName": "aws-cdk.aws-rds", "module": "aws_cdk.aws_rds" } }, "types": { "@aws-cdk/aws-rds.AuroraCapacityUnit": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Each ACU is a combination of processing and memory capacity.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.architecture", "stability": "stable", "summary": "Aurora capacity units (ACUs).", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),\n vpc,\n scaling: {\n autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time\n minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)\n maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.AuroraCapacityUnit", "kind": "enum", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 210 }, "members": [ { "docs": { "stability": "stable", "summary": "1 Aurora Capacity Unit." }, "name": "ACU_1" }, { "docs": { "stability": "stable", "summary": "2 Aurora Capacity Units." }, "name": "ACU_2" }, { "docs": { "stability": "stable", "summary": "4 Aurora Capacity Units." }, "name": "ACU_4" }, { "docs": { "stability": "stable", "summary": "8 Aurora Capacity Units." }, "name": "ACU_8" }, { "docs": { "stability": "stable", "summary": "16 Aurora Capacity Units." }, "name": "ACU_16" }, { "docs": { "stability": "stable", "summary": "32 Aurora Capacity Units." }, "name": "ACU_32" }, { "docs": { "stability": "stable", "summary": "64 Aurora Capacity Units." }, "name": "ACU_64" }, { "docs": { "stability": "stable", "summary": "128 Aurora Capacity Units." }, "name": "ACU_128" }, { "docs": { "stability": "stable", "summary": "192 Aurora Capacity Units." }, "name": "ACU_192" }, { "docs": { "stability": "stable", "summary": "256 Aurora Capacity Units." }, "name": "ACU_256" }, { "docs": { "stability": "stable", "summary": "384 Aurora Capacity Units." }, "name": "ACU_384" } ], "name": "AuroraCapacityUnit", "symbolId": "lib/serverless-cluster:AuroraCapacityUnit" }, "@aws-cdk/aws-rds.AuroraClusterEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseClusterEngine.aurora}.", "stability": "stable", "summary": "Creation properties of the plain Aurora database cluster engine.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseClusterFromSnapshot(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),\n instanceProps: {\n vpc,\n },\n snapshotIdentifier: 'mySnapshot',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.AuroraClusterEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 277 }, "name": "AuroraClusterEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The version of the Aurora cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 279 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } } ], "symbolId": "lib/cluster-engine:AuroraClusterEngineProps" }, "@aws-cdk/aws-rds.AuroraEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the Aurora cluster engine (those returned by {@link DatabaseClusterEngine.aurora}).", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseClusterFromSnapshot(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),\n instanceProps: {\n vpc,\n },\n snapshotIdentifier: 'mySnapshot',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 216 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new AuroraEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 254 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"5.6.mysql_aurora.1.78.3.6\"." }, "name": "auroraFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, defaults to \"5.6\"." }, "name": "auroraMajorVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, "static": true } ], "name": "AuroraEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.17.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 220 }, "name": "VER_1_17_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.19.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 222 }, "name": "VER_1_19_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.19.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 224 }, "name": "VER_1_19_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.19.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 226 }, "name": "VER_1_19_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.19.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 228 }, "name": "VER_1_19_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.19.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 230 }, "name": "VER_1_19_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.20.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 232 }, "name": "VER_1_20_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.20.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 234 }, "name": "VER_1_20_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.21.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 236 }, "name": "VER_1_21_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.22.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 238 }, "name": "VER_1_22_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.22.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 240 }, "name": "VER_1_22_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.22.1.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 242 }, "name": "VER_1_22_1_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.mysql_aurora.1.22.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 244 }, "name": "VER_1_22_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.6.10a\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 218 }, "name": "VER_10A", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"5.6.mysql_aurora.1.78.3.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 263 }, "name": "auroraFullVersion", "type": { "primitive": "string" } }, { "docs": { "remarks": "Currently, it's always \"5.6\".", "stability": "stable", "summary": "The major version of the engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 265 }, "name": "auroraMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/cluster-engine:AuroraEngineVersion" }, "@aws-cdk/aws-rds.AuroraMysqlClusterEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseClusterEngine.auroraMysql}.", "stability": "stable", "summary": "Creation properties of the Aurora MySQL database cluster engine.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),\n credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password\n instanceProps: {\n // optional , defaults to t3.medium\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n },\n vpc,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.AuroraMysqlClusterEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 413 }, "name": "AuroraMysqlClusterEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The version of the Aurora MySQL cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 415 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } } ], "symbolId": "lib/cluster-engine:AuroraMysqlClusterEngineProps" }, "@aws-cdk/aws-rds.AuroraMysqlEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the Aurora MySQL cluster engine (those returned by {@link DatabaseClusterEngine.auroraMysql}).", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.auroraMysql({ version: rds.AuroraMysqlEngineVersion.VER_2_08_1 }),\n credentials: rds.Credentials.fromGeneratedSecret('clusteradmin'), // Optional - will default to 'admin' username and generated password\n instanceProps: {\n // optional , defaults to t3.medium\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.SMALL),\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n },\n vpc,\n },\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 307 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new AuroraMysqlEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 375 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"5.7.mysql_aurora.2.78.3.6\"." }, "name": "auroraMysqlFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, defaults to \"5.7\"." }, "name": "auroraMysqlMajorVersion", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, "static": true } ], "name": "AuroraMysqlEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.03.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 311 }, "name": "VER_2_03_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.03.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 313 }, "name": "VER_2_03_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.03.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 315 }, "name": "VER_2_03_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 317 }, "name": "VER_2_04_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 319 }, "name": "VER_2_04_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 321 }, "name": "VER_2_04_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 323 }, "name": "VER_2_04_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 325 }, "name": "VER_2_04_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 327 }, "name": "VER_2_04_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 329 }, "name": "VER_2_04_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 331 }, "name": "VER_2_04_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.04.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 333 }, "name": "VER_2_04_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.05.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 335 }, "name": "VER_2_05_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.06.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 337 }, "name": "VER_2_06_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.07.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 339 }, "name": "VER_2_07_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.07.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 341 }, "name": "VER_2_07_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.07.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 343 }, "name": "VER_2_07_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.08.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 345 }, "name": "VER_2_08_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.08.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 347 }, "name": "VER_2_08_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.08.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 349 }, "name": "VER_2_08_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.09.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 351 }, "name": "VER_2_09_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.09.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 353 }, "name": "VER_2_09_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.09.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 355 }, "name": "VER_2_09_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.09.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 357 }, "name": "VER_2_09_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.10.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 359 }, "name": "VER_2_10_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.10.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 361 }, "name": "VER_2_10_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.mysql_aurora.2.10.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 363 }, "name": "VER_2_10_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.mysql_aurora.3.01.0\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 365 }, "name": "VER_3_01_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 309 }, "name": "VER_5_7_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"5.7.mysql_aurora.1.78.3.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 389 }, "name": "auroraMysqlFullVersion", "type": { "primitive": "string" } }, { "docs": { "remarks": "Currently, it's either \"5.7\", or \"8.0\".", "stability": "stable", "summary": "The major version of the engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 391 }, "name": "auroraMysqlMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/cluster-engine:AuroraMysqlEngineVersion" }, "@aws-cdk/aws-rds.AuroraPostgresClusterEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseClusterEngine.auroraPostgres}.", "stability": "stable", "summary": "Creation properties of the Aurora PostgreSQL database cluster engine.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const auroraPostgresEngineVersion: rds.AuroraPostgresEngineVersion;\nconst auroraPostgresClusterEngineProps: rds.AuroraPostgresClusterEngineProps = {\n version: auroraPostgresEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.AuroraPostgresClusterEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 579 }, "name": "AuroraPostgresClusterEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The version of the Aurora PostgreSQL cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 581 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } } ], "symbolId": "lib/cluster-engine:AuroraPostgresClusterEngineProps" }, "@aws-cdk/aws-rds.AuroraPostgresEngineFeatures": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Features supported by this version of the Aurora Postgres cluster engine.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst auroraPostgresEngineFeatures: rds.AuroraPostgresEngineFeatures = {\n s3Export: false,\n s3Import: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineFeatures", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 442 }, "name": "AuroraPostgresEngineFeatures", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this version of the Aurora Postgres cluster engine supports the S3 data export feature." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 455 }, "name": "s3Export", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this version of the Aurora Postgres cluster engine supports the S3 data import feature." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 448 }, "name": "s3Import", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/cluster-engine:AuroraPostgresEngineFeatures" }, "@aws-cdk/aws-rds.AuroraPostgresEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the Aurora PostgreSQL cluster engine (those returned by {@link DatabaseClusterEngine.auroraPostgres}).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst auroraPostgresEngineVersion = rds.AuroraPostgresEngineVersion.VER_10_11;", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 462 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new AuroraPostgresEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 548 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"9.6.25.1\"." }, "name": "auroraPostgresFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"9.6\"." }, "name": "auroraPostgresMajorVersion", "type": { "primitive": "string" } }, { "name": "auroraPostgresFeatures", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineFeatures" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, "static": true } ], "name": "AuroraPostgresEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 488 }, "name": "VER_10_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 490 }, "name": "VER_10_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 492 }, "name": "VER_10_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 494 }, "name": "VER_10_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 496 }, "name": "VER_10_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 498 }, "name": "VER_10_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 500 }, "name": "VER_10_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.20\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 502 }, "name": "VER_10_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 480 }, "name": "VER_10_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 482 }, "name": "VER_10_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 484 }, "name": "VER_10_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 486 }, "name": "VER_10_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 514 }, "name": "VER_11_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 516 }, "name": "VER_11_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 518 }, "name": "VER_11_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 520 }, "name": "VER_11_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 504 }, "name": "VER_11_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 506 }, "name": "VER_11_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 508 }, "name": "VER_11_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 510 }, "name": "VER_11_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 512 }, "name": "VER_11_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 530 }, "name": "VER_12_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 522 }, "name": "VER_12_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 524 }, "name": "VER_12_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 526 }, "name": "VER_12_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 528 }, "name": "VER_12_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 532 }, "name": "VER_13_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 534 }, "name": "VER_13_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 536 }, "name": "VER_13_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 538 }, "name": "VER_13_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 468 }, "name": "VER_9_6_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 470 }, "name": "VER_9_6_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 472 }, "name": "VER_9_6_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 474 }, "name": "VER_9_6_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 476 }, "name": "VER_9_6_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 478 }, "name": "VER_9_6_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 464 }, "name": "VER_9_6_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"9.6.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 466 }, "name": "VER_9_6_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"9.6.25.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 555 }, "name": "auroraPostgresFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"9.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 557 }, "name": "auroraPostgresMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/cluster-engine:AuroraPostgresEngineVersion" }, "@aws-cdk/aws-rds.BackupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "default": "- The retention period for automated backups is 1 day.\nThe preferred backup window will be a 30-minute window selected at random\nfrom an 8-hour block of time for each AWS Region.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow", "stability": "stable", "summary": "Backup configuration for RDS databases.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as cdk from '@aws-cdk/core';\nconst backupProps: rds.BackupProps = {\n retention: cdk.Duration.minutes(30),\n\n // the properties below are optional\n preferredWindow: 'preferredWindow',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.BackupProps", "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 114 }, "name": "BackupProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "How many days to retain the backup." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 119 }, "name": "retention", "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- a 30-minute window selected at random from an 8-hour block of\ntime for each AWS Region. To see the time blocks available, see\nhttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow", "remarks": "Must be at least 30 minutes long.\n\nExample: '01:00-02:00'", "stability": "stable", "summary": "A daily time range in 24-hours UTC format in which backups preferably execute." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 132 }, "name": "preferredWindow", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/props:BackupProps" }, "@aws-cdk/aws-rds.CfnDBCluster": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBCluster", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBCluster` resource creates an Amazon Aurora DB cluster or Multi-AZ DB cluster.\n\nFor 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* .\n\nFor 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* .\n\n> You can only create this resource in AWS Regions where Amazon Aurora or Multi-AZ DB clusters are supported.\n\n*Updating DB clusters*\n\nWhen 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.\n\n> 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:\n>\n> - Deactivate any applications that are using the DB cluster so that there's no activity on the DB instance.\n> - 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) .\n> - 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.\n>\n> 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.\n> - Update the stack.\n\nCurrently, 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.\n\nFor 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) .\n\n*Deleting DB clusters*\n\nThe 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) .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBCluster`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBCluster = new rds.CfnDBCluster(this, 'MyCfnDBCluster', /* all optional props */ {\n allocatedStorage: 123,\n associatedRoles: [{\n roleArn: 'roleArn',\n\n // the properties below are optional\n featureName: 'featureName',\n }],\n autoMinorVersionUpgrade: false,\n availabilityZones: ['availabilityZones'],\n backtrackWindow: 123,\n backupRetentionPeriod: 123,\n copyTagsToSnapshot: false,\n databaseName: 'databaseName',\n dbClusterIdentifier: 'dbClusterIdentifier',\n dbClusterInstanceClass: 'dbClusterInstanceClass',\n dbClusterParameterGroupName: 'dbClusterParameterGroupName',\n dbInstanceParameterGroupName: 'dbInstanceParameterGroupName',\n dbSubnetGroupName: 'dbSubnetGroupName',\n dbSystemId: 'dbSystemId',\n deletionProtection: false,\n domain: 'domain',\n domainIamRoleName: 'domainIamRoleName',\n enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],\n enableHttpEndpoint: false,\n enableIamDatabaseAuthentication: false,\n engine: 'engine',\n engineMode: 'engineMode',\n engineVersion: 'engineVersion',\n globalClusterIdentifier: 'globalClusterIdentifier',\n iops: 123,\n kmsKeyId: 'kmsKeyId',\n manageMasterUserPassword: false,\n masterUsername: 'masterUsername',\n masterUserPassword: 'masterUserPassword',\n masterUserSecret: {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n },\n monitoringInterval: 123,\n monitoringRoleArn: 'monitoringRoleArn',\n networkType: 'networkType',\n performanceInsightsEnabled: false,\n performanceInsightsKmsKeyId: 'performanceInsightsKmsKeyId',\n performanceInsightsRetentionPeriod: 123,\n port: 123,\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n publiclyAccessible: false,\n replicationSourceIdentifier: 'replicationSourceIdentifier',\n restoreToTime: 'restoreToTime',\n restoreType: 'restoreType',\n scalingConfiguration: {\n autoPause: false,\n maxCapacity: 123,\n minCapacity: 123,\n secondsBeforeTimeout: 123,\n secondsUntilAutoPause: 123,\n timeoutAction: 'timeoutAction',\n },\n serverlessV2ScalingConfiguration: {\n maxCapacity: 123,\n minCapacity: 123,\n },\n snapshotIdentifier: 'snapshotIdentifier',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n sourceRegion: 'sourceRegion',\n storageEncrypted: false,\n storageType: 'storageType',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n useLatestRestorableTime: false,\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBCluster`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1828 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1010 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1903 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1966 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBCluster", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1014 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBClusterArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1039 }, "name": "attrDbClusterArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBClusterResourceId" }, "remarks": "This identifier is found in AWS CloudTrail log entries whenever the KMS key for the DB cluster is accessed.", "stability": "external", "summary": "The AWS Region -unique, immutable identifier for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1045 }, "name": "attrDbClusterResourceId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint.Address" }, "remarks": "For example: `mystack-mydbcluster-123456789012.us-east-2.rds.amazonaws.com`", "stability": "external", "summary": "The connection endpoint for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1051 }, "name": "attrEndpointAddress", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint.Port" }, "remarks": "For example: `3306`", "stability": "external", "summary": "The port number that will accept connections on this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1057 }, "name": "attrEndpointPort", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "MasterUserSecret.SecretArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1063 }, "name": "attrMasterUserSecretSecretArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "ReadEndpoint.Address" }, "remarks": "For example: `mystack-mydbcluster-ro-123456789012.us-east-2.rds.amazonaws.com`", "stability": "external", "summary": "The reader endpoint for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1069 }, "name": "attrReadEndpointAddress", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1908 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags" }, "remarks": "Valid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1799 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage" }, "remarks": "This setting is required to create a Multi-AZ DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1080 }, "name": "allocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles" }, "remarks": "IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1089 }, "name": "associatedRoles", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.DBClusterRoleProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade" }, "remarks": "By default, minor engine upgrades are applied automatically.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1098 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones" }, "remarks": "For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A list of Availability Zones (AZs) where instances in the DB cluster can be created." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1107 }, "name": "availabilityZones", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow" }, "remarks": "> Currently, Backtrack is only supported for Aurora MySQL DB clusters.\n\nDefault: 0\n\nConstraints:\n\n- If specified, this value must be set to a number from 0 to 259,200 (72 hours).\n\nValid for: Aurora MySQL DB clusters only", "stability": "external", "summary": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1124 }, "name": "backtrackWindow", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod" }, "remarks": "Default: 1\n\nConstraints:\n\n- Must be a value from 1 to 35\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The number of days for which automated backups are retained." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1139 }, "name": "backupRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot" }, "remarks": "The default is not to copy them.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1148 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename" }, "remarks": "If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of your database." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1157 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier" }, "remarks": "Constraints:\n\n- Must contain from 1 to 63 letters, numbers, or hyphens.\n- First character must be a letter.\n- Can't end with a hyphen or contain two consecutive hyphens.\n\nExample: `my-cluster1`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The DB cluster identifier. This parameter is stored as a lowercase string." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1174 }, "name": "dbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass" }, "remarks": "For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* .\n\nThis setting is required to create a Multi-AZ DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1187 }, "name": "dbClusterInstanceClass", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname" }, "remarks": "> If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n>\n> If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.\n\nTo list all of the available DB cluster parameter group names, use the following command:\n\n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the DB cluster parameter group to associate with this DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1204 }, "name": "dbClusterParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname" }, "remarks": "> When you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.\n\nDefault: The existing name setting\n\nConstraints:\n\n- The DB parameter group must be in the same DB parameter group family as this DB cluster.", "stability": "external", "summary": "The name of the DB parameter group to apply to all instances of the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1219 }, "name": "dbInstanceParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname" }, "remarks": "If you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write` , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A DB subnet group that you want to associate with this DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1230 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid" }, "stability": "external", "summary": "Reserved for future use." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1237 }, "name": "dbSystemId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection" }, "remarks": "The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether the DB cluster has deletion protection enabled." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1246 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain" }, "remarks": "For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.\n\nFor more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "Indicates the directory ID of the Active Directory to create the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1259 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "Specifies the name of the IAM role to use when making API calls to the Directory Service." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1268 }, "name": "domainIamRoleName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports" }, "remarks": "The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide* .\n\n*Aurora MySQL*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Aurora PostgreSQL*\n\nValid values: `postgresql`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1285 }, "name": "enableCloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint" }, "remarks": "By default, the HTTP endpoint is disabled.\n\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.\n\nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1298 }, "name": "enableHttpEndpoint", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication" }, "remarks": "By default, mapping is disabled.\n\nFor more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1309 }, "name": "enableIamDatabaseAuthentication", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine" }, "remarks": "Valid Values:\n\n- `aurora-mysql`\n- `aurora-postgresql`\n- `mysql`\n- `postgres`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the database engine to be used for this DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1325 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode" }, "remarks": "The `serverless` engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.\n\nLimitations and requirements apply to some DB engine modes. For more information, see the following sections in the *Amazon Aurora User Guide* :\n\n- [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\n- [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)\n- [Limitations of parallel query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)\n- [Limitations of Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The DB engine mode of the DB cluster, either `provisioned` or `serverless` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1343 }, "name": "engineMode", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion" }, "remarks": "To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:\n\n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"`\n\nYou can supply either `5.7` or `8.0` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.\n\nTo list all of the available engine versions for Aurora PostgreSQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"`\n\nTo list all of the available engine versions for RDS for MySQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"`\n\nTo list all of the available engine versions for RDS for PostgreSQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"`\n\n*Aurora MySQL*\n\nFor information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide* .\n\n*Aurora PostgreSQL*\n\nFor information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide* .\n\n*MySQL*\n\nFor information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide* .\n\n*PostgreSQL*\n\nFor information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide* .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The version number of the database engine to use." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1386 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier" }, "remarks": "To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource.\n\nIf you aren't configuring a global database cluster, don't specify this property.\n\n> To remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property.\n\nFor information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "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." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1401 }, "name": "globalClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops" }, "remarks": "For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide* .\n\nThis setting is required to create a Multi-AZ DB cluster.\n\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1416 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid" }, "remarks": "If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the `StorageEncrypted` property to `true` .\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "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` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1427 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*\n\nConstraints:\n\n- Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1442 }, "name": "manageMasterUserPassword", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername" }, "remarks": "> If you specify the `SourceDBClusterIdentifier` , `SnapshotIdentifier` , or `GlobalClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the master user for the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1453 }, "name": "masterUsername", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword" }, "remarks": "> If you specify the `SourceDBClusterIdentifier` , `SnapshotIdentifier` , or `GlobalClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The master password for the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1464 }, "name": "masterUserPassword", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", "stability": "external", "summary": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1473 }, "name": "masterUserSecret", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.MasterUserSecretProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval" }, "remarks": "To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.\n\nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than 0.\n\nValid Values: `0, 1, 5, 10, 15, 30, 60`\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1486 }, "name": "monitoringInterval", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn" }, "remarks": "An example is `arn:aws:iam:123456789012:role/emaccess` . For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide* .\n\nIf `MonitoringInterval` is set to a value other than 0, supply a `MonitoringRoleArn` value.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1497 }, "name": "monitoringRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype" }, "remarks": "Valid values:\n\n- `IPV4`\n- `DUAL`\n\nThe network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( `DUAL` ).\n\nFor more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The network type of the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1515 }, "name": "networkType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled" }, "remarks": "For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide* .\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether to turn on Performance Insights for the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1526 }, "name": "performanceInsightsEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid" }, "remarks": "The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n\nIf you don't specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The AWS KMS key identifier for encryption of Performance Insights data." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1539 }, "name": "performanceInsightsKmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod" }, "remarks": "- 7\n- *month* * 31, where *month* is a number of months from 1-23\n- 731\n\nFor example, the following values are valid:\n\n- 93 (3 months * 31)\n- 341 (11 months * 31)\n- 589 (19 months * 31)\n- 731\n\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1561 }, "name": "performanceInsightsRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port" }, "remarks": "Default:\n\n- When `EngineMode` is `provisioned` , `3306` (for both Aurora MySQL and Aurora PostgreSQL)\n- When `EngineMode` is `serverless` :\n\n- `3306` when `Engine` is `aurora` or `aurora-mysql`\n- `5432` when `Engine` is `aurora-postgresql`\n\n> The `No interruption` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The port number on which the DB instances in the DB cluster accept connections." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1580 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow" }, "remarks": "For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The daily time range during which automated backups are created." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1596 }, "name": "preferredBackupWindow", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow" }, "remarks": "Format: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*\n\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\n\nConstraints: Minimum 30-minute window.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1613 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible" }, "remarks": "When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.\n\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.\n\nDefault: The default behavior varies depending on whether `DBSubnetGroupName` is specified.\n\nIf `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:\n\n- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.\n- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.\n\nIf `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:\n\n- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.\n- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether the DB cluster is publicly accessible." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1638 }, "name": "publiclyAccessible", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1647 }, "name": "replicationSourceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime" }, "remarks": "Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n\nConstraints:\n\n- Must be before the latest restorable time for the DB instance\n- Must be specified if `UseLatestRestorableTime` parameter isn't provided\n- Can't be specified if the `UseLatestRestorableTime` parameter is enabled\n- Can't be specified if the `RestoreType` parameter is `copy-on-write`\n\nExample: `2015-03-07T23:45:00Z`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The date and time to restore the DB cluster to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1667 }, "name": "restoreToTime", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype" }, "remarks": "- `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.\n- `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.\n\nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The type of restore to be performed. You can specify one of the following values:." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1681 }, "name": "restoreType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration" }, "remarks": "This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property.\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1692 }, "name": "scalingConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ScalingConfigurationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration" }, "remarks": "This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use `ScalingConfiguration` property.\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1703 }, "name": "serverlessV2ScalingConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier" }, "remarks": "You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\n\nAfter 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 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.\n\nIf you specify the `SnapshotIdentifier` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:\n\n- `GlobalClusterIdentifier`\n- `MasterUsername`\n- `MasterUserPassword`\n- `ReplicationSourceIdentifier`\n- `RestoreType`\n- `SourceDBClusterIdentifier`\n- `SourceRegion`\n- `StorageEncrypted` (for an encrypted snapshot)\n- `UseLatestRestorableTime`\n\nConstraints:\n\n- Must match the identifier of an existing Snapshot.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The identifier for the DB snapshot or DB cluster snapshot to restore from." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1732 }, "name": "snapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier" }, "remarks": "Constraints:\n\n- Must match the identifier of an existing DBCluster.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1745 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1754 }, "name": "sourceRegion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted" }, "remarks": "If you specify the `KmsKeyId` property, then you must enable encryption.\n\nIf you specify the `SourceDBClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the `KmsKeyId` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to `false` .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "Indicates whether the DB cluster is encrypted." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1771 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype" }, "remarks": "This setting is required to create a Multi-AZ DB cluster.\n\nWhen specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.\n\nValid values: `aurora` , `aurora-iopt1` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)\n\nDefault: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters\n\nFor more information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type) . For more information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings) .", "stability": "external", "summary": "Specifies the storage type to be associated with the DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1790 }, "name": "storageType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime" }, "remarks": "By default, the DB cluster is not restored to the latest restorable backup time.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to restore the DB cluster to the latest restorable backup time." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1808 }, "name": "useLatestRestorableTime", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids" }, "remarks": "If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A list of EC2 VPC security groups to associate with this DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1819 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBCluster" }, "@aws-cdk/aws-rds.CfnDBCluster.DBClusterRoleProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB cluster.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst dBClusterRoleProperty: rds.CfnDBCluster.DBClusterRoleProperty = {\n roleArn: 'roleArn',\n\n // the properties below are optional\n featureName: 'featureName',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.DBClusterRoleProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1980 }, "name": "DBClusterRoleProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1992 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-dbclusterrole.html#cfn-rds-dbcluster-dbclusterrole-featurename" }, "remarks": "IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other AWS services on your behalf. For the list of supported feature names, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference* .", "stability": "external", "summary": "The name of the feature associated with the AWS Identity and Access Management (IAM) role." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 1986 }, "name": "featureName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.DBClusterRoleProperty" }, "@aws-cdk/aws-rds.CfnDBCluster.EndpointProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `Endpoint` return value specifies the connection endpoint for the primary instance of the DB cluster.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst endpointProperty: rds.CfnDBCluster.EndpointProperty = {\n address: 'address',\n port: 'port',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.EndpointProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2057 }, "name": "EndpointProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-address" }, "stability": "external", "summary": "Specifies the connection endpoint for the primary instance of the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2063 }, "name": "address", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-endpoint.html#cfn-rds-dbcluster-endpoint-port" }, "stability": "external", "summary": "Specifies the port that the database engine is listening on." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2069 }, "name": "port", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.EndpointProperty" }, "@aws-cdk/aws-rds.CfnDBCluster.MasterUserSecretProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", "stability": "external", "summary": "The `MasterUserSecret` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst masterUserSecretProperty: rds.CfnDBCluster.MasterUserSecretProperty = {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.MasterUserSecretProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2135 }, "name": "MasterUserSecretProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-kmskeyid" }, "stability": "external", "summary": "The AWS KMS key identifier that is used to encrypt the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2141 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-masterusersecret.html#cfn-rds-dbcluster-masterusersecret-secretarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2147 }, "name": "secretArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.MasterUserSecretProperty" }, "@aws-cdk/aws-rds.CfnDBCluster.ReadEndpointProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The reader endpoint for a DB cluster load-balances connections across the Aurora Replicas that are available in a DB cluster. As clients request new connections to the reader endpoint, Aurora distributes the connection requests among the Aurora Replicas in the DB cluster. This functionality can help balance your read workload across multiple Aurora Replicas in your DB cluster.\n\nIf a failover occurs, and the Aurora Replica that you are connected to is promoted to be the primary instance, your connection is dropped. To continue sending your read workload to other Aurora Replicas in the cluster, you can then reconnect to the reader endpoint.\n\nFor more information about Aurora endpoints, see [Amazon Aurora connection management](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.Endpoints.html) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "The `ReadEndpoint` return value specifies the reader endpoint for the DB cluster.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst readEndpointProperty: rds.CfnDBCluster.ReadEndpointProperty = {\n address: 'address',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ReadEndpointProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2217 }, "name": "ReadEndpointProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-readendpoint.html#cfn-rds-dbcluster-readendpoint-address" }, "stability": "external", "summary": "The host address of the reader endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2223 }, "name": "address", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.ReadEndpointProperty" }, "@aws-cdk/aws-rds.CfnDBCluster.ScalingConfigurationProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Using Amazon Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html) in the *Amazon Aurora User Guide* .\n\nThis property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property.\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst scalingConfigurationProperty: rds.CfnDBCluster.ScalingConfigurationProperty = {\n autoPause: false,\n maxCapacity: 123,\n minCapacity: 123,\n secondsBeforeTimeout: 123,\n secondsUntilAutoPause: 123,\n timeoutAction: 'timeoutAction',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ScalingConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2290 }, "name": "ScalingConfigurationProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-autopause" }, "remarks": "A DB cluster can be paused only when it's idle (it has no connections).\n\n> If a DB cluster is paused for more than seven days, the DB cluster might be backed up with a snapshot. In this case, the DB cluster is restored when there is a request to connect to it.", "stability": "external", "summary": "A value that indicates whether to allow or disallow automatic pause for an Aurora DB cluster in `serverless` DB engine mode." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2298 }, "name": "autoPause", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-maxcapacity" }, "remarks": "For Aurora MySQL, valid capacity values are `1` , `2` , `4` , `8` , `16` , `32` , `64` , `128` , and `256` .\n\nFor Aurora PostgreSQL, valid capacity values are `2` , `4` , `8` , `16` , `32` , `64` , `192` , and `384` .\n\nThe maximum capacity must be greater than or equal to the minimum capacity.", "stability": "external", "summary": "The maximum capacity for an Aurora DB cluster in `serverless` DB engine mode." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2310 }, "name": "maxCapacity", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-mincapacity" }, "remarks": "For Aurora MySQL, valid capacity values are `1` , `2` , `4` , `8` , `16` , `32` , `64` , `128` , and `256` .\n\nFor Aurora PostgreSQL, valid capacity values are `2` , `4` , `8` , `16` , `32` , `64` , `192` , and `384` .\n\nThe minimum capacity must be less than or equal to the maximum capacity.", "stability": "external", "summary": "The minimum capacity for an Aurora DB cluster in `serverless` DB engine mode." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2322 }, "name": "minCapacity", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsbeforetimeout" }, "remarks": "The default is 300.\n\nSpecify a value between 60 and 600 seconds.", "stability": "external", "summary": "The amount of time, in seconds, that Aurora Serverless v1 tries to find a scaling point to perform seamless scaling before enforcing the timeout action." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2330 }, "name": "secondsBeforeTimeout", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-secondsuntilautopause" }, "remarks": "Specify a value between 300 and 86,400 seconds.", "stability": "external", "summary": "The time, in seconds, before an Aurora DB cluster in `serverless` mode is paused." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2338 }, "name": "secondsUntilAutoPause", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-scalingconfiguration.html#cfn-rds-dbcluster-scalingconfiguration-timeoutaction" }, "remarks": "`ForceApplyCapacityChange` sets the capacity to the specified value as soon as possible.\n\n`RollbackCapacityChange` , the default, ignores the capacity change if a scaling point isn't found in the timeout period.\n\n> If you specify `ForceApplyCapacityChange` , connections that prevent Aurora Serverless v1 from finding a scaling point might be dropped.\n\nFor more information, see [Autoscaling for Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.how-it-works.html#aurora-serverless.how-it-works.auto-scaling) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "The action to take when the timeout is reached, either `ForceApplyCapacityChange` or `RollbackCapacityChange` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2352 }, "name": "timeoutAction", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.ScalingConfigurationProperty" }, "@aws-cdk/aws-rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Using Amazon Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.html) in the *Amazon Aurora User Guide* .\n\nIf you have an Aurora cluster, you must set the `ScalingConfigurationInfo` attribute before you add a DB instance that uses the `db.serverless` DB instance class. For more information, see [Clusters that use Aurora Serverless v2 must have a capacity range specified](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html#aurora-serverless-v2.requirements.capacity-range) in the *Amazon Aurora User Guide* .\n\nThis property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use `ScalingConfiguration` property.", "stability": "external", "summary": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst serverlessV2ScalingConfigurationProperty: rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty = {\n maxCapacity: 123,\n minCapacity: 123,\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2434 }, "name": "ServerlessV2ScalingConfigurationProperty", "namespace": "CfnDBCluster", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-maxcapacity" }, "remarks": "You can specify ACU values in half-step increments, such as 40, 40.5, 41, and so on. The largest value that you can use is 128.\n\nThe maximum capacity must be higher than 0.5 ACUs. For more information, see [Choosing the maximum Aurora Serverless v2 capacity setting for a cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.setting-capacity.html#aurora-serverless-v2.max_capacity_considerations) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "The maximum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2442 }, "name": "maxCapacity", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbcluster-serverlessv2scalingconfiguration.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration-mincapacity" }, "remarks": "You can specify ACU values in half-step increments, such as 8, 8.5, 9, and so on. The smallest value that you can use is 0.5.", "stability": "external", "summary": "The minimum number of Aurora capacity units (ACUs) for a DB instance in an Aurora Serverless v2 cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2448 }, "name": "minCapacity", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/rds.generated:CfnDBCluster.ServerlessV2ScalingConfigurationProperty" }, "@aws-cdk/aws-rds.CfnDBClusterParameterGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBClusterParameterGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBClusterParameterGroup` resource creates a new Amazon RDS DB cluster parameter group.\n\nFor information about configuring parameters for Amazon Aurora DB clusters, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* .\n\n> If you apply a parameter group to a DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n>\n> If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBClusterParameterGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameters: any;\nconst cfnDBClusterParameterGroup = new rds.CfnDBClusterParameterGroup(this, 'MyCfnDBClusterParameterGroup', {\n description: 'description',\n family: 'family',\n parameters: parameters,\n\n // the properties below are optional\n dbClusterParameterGroupName: 'dbClusterParameterGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBClusterParameterGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBClusterParameterGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2728 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterParameterGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2643 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2747 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2762 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBClusterParameterGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2647 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2752 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB cluster parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2719 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description" }, "stability": "external", "summary": "A friendly description for this DB cluster parameter group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2673 }, "name": "description", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family" }, "remarks": "A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.\n\n> The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.\n\nTo list all of the available parameter group families, use the following command:\n\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`\n\nThe output contains duplicates.\n\nFor more information, see `[CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)` .", "stability": "external", "summary": "The DB cluster parameter group family name." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2690 }, "name": "family", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters" }, "stability": "external", "summary": "Provides a list of parameters for the DB cluster parameter group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2697 }, "name": "parameters", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-dbclusterparametergroupname" }, "remarks": "Constraints:\n\n- Must not match the name of an existing DB cluster parameter group.\n\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster parameter group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the DB cluster parameter group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2712 }, "name": "dbClusterParameterGroupName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBClusterParameterGroup" }, "@aws-cdk/aws-rds.CfnDBClusterParameterGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBClusterParameterGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameters: any;\nconst cfnDBClusterParameterGroupProps: rds.CfnDBClusterParameterGroupProps = {\n description: 'description',\n family: 'family',\n parameters: parameters,\n\n // the properties below are optional\n dbClusterParameterGroupName: 'dbClusterParameterGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBClusterParameterGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2511 }, "name": "CfnDBClusterParameterGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-description" }, "stability": "external", "summary": "A friendly description for this DB cluster parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2518 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-family" }, "remarks": "A DB cluster parameter group can be associated with one and only one DB cluster parameter group family, and can be applied only to a DB cluster running a DB engine and engine version compatible with that DB cluster parameter group family.\n\n> The DB cluster parameter group family can't be changed when updating a DB cluster parameter group.\n\nTo list all of the available parameter group families, use the following command:\n\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`\n\nThe output contains duplicates.\n\nFor more information, see `[CreateDBClusterParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBClusterParameterGroup.html)` .", "stability": "external", "summary": "The DB cluster parameter group family name." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2535 }, "name": "family", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-parameters" }, "stability": "external", "summary": "Provides a list of parameters for the DB cluster parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2542 }, "name": "parameters", "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-dbclusterparametergroupname" }, "remarks": "Constraints:\n\n- Must not match the name of an existing DB cluster parameter group.\n\nIf you don't specify a value for `DBClusterParameterGroupName` property, a name is automatically created for the DB cluster parameter group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the DB cluster parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2557 }, "name": "dbClusterParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbclusterparametergroup.html#cfn-rds-dbclusterparametergroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB cluster parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2564 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBClusterParameterGroupProps" }, "@aws-cdk/aws-rds.CfnDBClusterProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBCluster`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBClusterProps: rds.CfnDBClusterProps = {\n allocatedStorage: 123,\n associatedRoles: [{\n roleArn: 'roleArn',\n\n // the properties below are optional\n featureName: 'featureName',\n }],\n autoMinorVersionUpgrade: false,\n availabilityZones: ['availabilityZones'],\n backtrackWindow: 123,\n backupRetentionPeriod: 123,\n copyTagsToSnapshot: false,\n databaseName: 'databaseName',\n dbClusterIdentifier: 'dbClusterIdentifier',\n dbClusterInstanceClass: 'dbClusterInstanceClass',\n dbClusterParameterGroupName: 'dbClusterParameterGroupName',\n dbInstanceParameterGroupName: 'dbInstanceParameterGroupName',\n dbSubnetGroupName: 'dbSubnetGroupName',\n dbSystemId: 'dbSystemId',\n deletionProtection: false,\n domain: 'domain',\n domainIamRoleName: 'domainIamRoleName',\n enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],\n enableHttpEndpoint: false,\n enableIamDatabaseAuthentication: false,\n engine: 'engine',\n engineMode: 'engineMode',\n engineVersion: 'engineVersion',\n globalClusterIdentifier: 'globalClusterIdentifier',\n iops: 123,\n kmsKeyId: 'kmsKeyId',\n manageMasterUserPassword: false,\n masterUsername: 'masterUsername',\n masterUserPassword: 'masterUserPassword',\n masterUserSecret: {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n },\n monitoringInterval: 123,\n monitoringRoleArn: 'monitoringRoleArn',\n networkType: 'networkType',\n performanceInsightsEnabled: false,\n performanceInsightsKmsKeyId: 'performanceInsightsKmsKeyId',\n performanceInsightsRetentionPeriod: 123,\n port: 123,\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n publiclyAccessible: false,\n replicationSourceIdentifier: 'replicationSourceIdentifier',\n restoreToTime: 'restoreToTime',\n restoreType: 'restoreType',\n scalingConfiguration: {\n autoPause: false,\n maxCapacity: 123,\n minCapacity: 123,\n secondsBeforeTimeout: 123,\n secondsUntilAutoPause: 123,\n timeoutAction: 'timeoutAction',\n },\n serverlessV2ScalingConfiguration: {\n maxCapacity: 123,\n minCapacity: 123,\n },\n snapshotIdentifier: 'snapshotIdentifier',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n sourceRegion: 'sourceRegion',\n storageEncrypted: false,\n storageType: 'storageType',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n useLatestRestorableTime: false,\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 19 }, "name": "CfnDBClusterProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-allocatedstorage" }, "remarks": "This setting is required to create a Multi-AZ DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The amount of storage in gibibytes (GiB) to allocate to each DB instance in the Multi-AZ DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 30 }, "name": "allocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-associatedroles" }, "remarks": "IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon Web Services on your behalf.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "Provides a list of the AWS Identity and Access Management (IAM) roles that are associated with the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 39 }, "name": "associatedRoles", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.DBClusterRoleProperty" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-autominorversionupgrade" }, "remarks": "By default, minor engine upgrades are applied automatically.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether minor engine upgrades are applied automatically to the DB cluster during the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 48 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-availabilityzones" }, "remarks": "For information on AWS Regions and Availability Zones, see [Choosing the Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Concepts.RegionsAndAvailabilityZones.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A list of Availability Zones (AZs) where instances in the DB cluster can be created." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 57 }, "name": "availabilityZones", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backtrackwindow" }, "remarks": "> Currently, Backtrack is only supported for Aurora MySQL DB clusters.\n\nDefault: 0\n\nConstraints:\n\n- If specified, this value must be set to a number from 0 to 259,200 (72 hours).\n\nValid for: Aurora MySQL DB clusters only", "stability": "external", "summary": "The target backtrack window, in seconds. To disable backtracking, set this value to 0." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 74 }, "name": "backtrackWindow", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-backupretentionperiod" }, "remarks": "Default: 1\n\nConstraints:\n\n- Must be a value from 1 to 35\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The number of days for which automated backups are retained." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 89 }, "name": "backupRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-copytagstosnapshot" }, "remarks": "The default is not to copy them.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to copy all tags from the DB cluster to snapshots of the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 98 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-databasename" }, "remarks": "If you don't provide a name, then Amazon RDS won't create a database in this DB cluster. For naming constraints, see [Naming Constraints](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of your database." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 107 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusteridentifier" }, "remarks": "Constraints:\n\n- Must contain from 1 to 63 letters, numbers, or hyphens.\n- First character must be a letter.\n- Can't end with a hyphen or contain two consecutive hyphens.\n\nExample: `my-cluster1`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The DB cluster identifier. This parameter is stored as a lowercase string." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 124 }, "name": "dbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterinstanceclass" }, "remarks": "For the full list of DB instance classes and availability for your engine, see [DB instance class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide* .\n\nThis setting is required to create a Multi-AZ DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 137 }, "name": "dbClusterInstanceClass", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbclusterparametergroupname" }, "remarks": "> If you apply a parameter group to an existing DB cluster, then its DB instances might need to reboot. This can result in an outage while the DB instances are rebooting.\n>\n> If you apply a change to parameter group associated with a stopped DB cluster, then the update stack waits until the DB cluster is started.\n\nTo list all of the available DB cluster parameter group names, use the following command:\n\n`aws rds describe-db-cluster-parameter-groups --query \"DBClusterParameterGroups[].DBClusterParameterGroupName\" --output text`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the DB cluster parameter group to associate with this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 154 }, "name": "dbClusterParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbinstanceparametergroupname" }, "remarks": "> When you apply a parameter group using the `DBInstanceParameterGroupName` parameter, the DB cluster isn't rebooted automatically. Also, parameter changes are applied immediately rather than during the next maintenance window.\n\nDefault: The existing name setting\n\nConstraints:\n\n- The DB parameter group must be in the same DB parameter group family as this DB cluster.", "stability": "external", "summary": "The name of the DB parameter group to apply to all instances of the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 169 }, "name": "dbInstanceParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsubnetgroupname" }, "remarks": "If you are restoring a DB cluster to a point in time with `RestoreType` set to `copy-on-write` , and don't specify a DB subnet group name, then the DB cluster is restored with a default DB subnet group.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A DB subnet group that you want to associate with this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 180 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-dbsystemid" }, "stability": "external", "summary": "Reserved for future use." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 187 }, "name": "dbSystemId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-deletionprotection" }, "remarks": "The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether the DB cluster has deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 196 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domain" }, "remarks": "For Amazon Aurora DB clusters, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB cluster.\n\nFor more information, see [Kerberos authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/kerberos-authentication.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "Indicates the directory ID of the Active Directory to create the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 209 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-domainiamrolename" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "Specifies the name of the IAM role to use when making API calls to the Directory Service." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 218 }, "name": "domainIamRoleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablecloudwatchlogsexports" }, "remarks": "The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Aurora User Guide* .\n\n*Aurora MySQL*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Aurora PostgreSQL*\n\nValid values: `postgresql`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 235 }, "name": "enableCloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enablehttpendpoint" }, "remarks": "By default, the HTTP endpoint is disabled.\n\nWhen enabled, the HTTP endpoint provides a connectionless web service API for running SQL queries on the Aurora Serverless DB cluster. You can also query your database from inside the RDS console with the query editor.\n\nFor more information, see [Using the Data API for Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A value that indicates whether to enable the HTTP endpoint for an Aurora Serverless DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 248 }, "name": "enableHttpEndpoint", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enableiamdatabaseauthentication" }, "remarks": "By default, mapping is disabled.\n\nFor more information, see [IAM Database Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon Aurora User Guide.*\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 259 }, "name": "enableIamDatabaseAuthentication", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engine" }, "remarks": "Valid Values:\n\n- `aurora-mysql`\n- `aurora-postgresql`\n- `mysql`\n- `postgres`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the database engine to be used for this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 275 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-enginemode" }, "remarks": "The `serverless` engine mode only supports Aurora Serverless v1. Currently, AWS CloudFormation doesn't support Aurora Serverless v2.\n\nLimitations and requirements apply to some DB engine modes. For more information, see the following sections in the *Amazon Aurora User Guide* :\n\n- [Limitations of Aurora Serverless v1](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless.html#aurora-serverless.limitations)\n- [Requirements for Aurora Serverless v2](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-serverless-v2.requirements.html)\n- [Limitations of parallel query](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-mysql-parallel-query.html#aurora-mysql-parallel-query-limitations)\n- [Limitations of Aurora global databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html#aurora-global-database.limitations)\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The DB engine mode of the DB cluster, either `provisioned` or `serverless` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 293 }, "name": "engineMode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-engineversion" }, "remarks": "To list all of the available engine versions for Aurora MySQL version 2 (5.7-compatible) and version 3 (8.0-compatible), use the following command:\n\n`aws rds describe-db-engine-versions --engine aurora-mysql --query \"DBEngineVersions[].EngineVersion\"`\n\nYou can supply either `5.7` or `8.0` to use the default engine version for Aurora MySQL version 2 or version 3, respectively.\n\nTo list all of the available engine versions for Aurora PostgreSQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine aurora-postgresql --query \"DBEngineVersions[].EngineVersion\"`\n\nTo list all of the available engine versions for RDS for MySQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine mysql --query \"DBEngineVersions[].EngineVersion\"`\n\nTo list all of the available engine versions for RDS for PostgreSQL, use the following command:\n\n`aws rds describe-db-engine-versions --engine postgres --query \"DBEngineVersions[].EngineVersion\"`\n\n*Aurora MySQL*\n\nFor information, see [Database engine updates for Amazon Aurora MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Updates.html) in the *Amazon Aurora User Guide* .\n\n*Aurora PostgreSQL*\n\nFor information, see [Amazon Aurora PostgreSQL releases and engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Updates.20180305.html) in the *Amazon Aurora User Guide* .\n\n*MySQL*\n\nFor information, see [Amazon RDS for MySQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide* .\n\n*PostgreSQL*\n\nFor information, see [Amazon RDS for PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts) in the *Amazon RDS User Guide* .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The version number of the database engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 336 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-globalclusteridentifier" }, "remarks": "To define the primary database cluster of the global cluster, use the [AWS::RDS::GlobalCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html) resource.\n\nIf you aren't configuring a global database cluster, don't specify this property.\n\n> To remove the DB cluster from a global database cluster, specify an empty value for the `GlobalClusterIdentifier` property.\n\nFor information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide* .\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "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." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 351 }, "name": "globalClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-iops" }, "remarks": "For information about valid IOPS values, see [Provisioned IOPS storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide* .\n\nThis setting is required to create a Multi-AZ DB cluster.\n\nConstraints: Must be a multiple between .5 and 50 of the storage amount for the DB cluster.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The amount of Provisioned IOPS (input/output operations per second) to be initially allocated for each DB instance in the Multi-AZ DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 366 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-kmskeyid" }, "remarks": "If you enable the `StorageEncrypted` property but don't specify this property, the default KMS key is used. If you specify this property, you must set the `StorageEncrypted` property to `true` .\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "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` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 377 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-managemasteruserpassword" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*\n\nConstraints:\n\n- Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 392 }, "name": "manageMasterUserPassword", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusername" }, "remarks": "> If you specify the `SourceDBClusterIdentifier` , `SnapshotIdentifier` , or `GlobalClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The name of the master user for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 403 }, "name": "masterUsername", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masteruserpassword" }, "remarks": "> If you specify the `SourceDBClusterIdentifier` , `SnapshotIdentifier` , or `GlobalClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, the snapshot, or the primary DB cluster for the global database cluster, respectively.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The master password for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 414 }, "name": "masterUserPassword", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-masterusersecret" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", "stability": "external", "summary": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 423 }, "name": "masterUserSecret", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.MasterUserSecretProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringinterval" }, "remarks": "To turn off collecting Enhanced Monitoring metrics, specify 0. The default is 0.\n\nIf `MonitoringRoleArn` is specified, also set `MonitoringInterval` to a value other than 0.\n\nValid Values: `0, 1, 5, 10, 15, 30, 60`\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 436 }, "name": "monitoringInterval", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-monitoringrolearn" }, "remarks": "An example is `arn:aws:iam:123456789012:role/emaccess` . For information on creating a monitoring role, see [Setting up and enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide* .\n\nIf `MonitoringInterval` is set to a value other than 0, supply a `MonitoringRoleArn` value.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The Amazon Resource Name (ARN) for the IAM role that permits RDS to send Enhanced Monitoring metrics to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 447 }, "name": "monitoringRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-networktype" }, "remarks": "Valid values:\n\n- `IPV4`\n- `DUAL`\n\nThe network type is determined by the `DBSubnetGroup` specified for the DB cluster. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( `DUAL` ).\n\nFor more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon Aurora User Guide.*\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The network type of the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 465 }, "name": "networkType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsenabled" }, "remarks": "For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide* .\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether to turn on Performance Insights for the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 476 }, "name": "performanceInsightsEnabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightskmskeyid" }, "remarks": "The AWS KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n\nIf you don't specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account . Your AWS account has a different default KMS key for each AWS Region .\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The AWS KMS key identifier for encryption of Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 489 }, "name": "performanceInsightsKmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-performanceinsightsretentionperiod" }, "remarks": "- 7\n- *month* * 31, where *month* is a number of months from 1-23\n- 731\n\nFor example, the following values are valid:\n\n- 93 (3 months * 31)\n- 341 (11 months * 31)\n- 589 (19 months * 31)\n- 731\n\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 511 }, "name": "performanceInsightsRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-port" }, "remarks": "Default:\n\n- When `EngineMode` is `provisioned` , `3306` (for both Aurora MySQL and Aurora PostgreSQL)\n- When `EngineMode` is `serverless` :\n\n- `3306` when `Engine` is `aurora` or `aurora-mysql`\n- `5432` when `Engine` is `aurora-postgresql`\n\n> The `No interruption` on update behavior only applies to DB clusters. If you are updating a DB instance, see [Port](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-port) for the AWS::RDS::DBInstance resource.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The port number on which the DB instances in the DB cluster accept connections." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 530 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredbackupwindow" }, "remarks": "For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.Backups.BackupWindow) in the *Amazon Aurora User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The daily time range during which automated backups are created." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 546 }, "name": "preferredBackupWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-preferredmaintenancewindow" }, "remarks": "Format: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Cluster Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow.Aurora) in the *Amazon Aurora User Guide.*\n\nValid Days: Mon, Tue, Wed, Thu, Fri, Sat, Sun.\n\nConstraints: Minimum 30-minute window.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 563 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-publiclyaccessible" }, "remarks": "When the DB cluster is publicly accessible, its Domain Name System (DNS) endpoint resolves to the private IP address from within the DB cluster's virtual private cloud (VPC). It resolves to the public IP address from outside of the DB cluster's VPC. Access to the DB cluster is ultimately controlled by the security group it uses. That public access isn't permitted if the security group assigned to the DB cluster doesn't permit it.\n\nWhen the DB cluster isn't publicly accessible, it is an internal DB cluster with a DNS name that resolves to a private IP address.\n\nDefault: The default behavior varies depending on whether `DBSubnetGroupName` is specified.\n\nIf `DBSubnetGroupName` isn't specified, and `PubliclyAccessible` isn't specified, the following applies:\n\n- If the default VPC in the target Region doesn’t have an internet gateway attached to it, the DB cluster is private.\n- If the default VPC in the target Region has an internet gateway attached to it, the DB cluster is public.\n\nIf `DBSubnetGroupName` is specified, and `PubliclyAccessible` isn't specified, the following applies:\n\n- If the subnets are part of a VPC that doesn’t have an internet gateway attached to it, the DB cluster is private.\n- If the subnets are part of a VPC that has an internet gateway attached to it, the DB cluster is public.\n\nValid for: Multi-AZ DB clusters only", "stability": "external", "summary": "A value that indicates whether the DB cluster is publicly accessible." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 588 }, "name": "publiclyAccessible", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-replicationsourceidentifier" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the source DB instance or DB cluster if this DB cluster is created as a read replica." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 597 }, "name": "replicationSourceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretotime" }, "remarks": "Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n\nConstraints:\n\n- Must be before the latest restorable time for the DB instance\n- Must be specified if `UseLatestRestorableTime` parameter isn't provided\n- Can't be specified if the `UseLatestRestorableTime` parameter is enabled\n- Can't be specified if the `RestoreType` parameter is `copy-on-write`\n\nExample: `2015-03-07T23:45:00Z`\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The date and time to restore the DB cluster to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 617 }, "name": "restoreToTime", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-restoretype" }, "remarks": "- `full-copy` - The new DB cluster is restored as a full copy of the source DB cluster.\n- `copy-on-write` - The new DB cluster is restored as a clone of the source DB cluster.\n\nIf you don't specify a `RestoreType` value, then the new DB cluster is restored as a full copy of the source DB cluster.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The type of restore to be performed. You can specify one of the following values:." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 631 }, "name": "restoreType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-scalingconfiguration" }, "remarks": "This property is only supported for Aurora Serverless v1. For Aurora Serverless v2, use `ServerlessV2ScalingConfiguration` property.\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The `ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 642 }, "name": "scalingConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ScalingConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-serverlessv2scalingconfiguration" }, "remarks": "This property is only supported for Aurora Serverless v2. For Aurora Serverless v1, use `ScalingConfiguration` property.\n\nValid for: Aurora DB clusters only", "stability": "external", "summary": "The `ServerlessV2ScalingConfiguration` property type specifies the scaling configuration of an Aurora Serverless V2 DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 653 }, "name": "serverlessV2ScalingConfiguration", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBCluster.ServerlessV2ScalingConfigurationProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-snapshotidentifier" }, "remarks": "You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot. However, you can use only the ARN to specify a DB snapshot.\n\nAfter 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 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.\n\nIf you specify the `SnapshotIdentifier` property to restore a DB cluster (as opposed to specifying it for DB cluster updates), then don't specify the following properties:\n\n- `GlobalClusterIdentifier`\n- `MasterUsername`\n- `MasterUserPassword`\n- `ReplicationSourceIdentifier`\n- `RestoreType`\n- `SourceDBClusterIdentifier`\n- `SourceRegion`\n- `StorageEncrypted` (for an encrypted snapshot)\n- `UseLatestRestorableTime`\n\nConstraints:\n\n- Must match the identifier of an existing Snapshot.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "The identifier for the DB snapshot or DB cluster snapshot to restore from." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 682 }, "name": "snapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourcedbclusteridentifier" }, "remarks": "Constraints:\n\n- Must match the identifier of an existing DBCluster.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "When restoring a DB cluster to a point in time, the identifier of the source DB cluster from which to restore." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 695 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-sourceregion" }, "remarks": "Valid for: Aurora DB clusters only", "stability": "external", "summary": "The AWS Region which contains the source DB cluster when replicating a DB cluster. For example, `us-east-1` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 704 }, "name": "sourceRegion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storageencrypted" }, "remarks": "If you specify the `KmsKeyId` property, then you must enable encryption.\n\nIf you specify the `SourceDBClusterIdentifier` property, don't specify this property. The value is inherited from the source DB cluster, and if the DB cluster is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB cluster is encrypted. Specify the `KmsKeyId` property for the KMS key to use for encryption. If you don't want the restored DB cluster to be encrypted, then don't set this property or set it to `false` .\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "Indicates whether the DB cluster is encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 721 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-storagetype" }, "remarks": "This setting is required to create a Multi-AZ DB cluster.\n\nWhen specified for a Multi-AZ DB cluster, a value for the `Iops` parameter is required.\n\nValid values: `aurora` , `aurora-iopt1` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)\n\nDefault: `aurora` (Aurora DB clusters); `io1` (Multi-AZ DB clusters)\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters\n\nFor more information on storage types for Aurora DB clusters, see [Storage configurations for Amazon Aurora DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Overview.StorageReliability.html#aurora-storage-type) . For more information on storage types for Multi-AZ DB clusters, see [Settings for creating Multi-AZ DB clusters](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/create-multi-az-db-cluster.html#create-multi-az-db-cluster-settings) .", "stability": "external", "summary": "Specifies the storage type to be associated with the DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 740 }, "name": "storageType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-tags" }, "remarks": "Valid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 749 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-uselatestrestorabletime" }, "remarks": "By default, the DB cluster is not restored to the latest restorable backup time.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A value that indicates whether to restore the DB cluster to the latest restorable backup time." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 758 }, "name": "useLatestRestorableTime", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html#cfn-rds-dbcluster-vpcsecuritygroupids" }, "remarks": "If you plan to update the resource, don't specify VPC security groups in a shared VPC.\n\nValid for: Aurora DB clusters and Multi-AZ DB clusters", "stability": "external", "summary": "A list of EC2 VPC security groups to associate with this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 769 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBClusterProps" }, "@aws-cdk/aws-rds.CfnDBInstance": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBInstance", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBInstance` resource creates an Amazon DB instance. The new DB instance can be an RDS DB instance, or it can be a DB instance in an Aurora DB cluster.\n\nFor more information about creating an RDS DB instance, see [Creating an Amazon RDS DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateDBInstance.html) in the *Amazon RDS User Guide* .\n\nFor more information about creating a DB instance in 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* .\n\nIf you import an existing DB instance, and the template configuration doesn't match the actual configuration of the DB instance, AWS CloudFormation applies the changes in the template during the import operation.\n\n> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced. For more information, see [Prevent Updates to Stack Resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/protect-stack-resources.html) .\n\n*Updating DB instances*\n\nWhen 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 instance, then changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.\n\n> 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 instance. To preserve your data, perform the following procedure:\n>\n> - Deactivate any applications that are using the DB instance so that there's no activity on the DB instance.\n> - Create a snapshot of the DB instance. For more information, see [Creating a DB Snapshot](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_CreateSnapshot.html) .\n> - If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use.\n>\n> After you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.\n> - Update the stack.\n\nFor more information about updating other properties of this resource, see `[ModifyDBInstance](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_ModifyDBInstance.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) .\n\n*Deleting DB instances*\n\nFor DB instances that are part of an Aurora DB cluster, you can set a deletion policy for your DB instance to control how AWS CloudFormation handles the DB instance when the stack is deleted. For Amazon RDS DB instances, you can choose to *retain* the DB instance, to *delete* the DB instance, or to *create a snapshot* of the DB instance. The default AWS CloudFormation behavior depends on the `DBClusterIdentifier` property:\n\n- For `AWS::RDS::DBInstance` resources that don't specify the `DBClusterIdentifier` property, AWS CloudFormation saves a snapshot of the DB instance.\n- For `AWS::RDS::DBInstance` resources that do specify the `DBClusterIdentifier` property, AWS CloudFormation deletes the DB instance.\n\nFor more information, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBInstance`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBInstance = new rds.CfnDBInstance(this, 'MyCfnDBInstance', /* all optional props */ {\n allocatedStorage: 'allocatedStorage',\n allowMajorVersionUpgrade: false,\n associatedRoles: [{\n featureName: 'featureName',\n roleArn: 'roleArn',\n }],\n autoMinorVersionUpgrade: false,\n availabilityZone: 'availabilityZone',\n backupRetentionPeriod: 123,\n caCertificateIdentifier: 'caCertificateIdentifier',\n certificateDetails: {\n caIdentifier: 'caIdentifier',\n validTill: 'validTill',\n },\n certificateRotationRestart: false,\n characterSetName: 'characterSetName',\n copyTagsToSnapshot: false,\n customIamInstanceProfile: 'customIamInstanceProfile',\n dbClusterIdentifier: 'dbClusterIdentifier',\n dbClusterSnapshotIdentifier: 'dbClusterSnapshotIdentifier',\n dbInstanceClass: 'dbInstanceClass',\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n dbName: 'dbName',\n dbParameterGroupName: 'dbParameterGroupName',\n dbSecurityGroups: ['dbSecurityGroups'],\n dbSnapshotIdentifier: 'dbSnapshotIdentifier',\n dbSubnetGroupName: 'dbSubnetGroupName',\n deleteAutomatedBackups: false,\n deletionProtection: false,\n domain: 'domain',\n domainIamRoleName: 'domainIamRoleName',\n enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],\n enableIamDatabaseAuthentication: false,\n enablePerformanceInsights: false,\n endpoint: {\n address: 'address',\n hostedZoneId: 'hostedZoneId',\n port: 'port',\n },\n engine: 'engine',\n engineVersion: 'engineVersion',\n iops: 123,\n kmsKeyId: 'kmsKeyId',\n licenseModel: 'licenseModel',\n manageMasterUserPassword: false,\n masterUsername: 'masterUsername',\n masterUserPassword: 'masterUserPassword',\n masterUserSecret: {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n },\n maxAllocatedStorage: 123,\n monitoringInterval: 123,\n monitoringRoleArn: 'monitoringRoleArn',\n multiAz: false,\n ncharCharacterSetName: 'ncharCharacterSetName',\n networkType: 'networkType',\n optionGroupName: 'optionGroupName',\n performanceInsightsKmsKeyId: 'performanceInsightsKmsKeyId',\n performanceInsightsRetentionPeriod: 123,\n port: 'port',\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n processorFeatures: [{\n name: 'name',\n value: 'value',\n }],\n promotionTier: 123,\n publiclyAccessible: false,\n replicaMode: 'replicaMode',\n restoreTime: 'restoreTime',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n sourceDbInstanceAutomatedBackupsArn: 'sourceDbInstanceAutomatedBackupsArn',\n sourceDbInstanceIdentifier: 'sourceDbInstanceIdentifier',\n sourceDbiResourceId: 'sourceDbiResourceId',\n sourceRegion: 'sourceRegion',\n storageEncrypted: false,\n storageThroughput: 123,\n storageType: 'storageType',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timezone: 'timezone',\n useDefaultProcessorFeatures: false,\n useLatestRestorableTime: false,\n vpcSecurityGroups: ['vpcSecurityGroups'],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBInstance`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5388 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4182 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5481 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5559 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBInstance", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4186 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "CertificateDetails.CAIdentifier" }, "stability": "external", "summary": "The CA identifier of the CA certificate used for the DB instance's server certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4211 }, "name": "attrCertificateDetailsCaIdentifier", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "CertificateDetails.ValidTill" }, "stability": "external", "summary": "The expiration date of the DB instance’s server certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4217 }, "name": "attrCertificateDetailsValidTill", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBInstanceArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4223 }, "name": "attrDbInstanceArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DbiResourceId" }, "remarks": "This identifier is found in AWS CloudTrail log entries whenever the AWS KMS key for the DB instance is accessed.", "stability": "external", "summary": "The AWS Region-unique, immutable identifier for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4237 }, "name": "attrDbiResourceId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBSystemId" }, "remarks": "The Oracle SID is also the name of the CDB.\n\nThis setting is valid for RDS Custom only.", "stability": "external", "summary": "The Oracle system ID (Oracle SID) for a container database (CDB)." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4231 }, "name": "attrDbSystemId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint.Address" }, "remarks": "For Aurora Serverless DB clusters, the connection endpoint only applies to the DB cluster.", "stability": "external", "summary": "The connection endpoint for the database. For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com`." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4245 }, "name": "attrEndpointAddress", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint.HostedZoneId" }, "stability": "external", "summary": "The ID that Amazon Route 53 assigns when you create a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4251 }, "name": "attrEndpointHostedZoneId", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint.Port" }, "remarks": "For example: `3306`", "stability": "external", "summary": "The port number on which the database accepts connections." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4257 }, "name": "attrEndpointPort", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "MasterUserSecret.SecretArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4263 }, "name": "attrMasterUserSecretSecretArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5486 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5331 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allocatedstorage" }, "remarks": "> If any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the `Iops` value (in 1,000 IOPS increments), then you must also increase the `AllocatedStorage` value (in 100-GiB increments).\n\n*Amazon Aurora*\n\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n\n*MySQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*MariaDB*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*PostgreSQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*Oracle*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 10 to 3072.\n\n*SQL Server*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Provisioned IOPS storage (io1):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Magnetic storage (standard):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 1024.\n- Web and Express editions: Must be an integer from 20 to 1024.", "stability": "external", "summary": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4325 }, "name": "allocatedStorage", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allowmajorversionupgrade" }, "remarks": "Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n\nConstraints: Major version upgrades must be allowed when specifying a value for the `EngineVersion` parameter that is a different major version than the DB instance's current version.", "stability": "external", "summary": "A value that indicates whether major version upgrades are allowed." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4334 }, "name": "allowMajorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-associatedroles" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The associated roles are managed by the DB cluster.", "stability": "external", "summary": "The AWS Identity and Access Management (IAM) roles associated with the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4345 }, "name": "associatedRoles", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.DBInstanceRoleProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-autominorversionupgrade" }, "remarks": "By default, minor engine upgrades are applied automatically.", "stability": "external", "summary": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4352 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-availabilityzone" }, "remarks": "For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) .\n\n*Amazon Aurora*\n\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region .\n\nExample: `us-east-1d`\n\nConstraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.", "stability": "external", "summary": "The Availability Zone (AZ) where the database will be created." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4369 }, "name": "availabilityZone", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-backupretentionperiod" }, "remarks": "Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n\n*Amazon Aurora*\n\nNot applicable. The retention period for automated backups is managed by the DB cluster.\n\nDefault: 1\n\nConstraints:\n\n- Must be a value from 0 to 35\n- Can't be set to 0 if the DB instance is a source to read replicas", "stability": "external", "summary": "The number of days for which automated backups are retained." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4387 }, "name": "backupRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-cacertificateidentifier" }, "remarks": "> Specifying or updating this property triggers a reboot.\n\nFor more information about CA certificate identifiers for RDS DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide* .\n\nFor more information about CA certificate identifiers for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "The identifier of the CA certificate for this DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4400 }, "name": "caCertificateIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificatedetails" }, "stability": "external", "summary": "The details of the DB instance's server certificate." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4407 }, "name": "certificateDetails", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.CertificateDetailsProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificaterotationrestart" }, "remarks": "By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n\n> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n\n- For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*\n- For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide* .\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4425 }, "name": "certificateRotationRestart", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-charactersetname" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html) .", "stability": "external", "summary": "For supported engines, indicates that the DB instance should be associated with the specified character set." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4436 }, "name": "characterSetName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-copytagstosnapshot" }, "remarks": "By default, tags are not copied.\n\n*Amazon Aurora*\n\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.", "stability": "external", "summary": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4447 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-customiaminstanceprofile" }, "remarks": "The instance profile must meet the following requirements:\n\n- The profile must exist in your account.\n- The profile must have an IAM role that Amazon EC2 has permissions to assume.\n- The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom` .\n\nFor the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide* .\n\nThis setting is required for RDS Custom.", "stability": "external", "summary": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4462 }, "name": "customIamInstanceProfile", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier" }, "stability": "external", "summary": "The identifier of the DB cluster that the instance will belong to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4469 }, "name": "dbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclustersnapshotidentifier" }, "remarks": "For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide* .\n\nConstraints:\n\n- Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n- Can't be specified when `DBSnapshotIdentifier` is specified.\n- Must be specified when `DBSnapshotIdentifier` isn't specified.\n- If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot.\n- Can't be the identifier of an Aurora DB cluster snapshot.\n- Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.", "stability": "external", "summary": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4487 }, "name": "dbClusterSnapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceclass" }, "remarks": "For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/) .", "stability": "external", "summary": "The compute and memory capacity of the DB instance, for example, `db.m4.large` . Not all DB instance classes are available in all AWS Regions, or for all database engines." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4496 }, "name": "dbInstanceClass", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceidentifier" }, "remarks": "If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide* .\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4507 }, "name": "dbInstanceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbname" }, "remarks": "> If you specify the `[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle.\n\n*Amazon Aurora*\n\nNot applicable. The database name is managed by the DB cluster.\n\n*MySQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*MariaDB*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*PostgreSQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, the default `postgres` database is created in the DB instance.\n\nConstraints:\n\n- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n- Must contain 1 to 63 characters.\n- Can't be a word reserved by the specified database engine\n\n*Oracle*\n\nThe Oracle System ID (SID) of the created DB instance. If you specify `null` , the default value `ORCL` is used. You can't specify the string NULL, or any other reserved word, for `DBName` .\n\nDefault: `ORCL`\n\nConstraints:\n\n- Can't be longer than 8 characters\n\n*SQL Server*\n\nNot applicable. Must be null.", "stability": "external", "summary": "The meaning of this parameter differs according to the database engine you use." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4562 }, "name": "dbName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbparametergroupname" }, "remarks": "To list all of the available DB parameter group names, use the following command:\n\n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`\n\n> If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n\nIf you don't specify a value for `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used.", "stability": "external", "summary": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4577 }, "name": "dbParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsecuritygroups" }, "remarks": "The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n\nIf you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n\n> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n>\n> - `AllocatedStorage`\n> - `AutoMinorVersionUpgrade`\n> - `AvailabilityZone`\n> - `BackupRetentionPeriod`\n> - `CharacterSetName`\n> - `DBInstanceClass`\n> - `DBName`\n> - `DBParameterGroupName`\n> - `DBSecurityGroups`\n> - `DBSubnetGroupName`\n> - `Engine`\n> - `EngineVersion`\n> - `Iops`\n> - `LicenseModel`\n> - `MasterUsername`\n> - `MasterUserPassword`\n> - `MultiAZ`\n> - `OptionGroupName`\n> - `PreferredBackupWindow`\n> - `PreferredMaintenanceWindow`\n>\n> All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as `StorageType` , `StorageEncrypted` , or `KmsKeyId` . If you're already using the `DBSecurityGroups` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", "stability": "external", "summary": "A list of the DB security groups to assign to the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4611 }, "name": "dbSecurityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsnapshotidentifier" }, "remarks": "If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n\nBy specifying this property, you can create a DB instance from the specified DB snapshot. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n\nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference* .\n\nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.\n\nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n\n- `CharacterSetName`\n- `DBClusterIdentifier`\n- `DBName`\n- `DeleteAutomatedBackups`\n- `EnablePerformanceInsights`\n- `KmsKeyId`\n- `MasterUsername`\n- `MasterUserPassword`\n- `PerformanceInsightsKMSKeyId`\n- `PerformanceInsightsRetentionPeriod`\n- `PromotionTier`\n- `SourceDBInstanceIdentifier`\n- `SourceRegion`\n- `StorageEncrypted` (for an encrypted snapshot)\n- `Timezone`\n\n*Amazon Aurora*\n\nNot applicable. Snapshot restore is managed by the DB cluster.", "stability": "external", "summary": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4646 }, "name": "dbSnapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname" }, "remarks": "If you update this value, the new subnet group must be a subnet group in a new VPC.\n\nIf there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n\nFor more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "stability": "external", "summary": "A DB subnet group to associate with the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4661 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deleteautomatedbackups" }, "remarks": "This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n\n*Amazon Aurora*\n\nNot applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.", "stability": "external", "summary": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4672 }, "name": "deleteAutomatedBackups", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection" }, "remarks": "The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) .\n\n*Amazon Aurora*\n\nNot applicable. You can enable or disable deletion protection for the DB cluster. For more information, see `CreateDBCluster` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.", "stability": "external", "summary": "A value that indicates whether the DB instance has deletion protection enabled." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4683 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domain" }, "remarks": "Currently, only Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.\n\nFor more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "The Active Directory directory ID to create the DB instance in." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4692 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainiamrolename" }, "remarks": "This setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable. The domain is managed by the DB cluster.", "stability": "external", "summary": "Specify the name of the IAM role to be used when making API calls to the Directory Service." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4705 }, "name": "domainIamRoleName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports" }, "remarks": "The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n\n*MariaDB*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Microsoft SQL Server*\n\nValid values: `agent` , `error`\n\n*MySQL*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Oracle*\n\nValid values: `alert` , `audit` , `listener` , `trace`\n\n*PostgreSQL*\n\nValid values: `postgresql` , `upgrade`", "stability": "external", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4736 }, "name": "enableCloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication" }, "remarks": "By default, mapping is disabled.\n\nThis property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*\n\n*Amazon Aurora*\n\nNot applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.", "stability": "external", "summary": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4749 }, "name": "enableIamDatabaseAuthentication", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableperformanceinsights" }, "remarks": "For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide* .\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether to enable Performance Insights for the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4758 }, "name": "enablePerformanceInsights", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-endpoint" }, "remarks": "> The endpoint might not be shown for instances whose status is `creating` .", "stability": "external", "summary": "Specifies the connection endpoint." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4767 }, "name": "endpoint", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.EndpointProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engine" }, "remarks": "> When you are creating a DB instance, the `Engine` property is required.\n\nValid Values:\n\n- `aurora-mysql` (for Aurora MySQL DB instances)\n- `aurora-postgresql` (for Aurora PostgreSQL DB instances)\n- `custom-oracle-ee` (for RDS Custom for Oracle DB instances)\n- `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)\n- `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)\n- `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)\n- `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)\n- `mariadb`\n- `mysql`\n- `oracle-ee`\n- `oracle-ee-cdb`\n- `oracle-se2`\n- `oracle-se2-cdb`\n- `postgres`\n- `sqlserver-ee`\n- `sqlserver-se`\n- `sqlserver-ex`\n- `sqlserver-web`", "stability": "external", "summary": "The name of the database engine that you want to use for this DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4797 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engineversion" }, "remarks": "For a list of valid engine versions, use the `DescribeDBEngineVersions` action.\n\nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n\n*Amazon Aurora*\n\nNot applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n\n*MariaDB*\n\nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Microsoft SQL Server*\n\nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*\n\n*MySQL*\n\nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Oracle*\n\nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*\n\n*PostgreSQL*\n\nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "The version number of the database engine to use." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4832 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-iops" }, "remarks": "The value must be equal to or greater than 1000.\n\nIf you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide* .\n\n> If you specify `io1` for the `StorageType` property, then you must also specify the `Iops` property.", "stability": "external", "summary": "The number of I/O operations per second (IOPS) that the database provisions." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4843 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-kmskeyid" }, "remarks": "If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.\n\nIf you specify the `SourceDBInstanceIdentifier` property, the value is inherited from the source DB instance if the read replica is created in the same region.\n\nIf you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify `DBSecurityGroups` , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. The KMS key identifier is managed by the DB cluster.", "stability": "external", "summary": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4862 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-licensemodel" }, "remarks": "Valid values:\n\n- Aurora MySQL - `general-public-license`\n- Aurora PostgreSQL - `postgresql-license`\n- MariaDB - `general-public-license`\n- Microsoft SQL Server - `license-included`\n- MySQL - `general-public-license`\n- Oracle - `bring-your-own-license` or `license-included`\n- PostgreSQL - `postgresql-license`\n\n> If you've specified `DBSecurityGroups` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.", "stability": "external", "summary": "License model information for this DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4881 }, "name": "licenseModel", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-managemasteruserpassword" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*\n\nConstraints:\n\n- Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.", "stability": "external", "summary": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4894 }, "name": "manageMasterUserPassword", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusername" }, "remarks": "> If you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n\n*Amazon Aurora*\n\nNot applicable. The name for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints:\n\n- Required for MariaDB.\n- Must be 1 to 16 letters or numbers.\n- Can't be a reserved word for the chosen database engine.\n\n*Microsoft SQL Server*\n\nConstraints:\n\n- Required for SQL Server.\n- Must be 1 to 128 letters or numbers.\n- The first character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*MySQL*\n\nConstraints:\n\n- Required for MySQL.\n- Must be 1 to 16 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*Oracle*\n\nConstraints:\n\n- Required for Oracle.\n- Must be 1 to 30 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*PostgreSQL*\n\nConstraints:\n\n- Required for PostgreSQL.\n- Must be 1 to 63 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.", "stability": "external", "summary": "The master user name for the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4951 }, "name": "masterUsername", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masteruserpassword" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The password for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Microsoft SQL Server*\n\nConstraints: Must contain from 8 to 128 characters.\n\n*MySQL*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Oracle*\n\nConstraints: Must contain from 8 to 30 characters.\n\n*PostgreSQL*\n\nConstraints: Must contain from 8 to 128 characters.", "stability": "external", "summary": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\"." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4982 }, "name": "masterUserPassword", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusersecret" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 4991 }, "name": "masterUserSecret", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.MasterUserSecretProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-maxallocatedstorage" }, "remarks": "For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide* .\n\nThis setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable. Storage is managed by the DB cluster.", "stability": "external", "summary": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5006 }, "name": "maxAllocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringinterval" }, "remarks": "To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.\n\nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0.\n\nThis setting doesn't apply to RDS Custom.\n\nValid Values: `0, 1, 5, 10, 15, 30, 60`", "stability": "external", "summary": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5019 }, "name": "monitoringInterval", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringrolearn" }, "remarks": "For example, `arn:aws:iam:123456789012:role/emaccess` . For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide* .\n\nIf `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5030 }, "name": "monitoringRoleArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz" }, "remarks": "You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true.\n\nFor more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set.", "stability": "external", "summary": "Specifies whether the database instance is a Multi-AZ DB instance deployment." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5043 }, "name": "multiAz", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-ncharcharactersetname" }, "remarks": "This parameter doesn't apply to RDS Custom.", "stability": "external", "summary": "The name of the NCHAR character set for the Oracle DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5052 }, "name": "ncharCharacterSetName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-networktype" }, "remarks": "Valid values:\n\n- `IPV4`\n- `DUAL`\n\nThe network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( `DUAL` ).\n\nFor more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "The network type of the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5068 }, "name": "networkType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-optiongroupname" }, "remarks": "Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.", "stability": "external", "summary": "Indicates that the DB instance should be associated with the specified option group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5077 }, "name": "optionGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightskmskeyid" }, "remarks": "The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n\nIf you do not specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n\nFor information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights) .", "stability": "external", "summary": "The AWS KMS key identifier for encryption of Performance Insights data." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5090 }, "name": "performanceInsightsKmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod" }, "remarks": "- 7\n- *month* * 31, where *month* is a number of months from 1-23\n- 731\n\nFor example, the following values are valid:\n\n- 93 (3 months * 31)\n- 341 (11 months * 31)\n- 589 (19 months * 31)\n- 731\n\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5112 }, "name": "performanceInsightsRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The port number is managed by the DB cluster.", "stability": "external", "summary": "The port number on which the database accepts connections." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5123 }, "name": "port", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredbackupwindow" }, "remarks": "For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.\n\n*Amazon Aurora*\n\nNot applicable. The daily time range for creating automated backups is managed by the DB cluster.", "stability": "external", "summary": "The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5141 }, "name": "preferredBackupWindow", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredmaintenancewindow" }, "remarks": "Format: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*\n\n> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n\nConstraints: Minimum 30-minute window.", "stability": "external", "summary": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5156 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-processorfeatures" }, "remarks": "This setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable.", "stability": "external", "summary": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5169 }, "name": "processorFeatures", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.ProcessorFeatureProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-promotiontier" }, "remarks": "For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide* .\n\nThis setting doesn't apply to RDS Custom.\n\nDefault: 1\n\nValid Values: 0 - 15", "stability": "external", "summary": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5182 }, "name": "promotionTier", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-publiclyaccessible" }, "remarks": "If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.\n\nThe default behavior value depends on your VPC setup and the database subnet group. For more information, see the `PubliclyAccessible` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference* .", "stability": "external", "summary": "Indicates whether the DB instance is an internet-facing instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5191 }, "name": "publiclyAccessible", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-replicamode" }, "remarks": "For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide* .\n\nThis setting is only supported in RDS for Oracle.\n\nDefault: `open-read-only`\n\nValid Values: `open-read-only` or `mounted`", "stability": "external", "summary": "The open mode of an Oracle read replica." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5204 }, "name": "replicaMode", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-restoretime" }, "remarks": "Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n\nConstraints:\n\n- Must be before the latest restorable time for the DB instance\n- Can't be specified if the `UseLatestRestorableTime` parameter is enabled\n\nExample: `2009-09-07T23:45:00Z`", "stability": "external", "summary": "The date and time to restore from." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5220 }, "name": "restoreTime", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbclusteridentifier" }, "remarks": "Each DB cluster can have up to 15 read replicas.\n\nConstraints:\n\n- Must be the identifier of an existing Multi-AZ DB cluster.\n- Can't be specified if the `SourceDBInstanceIdentifier` parameter is also specified.\n- The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n- The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.", "stability": "external", "summary": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5234 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceautomatedbackupsarn" }, "remarks": "This setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5243 }, "name": "sourceDbInstanceAutomatedBackupsArn", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier" }, "remarks": "Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide* .\n\nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide* .\n\nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.\n\n> - If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n> - Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n> - If you specify `SourceDBInstanceIdentifier` , don't specify the `DBSnapshotIdentifier` property. You can't create a read replica from a snapshot.\n> - Don't set the `BackupRetentionPeriod` , `DBName` , `MasterUsername` , `MasterUserPassword` , and `PreferredBackupWindow` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n> - If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion` , and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier` . For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide* .\n> - For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.", "stability": "external", "summary": "If you want to create a read replica DB instance, specify the ID of the source DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5261 }, "name": "sourceDbInstanceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbiresourceid" }, "stability": "external", "summary": "The resource ID of the source DB instance from which to restore." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5268 }, "name": "sourceDbiResourceId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourceregion" }, "stability": "external", "summary": "The ID of the region that contains the source DB instance for the read replica." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5275 }, "name": "sourceRegion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storageencrypted" }, "remarks": "If you specify the `KmsKeyId` property, then you must enable encryption.\n\nIf you specify the `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the `KmsKeyId` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to `false` .\n\n*Amazon Aurora*\n\nNot applicable. The encryption for DB instances is managed by the DB cluster.", "stability": "external", "summary": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5294 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagethroughput" }, "remarks": "This setting doesn't apply to RDS Custom or Amazon Aurora.", "stability": "external", "summary": "Specifies the storage throughput value for the DB instance. This setting applies only to the `gp3` storage type." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5303 }, "name": "storageThroughput", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagetype" }, "remarks": "Valid values: `gp2 | gp3 | io1 | standard`\n\nThe `standard` value is also known as magnetic.\n\nIf you specify `io1` or `gp3` , you must also include a value for the `Iops` parameter.\n\nDefault: `io1` if the `Iops` parameter is specified, otherwise `gp2`\n\nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).", "stability": "external", "summary": "Specifies the storage type to be associated with the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5324 }, "name": "storageType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-timezone" }, "remarks": "The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) .", "stability": "external", "summary": "The time zone of the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5338 }, "name": "timezone", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures" }, "remarks": "This setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether the DB instance class of the DB instance uses its default processor features." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5347 }, "name": "useDefaultProcessorFeatures", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-uselatestrestorabletime" }, "remarks": "By default, the DB instance isn't restored from the latest backup time.\n\nConstraints: Can't be specified if the `RestoreTime` parameter is provided.", "stability": "external", "summary": "A value that indicates whether the DB instance is restored from the latest backup time." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5356 }, "name": "useLatestRestorableTime", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-vpcsecuritygroups" }, "remarks": "The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n\nIf you plan to update the resource, don't specify VPC security groups in a shared VPC.\n\nIf you set `VPCSecurityGroups` , you must not set [`DBSecurityGroups`](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) , and vice versa.\n\n> You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n>\n> - You can't revert to using an RDS security group after you establish a VPC security group membership.\n> - When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n> - To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [`DBSecurityGroups`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n\nTo avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.\n\n*Amazon Aurora*\n\nNot applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "stability": "external", "summary": "A list of the VPC security group IDs to assign to the DB instance." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5379 }, "name": "vpcSecurityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBInstance" }, "@aws-cdk/aws-rds.CfnDBInstance.CertificateDetailsProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Using SSL/TLS to encrypt a connection to a DB instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL.html) in the *Amazon RDS User Guide* and [Using SSL/TLS to encrypt a connection to a DB cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL.html) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "Returns the details of the DB instance’s server certificate.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst certificateDetailsProperty: rds.CfnDBInstance.CertificateDetailsProperty = {\n caIdentifier: 'caIdentifier',\n validTill: 'validTill',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance.CertificateDetailsProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5575 }, "name": "CertificateDetailsProperty", "namespace": "CfnDBInstance", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html#cfn-rds-dbinstance-certificatedetails-caidentifier" }, "stability": "external", "summary": "The CA identifier of the CA certificate used for the DB instance's server certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5581 }, "name": "caIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-certificatedetails.html#cfn-rds-dbinstance-certificatedetails-validtill" }, "stability": "external", "summary": "The expiration date of the DB instance’s server certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5587 }, "name": "validTill", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBInstance.CertificateDetailsProperty" }, "@aws-cdk/aws-rds.CfnDBInstance.DBInstanceRoleProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Describes an AWS Identity and Access Management (IAM) role that is associated with a DB instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst dBInstanceRoleProperty: rds.CfnDBInstance.DBInstanceRoleProperty = {\n featureName: 'featureName',\n roleArn: 'roleArn',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance.DBInstanceRoleProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5651 }, "name": "DBInstanceRoleProperty", "namespace": "CfnDBInstance", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-featurename" }, "remarks": "IAM roles that are associated with a DB instance grant permission for the DB instance to access other AWS services on your behalf. For the list of supported feature names, see the `SupportedFeatureNames` description in [DBEngineVersion](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html) in the *Amazon RDS API Reference* .", "stability": "external", "summary": "The name of the feature associated with the AWS Identity and Access Management (IAM) role." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5657 }, "name": "featureName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-dbinstancerole.html#cfn-rds-dbinstance-dbinstancerole-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role that is associated with the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5663 }, "name": "roleArn", "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBInstance.DBInstanceRoleProperty" }, "@aws-cdk/aws-rds.CfnDBInstance.EndpointProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html", "exampleMetadata": "fixture=_generated" }, "remarks": "This data type is used as a response element in the following actions:\n\n- `CreateDBInstance`\n- `DescribeDBInstances`\n- `DeleteDBInstance`\n\nFor the data structure that represents Amazon Aurora DB cluster endpoints, see `DBClusterEndpoint` .", "stability": "external", "summary": "This data type represents the information you need to connect to an Amazon RDS DB instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst endpointProperty: rds.CfnDBInstance.EndpointProperty = {\n address: 'address',\n hostedZoneId: 'hostedZoneId',\n port: 'port',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance.EndpointProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5735 }, "name": "EndpointProperty", "namespace": "CfnDBInstance", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-address" }, "stability": "external", "summary": "Specifies the DNS address of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5741 }, "name": "address", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-hostedzoneid" }, "stability": "external", "summary": "Specifies the ID that Amazon Route 53 assigns when you create a hosted zone." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5747 }, "name": "hostedZoneId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-endpoint.html#cfn-rds-dbinstance-endpoint-port" }, "stability": "external", "summary": "Specifies the port that the database engine is listening on." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5753 }, "name": "port", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBInstance.EndpointProperty" }, "@aws-cdk/aws-rds.CfnDBInstance.MasterUserSecretProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html", "exampleMetadata": "fixture=_generated" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide* and [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-secrets-manager.html) in the *Amazon Aurora User Guide.*", "stability": "external", "summary": "The `MasterUserSecret` return value specifies the secret managed by RDS in AWS Secrets Manager for the master user password.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst masterUserSecretProperty: rds.CfnDBInstance.MasterUserSecretProperty = {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance.MasterUserSecretProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5822 }, "name": "MasterUserSecretProperty", "namespace": "CfnDBInstance", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html#cfn-rds-dbinstance-masterusersecret-kmskeyid" }, "stability": "external", "summary": "The AWS KMS key identifier that is used to encrypt the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5828 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-masterusersecret.html#cfn-rds-dbinstance-masterusersecret-secretarn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the secret." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5834 }, "name": "secretArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBInstance.MasterUserSecretProperty" }, "@aws-cdk/aws-rds.CfnDBInstance.ProcessorFeatureProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `ProcessorFeature` property type specifies the processor features of a DB instance class status.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst processorFeatureProperty: rds.CfnDBInstance.ProcessorFeatureProperty = {\n name: 'name',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstance.ProcessorFeatureProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5898 }, "name": "ProcessorFeatureProperty", "namespace": "CfnDBInstance", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-name" }, "remarks": "Valid names are `coreCount` and `threadsPerCore` .", "stability": "external", "summary": "The name of the processor feature." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5904 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbinstance-processorfeature.html#cfn-rds-dbinstance-processorfeature-value" }, "stability": "external", "summary": "The value of a processor feature name." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5910 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBInstance.ProcessorFeatureProperty" }, "@aws-cdk/aws-rds.CfnDBInstanceProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBInstance`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBInstanceProps: rds.CfnDBInstanceProps = {\n allocatedStorage: 'allocatedStorage',\n allowMajorVersionUpgrade: false,\n associatedRoles: [{\n featureName: 'featureName',\n roleArn: 'roleArn',\n }],\n autoMinorVersionUpgrade: false,\n availabilityZone: 'availabilityZone',\n backupRetentionPeriod: 123,\n caCertificateIdentifier: 'caCertificateIdentifier',\n certificateDetails: {\n caIdentifier: 'caIdentifier',\n validTill: 'validTill',\n },\n certificateRotationRestart: false,\n characterSetName: 'characterSetName',\n copyTagsToSnapshot: false,\n customIamInstanceProfile: 'customIamInstanceProfile',\n dbClusterIdentifier: 'dbClusterIdentifier',\n dbClusterSnapshotIdentifier: 'dbClusterSnapshotIdentifier',\n dbInstanceClass: 'dbInstanceClass',\n dbInstanceIdentifier: 'dbInstanceIdentifier',\n dbName: 'dbName',\n dbParameterGroupName: 'dbParameterGroupName',\n dbSecurityGroups: ['dbSecurityGroups'],\n dbSnapshotIdentifier: 'dbSnapshotIdentifier',\n dbSubnetGroupName: 'dbSubnetGroupName',\n deleteAutomatedBackups: false,\n deletionProtection: false,\n domain: 'domain',\n domainIamRoleName: 'domainIamRoleName',\n enableCloudwatchLogsExports: ['enableCloudwatchLogsExports'],\n enableIamDatabaseAuthentication: false,\n enablePerformanceInsights: false,\n endpoint: {\n address: 'address',\n hostedZoneId: 'hostedZoneId',\n port: 'port',\n },\n engine: 'engine',\n engineVersion: 'engineVersion',\n iops: 123,\n kmsKeyId: 'kmsKeyId',\n licenseModel: 'licenseModel',\n manageMasterUserPassword: false,\n masterUsername: 'masterUsername',\n masterUserPassword: 'masterUserPassword',\n masterUserSecret: {\n kmsKeyId: 'kmsKeyId',\n secretArn: 'secretArn',\n },\n maxAllocatedStorage: 123,\n monitoringInterval: 123,\n monitoringRoleArn: 'monitoringRoleArn',\n multiAz: false,\n ncharCharacterSetName: 'ncharCharacterSetName',\n networkType: 'networkType',\n optionGroupName: 'optionGroupName',\n performanceInsightsKmsKeyId: 'performanceInsightsKmsKeyId',\n performanceInsightsRetentionPeriod: 123,\n port: 'port',\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n processorFeatures: [{\n name: 'name',\n value: 'value',\n }],\n promotionTier: 123,\n publiclyAccessible: false,\n replicaMode: 'replicaMode',\n restoreTime: 'restoreTime',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n sourceDbInstanceAutomatedBackupsArn: 'sourceDbInstanceAutomatedBackupsArn',\n sourceDbInstanceIdentifier: 'sourceDbInstanceIdentifier',\n sourceDbiResourceId: 'sourceDbiResourceId',\n sourceRegion: 'sourceRegion',\n storageEncrypted: false,\n storageThroughput: 123,\n storageType: 'storageType',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n timezone: 'timezone',\n useDefaultProcessorFeatures: false,\n useLatestRestorableTime: false,\n vpcSecurityGroups: ['vpcSecurityGroups'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2775 }, "name": "CfnDBInstanceProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allocatedstorage" }, "remarks": "> If any value is set in the `Iops` parameter, `AllocatedStorage` must be at least 100 GiB, which corresponds to the minimum Iops value of 1,000. If you increase the `Iops` value (in 1,000 IOPS increments), then you must also increase the `AllocatedStorage` value (in 100-GiB increments).\n\n*Amazon Aurora*\n\nNot applicable. Aurora cluster volumes automatically grow as the amount of data in your database increases, though you are only charged for the space that you use in an Aurora cluster volume.\n\n*MySQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*MariaDB*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*PostgreSQL*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 5 to 3072.\n\n*Oracle*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2): Must be an integer from 20 to 65536.\n- Provisioned IOPS storage (io1): Must be an integer from 100 to 65536.\n- Magnetic storage (standard): Must be an integer from 10 to 3072.\n\n*SQL Server*\n\nConstraints to the amount of storage for each storage type are the following:\n\n- General Purpose (SSD) storage (gp2):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Provisioned IOPS storage (io1):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 16384.\n- Web and Express editions: Must be an integer from 20 to 16384.\n- Magnetic storage (standard):\n\n- Enterprise and Standard editions: Must be an integer from 20 to 1024.\n- Web and Express editions: Must be an integer from 20 to 1024.", "stability": "external", "summary": "The amount of storage in gibibytes (GiB) to be initially allocated for the database instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2837 }, "name": "allocatedStorage", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-allowmajorversionupgrade" }, "remarks": "Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible.\n\nConstraints: Major version upgrades must be allowed when specifying a value for the `EngineVersion` parameter that is a different major version than the DB instance's current version.", "stability": "external", "summary": "A value that indicates whether major version upgrades are allowed." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2846 }, "name": "allowMajorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-associatedroles" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The associated roles are managed by the DB cluster.", "stability": "external", "summary": "The AWS Identity and Access Management (IAM) roles associated with the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2857 }, "name": "associatedRoles", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.DBInstanceRoleProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-autominorversionupgrade" }, "remarks": "By default, minor engine upgrades are applied automatically.", "stability": "external", "summary": "A value that indicates whether minor engine upgrades are applied automatically to the DB instance during the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2864 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-availabilityzone" }, "remarks": "For information on AWS Regions and Availability Zones, see [Regions and Availability Zones](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.RegionsAndAvailabilityZones.html) .\n\n*Amazon Aurora*\n\nEach Aurora DB cluster hosts copies of its storage in three separate Availability Zones. Specify one of these Availability Zones. Aurora automatically chooses an appropriate Availability Zone if you don't specify one.\n\nDefault: A random, system-chosen Availability Zone in the endpoint's AWS Region .\n\nExample: `us-east-1d`\n\nConstraint: The `AvailabilityZone` parameter can't be specified if the DB instance is a Multi-AZ deployment. The specified Availability Zone must be in the same AWS Region as the current endpoint.", "stability": "external", "summary": "The Availability Zone (AZ) where the database will be created." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2881 }, "name": "availabilityZone", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-backupretentionperiod" }, "remarks": "Setting this parameter to a positive number enables backups. Setting this parameter to 0 disables automated backups.\n\n*Amazon Aurora*\n\nNot applicable. The retention period for automated backups is managed by the DB cluster.\n\nDefault: 1\n\nConstraints:\n\n- Must be a value from 0 to 35\n- Can't be set to 0 if the DB instance is a source to read replicas", "stability": "external", "summary": "The number of days for which automated backups are retained." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2899 }, "name": "backupRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-cacertificateidentifier" }, "remarks": "> Specifying or updating this property triggers a reboot.\n\nFor more information about CA certificate identifiers for RDS DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide* .\n\nFor more information about CA certificate identifiers for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "The identifier of the CA certificate for this DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2912 }, "name": "caCertificateIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificatedetails" }, "stability": "external", "summary": "The details of the DB instance's server certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2919 }, "name": "certificateDetails", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.CertificateDetailsProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-certificaterotationrestart" }, "remarks": "By default, the DB instance is restarted when you rotate your SSL/TLS certificate. The certificate is not updated until the DB instance is restarted.\n\n> Set this parameter only if you are *not* using SSL/TLS to connect to the DB instance.\n\nIf you are using SSL/TLS to connect to the DB instance, follow the appropriate instructions for your DB engine to rotate your SSL/TLS certificate:\n\n- For more information about rotating your SSL/TLS certificate for RDS DB engines, see [Rotating Your SSL/TLS Certificate.](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon RDS User Guide.*\n- For more information about rotating your SSL/TLS certificate for Aurora DB engines, see [Rotating Your SSL/TLS Certificate](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/UsingWithRDS.SSL-certificate-rotation.html) in the *Amazon Aurora User Guide* .\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether the DB instance is restarted when you rotate your SSL/TLS certificate." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2937 }, "name": "certificateRotationRestart", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-charactersetname" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The character set is managed by the DB cluster. For more information, see [AWS::RDS::DBCluster](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbcluster.html) .", "stability": "external", "summary": "For supported engines, indicates that the DB instance should be associated with the specified character set." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2948 }, "name": "characterSetName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-copytagstosnapshot" }, "remarks": "By default, tags are not copied.\n\n*Amazon Aurora*\n\nNot applicable. Copying tags to snapshots is managed by the DB cluster. Setting this value for an Aurora DB instance has no effect on the DB cluster setting.", "stability": "external", "summary": "A value that indicates whether to copy tags from the DB instance to snapshots of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2959 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-customiaminstanceprofile" }, "remarks": "The instance profile must meet the following requirements:\n\n- The profile must exist in your account.\n- The profile must have an IAM role that Amazon EC2 has permissions to assume.\n- The instance profile name and the associated IAM role name must start with the prefix `AWSRDSCustom` .\n\nFor the list of permissions required for the IAM role, see [Configure IAM and your VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-setup-orcl.html#custom-setup-orcl.iam-vpc) in the *Amazon RDS User Guide* .\n\nThis setting is required for RDS Custom.", "stability": "external", "summary": "The instance profile associated with the underlying Amazon EC2 instance of an RDS Custom DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2974 }, "name": "customIamInstanceProfile", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclusteridentifier" }, "stability": "external", "summary": "The identifier of the DB cluster that the instance will belong to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2981 }, "name": "dbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbclustersnapshotidentifier" }, "remarks": "For more information on Multi-AZ DB clusters, see [Multi-AZ DB cluster deployments](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html) in the *Amazon RDS User Guide* .\n\nConstraints:\n\n- Must match the identifier of an existing Multi-AZ DB cluster snapshot.\n- Can't be specified when `DBSnapshotIdentifier` is specified.\n- Must be specified when `DBSnapshotIdentifier` isn't specified.\n- If you are restoring from a shared manual Multi-AZ DB cluster snapshot, the `DBClusterSnapshotIdentifier` must be the ARN of the shared snapshot.\n- Can't be the identifier of an Aurora DB cluster snapshot.\n- Can't be the identifier of an RDS for PostgreSQL Multi-AZ DB cluster snapshot.", "stability": "external", "summary": "The identifier for the RDS for MySQL Multi-AZ DB cluster snapshot to restore from." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 2999 }, "name": "dbClusterSnapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceclass" }, "remarks": "For the full list of DB instance classes, and availability for your engine, see [DB Instance Class](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html) in the *Amazon RDS User Guide.* For more information about DB instance class pricing and AWS Region support for DB instance classes, see [Amazon RDS Pricing](https://docs.aws.amazon.com/rds/pricing/) .", "stability": "external", "summary": "The compute and memory capacity of the DB instance, for example, `db.m4.large` . Not all DB instance classes are available in all AWS Regions, or for all database engines." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3008 }, "name": "dbInstanceClass", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbinstanceidentifier" }, "remarks": "If you specify a name, AWS CloudFormation converts it to lowercase. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the DB instance. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .\n\nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide* .\n\n> If you specify a name, you can't perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.", "stability": "external", "summary": "A name for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3019 }, "name": "dbInstanceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbname" }, "remarks": "> If you specify the `[DBSnapshotIdentifier](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsnapshotidentifier)` property, this property only applies to RDS for Oracle.\n\n*Amazon Aurora*\n\nNot applicable. The database name is managed by the DB cluster.\n\n*MySQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*MariaDB*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.\n\nConstraints:\n\n- Must contain 1 to 64 letters or numbers.\n- Can't be a word reserved by the specified database engine\n\n*PostgreSQL*\n\nThe name of the database to create when the DB instance is created. If this parameter is not specified, the default `postgres` database is created in the DB instance.\n\nConstraints:\n\n- Must begin with a letter. Subsequent characters can be letters, underscores, or digits (0-9).\n- Must contain 1 to 63 characters.\n- Can't be a word reserved by the specified database engine\n\n*Oracle*\n\nThe Oracle System ID (SID) of the created DB instance. If you specify `null` , the default value `ORCL` is used. You can't specify the string NULL, or any other reserved word, for `DBName` .\n\nDefault: `ORCL`\n\nConstraints:\n\n- Can't be longer than 8 characters\n\n*SQL Server*\n\nNot applicable. Must be null.", "stability": "external", "summary": "The meaning of this parameter differs according to the database engine you use." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3074 }, "name": "dbName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbparametergroupname" }, "remarks": "To list all of the available DB parameter group names, use the following command:\n\n`aws rds describe-db-parameter-groups --query \"DBParameterGroups[].DBParameterGroupName\" --output text`\n\n> If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot.\n\nIf you don't specify a value for `DBParameterGroupName` property, the default DB parameter group for the specified engine and engine version is used.", "stability": "external", "summary": "The name of an existing DB parameter group or a reference to an [AWS::RDS::DBParameterGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbparametergroup.html) resource created in the template." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3089 }, "name": "dbParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsecuritygroups" }, "remarks": "The list can include both the name of existing DB security groups or references to AWS::RDS::DBSecurityGroup resources created in the template.\n\nIf you set DBSecurityGroups, you must not set VPCSecurityGroups, and vice versa. Also, note that the DBSecurityGroups property exists only for backwards compatibility with older regions and is no longer recommended for providing security information to an RDS DB instance. Instead, use VPCSecurityGroups.\n\n> If you specify this property, AWS CloudFormation sends only the following properties (if specified) to Amazon RDS during create operations:\n>\n> - `AllocatedStorage`\n> - `AutoMinorVersionUpgrade`\n> - `AvailabilityZone`\n> - `BackupRetentionPeriod`\n> - `CharacterSetName`\n> - `DBInstanceClass`\n> - `DBName`\n> - `DBParameterGroupName`\n> - `DBSecurityGroups`\n> - `DBSubnetGroupName`\n> - `Engine`\n> - `EngineVersion`\n> - `Iops`\n> - `LicenseModel`\n> - `MasterUsername`\n> - `MasterUserPassword`\n> - `MultiAZ`\n> - `OptionGroupName`\n> - `PreferredBackupWindow`\n> - `PreferredMaintenanceWindow`\n>\n> All other properties are ignored. Specify a virtual private cloud (VPC) security group if you want to submit other properties, such as `StorageType` , `StorageEncrypted` , or `KmsKeyId` . If you're already using the `DBSecurityGroups` property, you can't use these other properties by updating your DB instance to use a VPC security group. You must recreate the DB instance.", "stability": "external", "summary": "A list of the DB security groups to assign to the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3123 }, "name": "dbSecurityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsnapshotidentifier" }, "remarks": "If you're restoring from a shared manual DB snapshot, you must specify the ARN of the snapshot.\n\nBy specifying this property, you can create a DB instance from the specified DB snapshot. If the `DBSnapshotIdentifier` property is an empty string or the `AWS::RDS::DBInstance` declaration has no `DBSnapshotIdentifier` property, AWS CloudFormation creates a new database. If the property contains a value (other than an empty string), AWS CloudFormation creates a database from the specified snapshot. If a snapshot with the specified name doesn't exist, AWS CloudFormation can't create the database and it rolls back the stack.\n\nSome DB instance properties aren't valid when you restore from a snapshot, such as the `MasterUsername` and `MasterUserPassword` properties. For information about the properties that you can specify, see the `RestoreDBInstanceFromDBSnapshot` action in the *Amazon RDS API Reference* .\n\nAfter you restore a DB instance with a `DBSnapshotIdentifier` property, you must specify the same `DBSnapshotIdentifier` property for any future updates to the DB instance. When you specify this property for an update, the DB instance is not restored from the DB snapshot again, and the data in the database is not changed. However, if you don't specify the `DBSnapshotIdentifier` property, an empty DB instance is created, and the original DB instance is deleted. If you specify a property that is different from the previous snapshot restore property, a new DB instance is restored from the specified `DBSnapshotIdentifier` property, and the original DB instance is deleted.\n\nIf you specify the `DBSnapshotIdentifier` property to restore a DB instance (as opposed to specifying it for DB instance updates), then don't specify the following properties:\n\n- `CharacterSetName`\n- `DBClusterIdentifier`\n- `DBName`\n- `DeleteAutomatedBackups`\n- `EnablePerformanceInsights`\n- `KmsKeyId`\n- `MasterUsername`\n- `MasterUserPassword`\n- `PerformanceInsightsKMSKeyId`\n- `PerformanceInsightsRetentionPeriod`\n- `PromotionTier`\n- `SourceDBInstanceIdentifier`\n- `SourceRegion`\n- `StorageEncrypted` (for an encrypted snapshot)\n- `Timezone`\n\n*Amazon Aurora*\n\nNot applicable. Snapshot restore is managed by the DB cluster.", "stability": "external", "summary": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3158 }, "name": "dbSnapshotIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-dbsubnetgroupname" }, "remarks": "If you update this value, the new subnet group must be a subnet group in a new VPC.\n\nIf there's no DB subnet group, then the DB instance isn't a VPC DB instance.\n\nFor more information about using Amazon RDS in a VPC, see [Using Amazon RDS with Amazon Virtual Private Cloud (VPC)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. The DB subnet group is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "stability": "external", "summary": "A DB subnet group to associate with the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3173 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deleteautomatedbackups" }, "remarks": "This parameter isn't case-sensitive. The default is to remove automated backups immediately after the DB instance is deleted.\n\n*Amazon Aurora*\n\nNot applicable. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the DB cluster are not deleted.", "stability": "external", "summary": "A value that indicates whether to remove automated backups immediately after the DB instance is deleted." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3184 }, "name": "deleteAutomatedBackups", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-deletionprotection" }, "remarks": "The database can't be deleted when deletion protection is enabled. By default, deletion protection is disabled. For more information, see [Deleting a DB Instance](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_DeleteInstance.html) .\n\n*Amazon Aurora*\n\nNot applicable. You can enable or disable deletion protection for the DB cluster. For more information, see `CreateDBCluster` . DB instances in a DB cluster can be deleted even when deletion protection is enabled for the DB cluster.", "stability": "external", "summary": "A value that indicates whether the DB instance has deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3195 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domain" }, "remarks": "Currently, only Microsoft SQL Server, Oracle, and PostgreSQL DB instances can be created in an Active Directory Domain.\n\nFor more information, see [Kerberos Authentication](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/kerberos-authentication.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "The Active Directory directory ID to create the DB instance in." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3204 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-domainiamrolename" }, "remarks": "This setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable. The domain is managed by the DB cluster.", "stability": "external", "summary": "Specify the name of the IAM role to be used when making API calls to the Directory Service." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3217 }, "name": "domainIamRoleName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enablecloudwatchlogsexports" }, "remarks": "The values in the list depend on the DB engine being used. For more information, see [Publishing Database Logs to Amazon CloudWatch Logs](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_LogAccess.html#USER_LogAccess.Procedural.UploadtoCloudWatch) in the *Amazon Relational Database Service User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. CloudWatch Logs exports are managed by the DB cluster.\n\n*MariaDB*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Microsoft SQL Server*\n\nValid values: `agent` , `error`\n\n*MySQL*\n\nValid values: `audit` , `error` , `general` , `slowquery`\n\n*Oracle*\n\nValid values: `alert` , `audit` , `listener` , `trace`\n\n*PostgreSQL*\n\nValid values: `postgresql` , `upgrade`", "stability": "external", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3248 }, "name": "enableCloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableiamdatabaseauthentication" }, "remarks": "By default, mapping is disabled.\n\nThis property is supported for RDS for MariaDB, RDS for MySQL, and RDS for PostgreSQL. For more information, see [IAM Database Authentication for MariaDB, MySQL, and PostgreSQL](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.html) in the *Amazon RDS User Guide.*\n\n*Amazon Aurora*\n\nNot applicable. Mapping AWS IAM accounts to database accounts is managed by the DB cluster.", "stability": "external", "summary": "A value that indicates whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3261 }, "name": "enableIamDatabaseAuthentication", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-enableperformanceinsights" }, "remarks": "For more information, see [Using Amazon Performance Insights](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PerfInsights.html) in the *Amazon RDS User Guide* .\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether to enable Performance Insights for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3270 }, "name": "enablePerformanceInsights", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-endpoint" }, "remarks": "> The endpoint might not be shown for instances whose status is `creating` .", "stability": "external", "summary": "Specifies the connection endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3279 }, "name": "endpoint", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.EndpointProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engine" }, "remarks": "> When you are creating a DB instance, the `Engine` property is required.\n\nValid Values:\n\n- `aurora-mysql` (for Aurora MySQL DB instances)\n- `aurora-postgresql` (for Aurora PostgreSQL DB instances)\n- `custom-oracle-ee` (for RDS Custom for Oracle DB instances)\n- `custom-oracle-ee-cdb` (for RDS Custom for Oracle DB instances)\n- `custom-sqlserver-ee` (for RDS Custom for SQL Server DB instances)\n- `custom-sqlserver-se` (for RDS Custom for SQL Server DB instances)\n- `custom-sqlserver-web` (for RDS Custom for SQL Server DB instances)\n- `mariadb`\n- `mysql`\n- `oracle-ee`\n- `oracle-ee-cdb`\n- `oracle-se2`\n- `oracle-se2-cdb`\n- `postgres`\n- `sqlserver-ee`\n- `sqlserver-se`\n- `sqlserver-ex`\n- `sqlserver-web`", "stability": "external", "summary": "The name of the database engine that you want to use for this DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3309 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-engineversion" }, "remarks": "For a list of valid engine versions, use the `DescribeDBEngineVersions` action.\n\nThe following are the database engines and links to information about the major and minor versions that are available with Amazon RDS. Not every database engine is available for every AWS Region.\n\n*Amazon Aurora*\n\nNot applicable. The version number of the database engine to be used by the DB instance is managed by the DB cluster.\n\n*MariaDB*\n\nSee [MariaDB on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MariaDB.html#MariaDB.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Microsoft SQL Server*\n\nSee [Microsoft SQL Server Versions on Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.VersionSupport) in the *Amazon RDS User Guide.*\n\n*MySQL*\n\nSee [MySQL on Amazon RDS Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_MySQL.html#MySQL.Concepts.VersionMgmt) in the *Amazon RDS User Guide.*\n\n*Oracle*\n\nSee [Oracle Database Engine Release Notes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Appendix.Oracle.PatchComposition.html) in the *Amazon RDS User Guide.*\n\n*PostgreSQL*\n\nSee [Supported PostgreSQL Database Versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.DBVersions) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "The version number of the database engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3344 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-iops" }, "remarks": "The value must be equal to or greater than 1000.\n\nIf you specify this property, you must follow the range of allowed ratios of your requested IOPS rate to the amount of storage that you allocate (IOPS to allocated storage). For example, you can provision an Oracle database instance with 1000 IOPS and 200 GiB of storage (a ratio of 5:1), or specify 2000 IOPS with 200 GiB of storage (a ratio of 10:1). For more information, see [Amazon RDS Provisioned IOPS Storage to Improve Performance](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/CHAP_Storage.html#USER_PIOPS) in the *Amazon RDS User Guide* .\n\n> If you specify `io1` for the `StorageType` property, then you must also specify the `Iops` property.", "stability": "external", "summary": "The number of I/O operations per second (IOPS) that the database provisions." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3355 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-kmskeyid" }, "remarks": "If you enable the StorageEncrypted property but don't specify this property, AWS CloudFormation uses the default KMS key. If you specify this property, you must set the StorageEncrypted property to true.\n\nIf you specify the `SourceDBInstanceIdentifier` property, the value is inherited from the source DB instance if the read replica is created in the same region.\n\nIf you create an encrypted read replica in a different AWS Region, then you must specify a KMS key for the destination AWS Region. KMS encryption keys are specific to the region that they're created in, and you can't use encryption keys from one region in another region.\n\nIf you specify the `SnapshotIdentifier` property, the `StorageEncrypted` property value is inherited from the snapshot, and if the DB instance is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify `DBSecurityGroups` , AWS CloudFormation ignores this property. To specify both a security group and this property, you must use a VPC security group. For more information about Amazon RDS and VPC, see [Using Amazon RDS with Amazon VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. The KMS key identifier is managed by the DB cluster.", "stability": "external", "summary": "The ARN of the AWS KMS key that's used to encrypt the DB instance, such as `arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3374 }, "name": "kmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-licensemodel" }, "remarks": "Valid values:\n\n- Aurora MySQL - `general-public-license`\n- Aurora PostgreSQL - `postgresql-license`\n- MariaDB - `general-public-license`\n- Microsoft SQL Server - `license-included`\n- MySQL - `general-public-license`\n- Oracle - `bring-your-own-license` or `license-included`\n- PostgreSQL - `postgresql-license`\n\n> If you've specified `DBSecurityGroups` and then you update the license model, AWS CloudFormation replaces the underlying DB instance. This will incur some interruptions to database availability.", "stability": "external", "summary": "License model information for this DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3393 }, "name": "licenseModel", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-managemasteruserpassword" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*\n\nConstraints:\n\n- Can't manage the master user password with AWS Secrets Manager if `MasterUserPassword` is specified.", "stability": "external", "summary": "A value that indicates whether to manage the master user password with AWS Secrets Manager." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3406 }, "name": "manageMasterUserPassword", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusername" }, "remarks": "> If you specify the `SourceDBInstanceIdentifier` or `DBSnapshotIdentifier` property, don't specify this property. The value is inherited from the source DB instance or snapshot.\n\n*Amazon Aurora*\n\nNot applicable. The name for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints:\n\n- Required for MariaDB.\n- Must be 1 to 16 letters or numbers.\n- Can't be a reserved word for the chosen database engine.\n\n*Microsoft SQL Server*\n\nConstraints:\n\n- Required for SQL Server.\n- Must be 1 to 128 letters or numbers.\n- The first character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*MySQL*\n\nConstraints:\n\n- Required for MySQL.\n- Must be 1 to 16 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*Oracle*\n\nConstraints:\n\n- Required for Oracle.\n- Must be 1 to 30 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.\n\n*PostgreSQL*\n\nConstraints:\n\n- Required for PostgreSQL.\n- Must be 1 to 63 letters or numbers.\n- First character must be a letter.\n- Can't be a reserved word for the chosen database engine.", "stability": "external", "summary": "The master user name for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3463 }, "name": "masterUsername", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masteruserpassword" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The password for the master user is managed by the DB cluster.\n\n*MariaDB*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Microsoft SQL Server*\n\nConstraints: Must contain from 8 to 128 characters.\n\n*MySQL*\n\nConstraints: Must contain from 8 to 41 characters.\n\n*Oracle*\n\nConstraints: Must contain from 8 to 30 characters.\n\n*PostgreSQL*\n\nConstraints: Must contain from 8 to 128 characters.", "stability": "external", "summary": "The password for the master user. The password can include any printable ASCII character except \"/\", \"\"\", or \"@\"." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3494 }, "name": "masterUserPassword", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-masterusersecret" }, "remarks": "For more information, see [Password management with AWS Secrets Manager](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-secrets-manager.html) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "Contains the secret managed by RDS in AWS Secrets Manager for the master user password." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3503 }, "name": "masterUserSecret", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.MasterUserSecretProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-maxallocatedstorage" }, "remarks": "For more information about this setting, including limitations that apply to it, see [Managing capacity automatically with Amazon RDS storage autoscaling](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling) in the *Amazon RDS User Guide* .\n\nThis setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable. Storage is managed by the DB cluster.", "stability": "external", "summary": "The upper limit in gibibytes (GiB) to which Amazon RDS can automatically scale the storage of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3518 }, "name": "maxAllocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringinterval" }, "remarks": "To disable collection of Enhanced Monitoring metrics, specify 0. The default is 0.\n\nIf `MonitoringRoleArn` is specified, then you must set `MonitoringInterval` to a value other than 0.\n\nThis setting doesn't apply to RDS Custom.\n\nValid Values: `0, 1, 5, 10, 15, 30, 60`", "stability": "external", "summary": "The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3531 }, "name": "monitoringInterval", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-monitoringrolearn" }, "remarks": "For example, `arn:aws:iam:123456789012:role/emaccess` . For information on creating a monitoring role, see [Setting Up and Enabling Enhanced Monitoring](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Monitoring.OS.html#USER_Monitoring.OS.Enabling) in the *Amazon RDS User Guide* .\n\nIf `MonitoringInterval` is set to a value other than 0, then you must supply a `MonitoringRoleArn` value.\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to Amazon CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3542 }, "name": "monitoringRoleArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-multiaz" }, "remarks": "You can't set the `AvailabilityZone` parameter if the `MultiAZ` parameter is set to true.\n\nFor more information, see [Multi-AZ deployments for high availability](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.MultiAZ.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. Amazon Aurora storage is replicated across all of the Availability Zones and doesn't require the `MultiAZ` option to be set.", "stability": "external", "summary": "Specifies whether the database instance is a Multi-AZ DB instance deployment." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3555 }, "name": "multiAz", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-ncharcharactersetname" }, "remarks": "This parameter doesn't apply to RDS Custom.", "stability": "external", "summary": "The name of the NCHAR character set for the Oracle DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3564 }, "name": "ncharCharacterSetName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-networktype" }, "remarks": "Valid values:\n\n- `IPV4`\n- `DUAL`\n\nThe network type is determined by the `DBSubnetGroup` specified for the DB instance. A `DBSubnetGroup` can support only the IPv4 protocol or the IPv4 and IPv6 protocols ( `DUAL` ).\n\nFor more information, see [Working with a DB instance in a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html) in the *Amazon RDS User Guide.*", "stability": "external", "summary": "The network type of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3580 }, "name": "networkType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-optiongroupname" }, "remarks": "Permanent options, such as the TDE option for Oracle Advanced Security TDE, can't be removed from an option group. Also, that option group can't be removed from a DB instance once it is associated with a DB instance.", "stability": "external", "summary": "Indicates that the DB instance should be associated with the specified option group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3589 }, "name": "optionGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightskmskeyid" }, "remarks": "The KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.\n\nIf you do not specify a value for `PerformanceInsightsKMSKeyId` , then Amazon RDS uses your default KMS key. There is a default KMS key for your AWS account. Your AWS account has a different default KMS key for each AWS Region.\n\nFor information about enabling Performance Insights, see [EnablePerformanceInsights](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-enableperformanceinsights) .", "stability": "external", "summary": "The AWS KMS key identifier for encryption of Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3602 }, "name": "performanceInsightsKmsKeyId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-performanceinsightsretentionperiod" }, "remarks": "- 7\n- *month* * 31, where *month* is a number of months from 1-23\n- 731\n\nFor example, the following values are valid:\n\n- 93 (3 months * 31)\n- 341 (11 months * 31)\n- 589 (19 months * 31)\n- 731\n\nIf you specify a retention period such as 94, which isn't a valid value, RDS issues an error.\n\nThis setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The number of days to retain Performance Insights data. The default is 7 days. The following values are valid:." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3624 }, "name": "performanceInsightsRetentionPeriod", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-port" }, "remarks": "*Amazon Aurora*\n\nNot applicable. The port number is managed by the DB cluster.", "stability": "external", "summary": "The port number on which the database accepts connections." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3635 }, "name": "port", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredbackupwindow" }, "remarks": "For more information, see [Backup Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow) in the *Amazon RDS User Guide.*\n\nConstraints:\n\n- Must be in the format `hh24:mi-hh24:mi` .\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.\n\n*Amazon Aurora*\n\nNot applicable. The daily time range for creating automated backups is managed by the DB cluster.", "stability": "external", "summary": "The daily time range during which automated backups are created if automated backups are enabled, using the `BackupRetentionPeriod` parameter." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3653 }, "name": "preferredBackupWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-preferredmaintenancewindow" }, "remarks": "Format: `ddd:hh24:mi-ddd:hh24:mi`\n\nThe default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region, occurring on a random day of the week. To see the time blocks available, see [Adjusting the Preferred DB Instance Maintenance Window](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#AdjustingTheMaintenanceWindow) in the *Amazon RDS User Guide.*\n\n> This property applies when AWS CloudFormation initially creates the DB instance. If you use AWS CloudFormation to update the DB instance, those updates are applied immediately.\n\nConstraints: Minimum 30-minute window.", "stability": "external", "summary": "The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC)." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3668 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-processorfeatures" }, "remarks": "This setting doesn't apply to RDS Custom.\n\n*Amazon Aurora*\n\nNot applicable.", "stability": "external", "summary": "The number of CPU cores and the number of threads per core for the DB instance class of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3681 }, "name": "processorFeatures", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBInstance.ProcessorFeatureProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-promotiontier" }, "remarks": "For more information, see [Fault Tolerance for an Aurora DB Cluster](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/Aurora.Managing.Backups.html#Aurora.Managing.FaultTolerance) in the *Amazon Aurora User Guide* .\n\nThis setting doesn't apply to RDS Custom.\n\nDefault: 1\n\nValid Values: 0 - 15", "stability": "external", "summary": "A value that specifies the order in which an Aurora Replica is promoted to the primary instance after a failure of the existing primary instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3694 }, "name": "promotionTier", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-publiclyaccessible" }, "remarks": "If you specify true, AWS CloudFormation creates an instance with a publicly resolvable DNS name, which resolves to a public IP address. If you specify false, AWS CloudFormation creates an internal instance with a DNS name that resolves to a private IP address.\n\nThe default behavior value depends on your VPC setup and the database subnet group. For more information, see the `PubliclyAccessible` parameter in the [CreateDBInstance](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_CreateDBInstance.html) in the *Amazon RDS API Reference* .", "stability": "external", "summary": "Indicates whether the DB instance is an internet-facing instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3703 }, "name": "publiclyAccessible", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-replicamode" }, "remarks": "For more information, see [Working with Oracle Read Replicas for Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-read-replicas.html) in the *Amazon RDS User Guide* .\n\nThis setting is only supported in RDS for Oracle.\n\nDefault: `open-read-only`\n\nValid Values: `open-read-only` or `mounted`", "stability": "external", "summary": "The open mode of an Oracle read replica." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3716 }, "name": "replicaMode", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-restoretime" }, "remarks": "Valid Values: Value must be a time in Universal Coordinated Time (UTC) format\n\nConstraints:\n\n- Must be before the latest restorable time for the DB instance\n- Can't be specified if the `UseLatestRestorableTime` parameter is enabled\n\nExample: `2009-09-07T23:45:00Z`", "stability": "external", "summary": "The date and time to restore from." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3732 }, "name": "restoreTime", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbclusteridentifier" }, "remarks": "Each DB cluster can have up to 15 read replicas.\n\nConstraints:\n\n- Must be the identifier of an existing Multi-AZ DB cluster.\n- Can't be specified if the `SourceDBInstanceIdentifier` parameter is also specified.\n- The specified DB cluster must have automatic backups enabled, that is, its backup retention period must be greater than 0.\n- The source DB cluster must be in the same AWS Region as the read replica. Cross-Region replication isn't supported.", "stability": "external", "summary": "The identifier of the Multi-AZ DB cluster that will act as the source for the read replica." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3746 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceautomatedbackupsarn" }, "remarks": "This setting doesn't apply to RDS Custom.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the replicated automated backups from which to restore, for example, `arn:aws:rds:useast-1:123456789012:auto-backup:ab-L2IJCEXJP7XQ7HOJ4SIEXAMPLE` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3755 }, "name": "sourceDbInstanceAutomatedBackupsArn", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbinstanceidentifier" }, "remarks": "Each DB instance can have a limited number of read replicas. For more information, see [Working with Read Replicas](https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html) in the *Amazon RDS User Guide* .\n\nFor information about constraints that apply to DB instance identifiers, see [Naming constraints in Amazon RDS](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Limits.html#RDS_Limits.Constraints) in the *Amazon RDS User Guide* .\n\nThe `SourceDBInstanceIdentifier` property determines whether a DB instance is a read replica. If you remove the `SourceDBInstanceIdentifier` property from your template and then update your stack, AWS CloudFormation promotes the Read Replica to a standalone DB instance.\n\n> - If you specify a source DB instance that uses VPC security groups, we recommend that you specify the `VPCSecurityGroups` property. If you don't specify the property, the read replica inherits the value of the `VPCSecurityGroups` property from the source DB when you create the replica. However, if you update the stack, AWS CloudFormation reverts the replica's `VPCSecurityGroups` property to the default value because it's not defined in the stack's template. This change might cause unexpected issues.\n> - Read replicas don't support deletion policies. AWS CloudFormation ignores any deletion policy that's associated with a read replica.\n> - If you specify `SourceDBInstanceIdentifier` , don't specify the `DBSnapshotIdentifier` property. You can't create a read replica from a snapshot.\n> - Don't set the `BackupRetentionPeriod` , `DBName` , `MasterUsername` , `MasterUserPassword` , and `PreferredBackupWindow` properties. The database attributes are inherited from the source DB instance, and backups are disabled for read replicas.\n> - If the source DB instance is in a different region than the read replica, specify the source region in `SourceRegion` , and specify an ARN for a valid DB instance in `SourceDBInstanceIdentifier` . For more information, see [Constructing a Amazon RDS Amazon Resource Name (ARN)](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Tagging.html#USER_Tagging.ARN) in the *Amazon RDS User Guide* .\n> - For DB instances in Amazon Aurora clusters, don't specify this property. Amazon RDS automatically assigns writer and reader DB instances.", "stability": "external", "summary": "If you want to create a read replica DB instance, specify the ID of the source DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3773 }, "name": "sourceDbInstanceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourcedbiresourceid" }, "stability": "external", "summary": "The resource ID of the source DB instance from which to restore." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3780 }, "name": "sourceDbiResourceId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-sourceregion" }, "stability": "external", "summary": "The ID of the region that contains the source DB instance for the read replica." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3787 }, "name": "sourceRegion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storageencrypted" }, "remarks": "If you specify the `KmsKeyId` property, then you must enable encryption.\n\nIf you specify the `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the source DB instance, and if the DB instance is encrypted, the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot is encrypted, don't specify this property. The value is inherited from the snapshot, and the specified `KmsKeyId` property is used.\n\nIf you specify the `SnapshotIdentifier` and the specified snapshot isn't encrypted, you can use this property to specify that the restored DB instance is encrypted. Specify the `KmsKeyId` property for the KMS key to use for encryption. If you don't want the restored DB instance to be encrypted, then don't set this property or set it to `false` .\n\n*Amazon Aurora*\n\nNot applicable. The encryption for DB instances is managed by the DB cluster.", "stability": "external", "summary": "A value that indicates whether the DB instance is encrypted. By default, it isn't encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3806 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagethroughput" }, "remarks": "This setting doesn't apply to RDS Custom or Amazon Aurora.", "stability": "external", "summary": "Specifies the storage throughput value for the DB instance. This setting applies only to the `gp3` storage type." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3815 }, "name": "storageThroughput", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-storagetype" }, "remarks": "Valid values: `gp2 | gp3 | io1 | standard`\n\nThe `standard` value is also known as magnetic.\n\nIf you specify `io1` or `gp3` , you must also include a value for the `Iops` parameter.\n\nDefault: `io1` if the `Iops` parameter is specified, otherwise `gp2`\n\nFor more information, see [Amazon RDS DB Instance Storage](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html) in the *Amazon RDS User Guide* .\n\n*Amazon Aurora*\n\nNot applicable. Aurora data is stored in the cluster volume, which is a single, virtual volume that uses solid state drives (SSDs).", "stability": "external", "summary": "Specifies the storage type to be associated with the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3836 }, "name": "storageType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3843 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-timezone" }, "remarks": "The time zone parameter is currently supported only by [Microsoft SQL Server](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_SQLServer.html#SQLServer.Concepts.General.TimeZone) .", "stability": "external", "summary": "The time zone of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3850 }, "name": "timezone", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-usedefaultprocessorfeatures" }, "remarks": "This setting doesn't apply to RDS Custom.", "stability": "external", "summary": "A value that indicates whether the DB instance class of the DB instance uses its default processor features." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3859 }, "name": "useDefaultProcessorFeatures", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-uselatestrestorabletime" }, "remarks": "By default, the DB instance isn't restored from the latest backup time.\n\nConstraints: Can't be specified if the `RestoreTime` parameter is provided.", "stability": "external", "summary": "A value that indicates whether the DB instance is restored from the latest backup time." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3868 }, "name": "useLatestRestorableTime", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbinstance.html#cfn-rds-dbinstance-vpcsecuritygroups" }, "remarks": "The list can include both the physical IDs of existing VPC security groups and references to [AWS::EC2::SecurityGroup](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-security-group.html) resources created in the template.\n\nIf you plan to update the resource, don't specify VPC security groups in a shared VPC.\n\nIf you set `VPCSecurityGroups` , you must not set [`DBSecurityGroups`](https://docs.aws.amazon.com//AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) , and vice versa.\n\n> You can migrate a DB instance in your stack from an RDS DB security group to a VPC security group, but keep the following in mind:\n>\n> - You can't revert to using an RDS security group after you establish a VPC security group membership.\n> - When you migrate your DB instance to VPC security groups, if your stack update rolls back because the DB instance update fails or because an update fails in another AWS CloudFormation resource, the rollback fails because it can't revert to an RDS security group.\n> - To use the properties that are available when you use a VPC security group, you must recreate the DB instance. If you don't, AWS CloudFormation submits only the property values that are listed in the [`DBSecurityGroups`](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html#cfn-rds-dbinstance-dbsecuritygroups) property.\n\nTo avoid this situation, migrate your DB instance to using VPC security groups only when that is the only change in your stack template.\n\n*Amazon Aurora*\n\nNot applicable. The associated list of EC2 VPC security groups is managed by the DB cluster. If specified, the setting must match the DB cluster setting.", "stability": "external", "summary": "A list of the VPC security group IDs to assign to the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 3891 }, "name": "vpcSecurityGroups", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBInstanceProps" }, "@aws-cdk/aws-rds.CfnDBParameterGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBParameterGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBParameterGroup` resource creates a custom parameter group for an RDS database family.\n\nThis type can be declared in a template and referenced in the `DBParameterGroupName` property of an `[AWS::RDS::DBInstance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-database-instance.html)` resource.\n\nFor information about configuring parameters for Amazon RDS DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide* .\n\nFor information about configuring parameters for Amazon Aurora DB instances, see [Working with parameter groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* .\n\n> Applying a parameter group to a DB instance may require the DB instance to reboot, resulting in a database outage for the duration of the reboot.", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBParameterGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameters: any;\nconst cfnDBParameterGroup = new rds.CfnDBParameterGroup(this, 'MyCfnDBParameterGroup', {\n description: 'description',\n family: 'family',\n\n // the properties below are optional\n dbParameterGroupName: 'dbParameterGroupName',\n parameters: parameters,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBParameterGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBParameterGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6217 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBParameterGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6116 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6236 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6251 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBParameterGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6120 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBParameterGroupName" }, "stability": "external", "summary": "The name of the DB parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6145 }, "name": "attrDbParameterGroupName", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6241 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags" }, "remarks": "> Currently, this is the only property that supports drift detection.", "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6208 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description" }, "stability": "external", "summary": "Provides the customer-specified description for this DB parameter group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6152 }, "name": "description", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family" }, "remarks": "A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.\n\n> The DB parameter group family can't be changed when updating a DB parameter group.\n\nTo list all of the available parameter group families, use the following command:\n\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`\n\nThe output contains duplicates.\n\nFor more information, see `[CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)` .", "stability": "external", "summary": "The DB parameter group family name." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6169 }, "name": "family", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters" }, "remarks": "At least one parameter name and value must be supplied. Subsequent arguments are optional.\n\nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide* .\n\nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* .\n\n> AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.", "stability": "external", "summary": "An array of parameter names and values for the parameter update." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6199 }, "name": "parameters", "type": { "primitive": "any" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-dbparametergroupname" }, "remarks": "Constraints:\n\n- Must be 1 to 255 letters, numbers, or hyphens.\n- First character must be a letter\n- Can't end with a hyphen or contain two consecutive hyphens\n\nIf you don't specify a value for `DBParameterGroupName` property, a name is automatically created for the DB parameter group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the DB parameter group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6186 }, "name": "dbParameterGroupName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBParameterGroup" }, "@aws-cdk/aws-rds.CfnDBParameterGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBParameterGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameters: any;\nconst cfnDBParameterGroupProps: rds.CfnDBParameterGroupProps = {\n description: 'description',\n family: 'family',\n\n // the properties below are optional\n dbParameterGroupName: 'dbParameterGroupName',\n parameters: parameters,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBParameterGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5973 }, "name": "CfnDBParameterGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-description" }, "stability": "external", "summary": "Provides the customer-specified description for this DB parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5980 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-family" }, "remarks": "A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a DB engine and engine version compatible with that DB parameter group family.\n\n> The DB parameter group family can't be changed when updating a DB parameter group.\n\nTo list all of the available parameter group families, use the following command:\n\n`aws rds describe-db-engine-versions --query \"DBEngineVersions[].DBParameterGroupFamily\"`\n\nThe output contains duplicates.\n\nFor more information, see `[CreateDBParameterGroup](https://docs.aws.amazon.com//AmazonRDS/latest/APIReference/API_CreateDBParameterGroup.html)` .", "stability": "external", "summary": "The DB parameter group family name." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 5997 }, "name": "family", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-dbparametergroupname" }, "remarks": "Constraints:\n\n- Must be 1 to 255 letters, numbers, or hyphens.\n- First character must be a letter\n- Can't end with a hyphen or contain two consecutive hyphens\n\nIf you don't specify a value for `DBParameterGroupName` property, a name is automatically created for the DB parameter group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the DB parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6014 }, "name": "dbParameterGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-parameters" }, "remarks": "At least one parameter name and value must be supplied. Subsequent arguments are optional.\n\nFor more information about DB parameters and DB parameter groups for Amazon RDS DB engines, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide* .\n\nFor more information about DB cluster and DB instance parameters and parameter groups for Amazon Aurora DB engines, see [Working with DB Parameter Groups and DB Cluster Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_WorkingWithParamGroups.html) in the *Amazon Aurora User Guide* .\n\n> AWS CloudFormation doesn't support specifying an apply method for each individual parameter. The default apply method for each parameter is used.", "stability": "external", "summary": "An array of parameter names and values for the parameter update." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6027 }, "name": "parameters", "optional": true, "type": { "primitive": "any" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbparametergroup.html#cfn-rds-dbparametergroup-tags" }, "remarks": "> Currently, this is the only property that supports drift detection.", "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6036 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBParameterGroupProps" }, "@aws-cdk/aws-rds.CfnDBProxy": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBProxy", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBProxy` resource creates or updates a DB proxy.\n\nFor information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide* .\n\nFor information about RDS Proxy for Amazon Aurora, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide* .\n\n> Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.\n>\n> For information about limitations that apply to RDS Proxy for Amazon RDS, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide* .\n>\n> For information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBProxy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxy = new rds.CfnDBProxy(this, 'MyCfnDBProxy', {\n auth: [{\n authScheme: 'authScheme',\n clientPasswordAuthType: 'clientPasswordAuthType',\n description: 'description',\n iamAuth: 'iamAuth',\n secretArn: 'secretArn',\n }],\n dbProxyName: 'dbProxyName',\n engineFamily: 'engineFamily',\n roleArn: 'roleArn',\n vpcSubnetIds: ['vpcSubnetIds'],\n\n // the properties below are optional\n debugLogging: false,\n idleClientTimeout: 123,\n requireTls: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxy", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBProxy`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6562 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBProxyProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6438 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6591 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6611 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBProxy", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6442 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBProxyArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) representing the target group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6467 }, "name": "attrDbProxyArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint" }, "stability": "external", "summary": "The writer endpoint for the RDS DB instance or Aurora DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6473 }, "name": "attrEndpoint", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "VpcId" }, "stability": "external", "summary": "The VPC ID to associate with the DB proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6479 }, "name": "attrVpcId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6596 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth" }, "stability": "external", "summary": "The authorization mechanism that the proxy uses." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6486 }, "name": "auth", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBProxy.AuthFormatProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-dbproxyname" }, "remarks": "This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.", "stability": "external", "summary": "The identifier for the proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6493 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily" }, "remarks": "This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL` . For RDS for Microsoft SQL Server, specify `SQLSERVER` .\n\n*Valid values* : `MYSQL` | `POSTGRESQL` | `SQLSERVER`", "stability": "external", "summary": "The kinds of databases that the proxy can connect to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6502 }, "name": "engineFamily", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6509 }, "name": "roleArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsubnetids" }, "stability": "external", "summary": "One or more VPC subnet IDs to associate with the new proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6516 }, "name": "vpcSubnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging" }, "remarks": "This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.", "stability": "external", "summary": "Whether the proxy includes detailed information about SQL statements in its logs." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6523 }, "name": "debugLogging", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout" }, "remarks": "You can set this value higher or lower than the connection timeout limit for the associated database.", "stability": "external", "summary": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6530 }, "name": "idleClientTimeout", "optional": true, "type": { "primitive": "number" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls" }, "remarks": "By enabling this setting, you can enforce encrypted TLS connections to the proxy.", "stability": "external", "summary": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6537 }, "name": "requireTls", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-tags" }, "stability": "external", "summary": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6544 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.CfnDBProxy.TagFormatProperty" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsecuritygroupids" }, "remarks": "If you plan to update the resource, don't specify VPC security groups in a shared VPC.", "stability": "external", "summary": "One or more VPC security group IDs to associate with the new proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6553 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxy" }, "@aws-cdk/aws-rds.CfnDBProxy.AuthFormatProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Specifies the details of authentication used by a proxy to log in as a specific database user.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst authFormatProperty: rds.CfnDBProxy.AuthFormatProperty = {\n authScheme: 'authScheme',\n clientPasswordAuthType: 'clientPasswordAuthType',\n description: 'description',\n iamAuth: 'iamAuth',\n secretArn: 'secretArn',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxy.AuthFormatProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6625 }, "name": "AuthFormatProperty", "namespace": "CfnDBProxy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-authscheme" }, "remarks": "Valid Values: `SECRETS`", "stability": "external", "summary": "The type of authentication that the proxy uses for connections from the proxy to the underlying database." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6633 }, "name": "authScheme", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-clientpasswordauthtype" }, "stability": "external", "summary": "Specifies the details of authentication used by a proxy to log in as a specific database user." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6639 }, "name": "clientPasswordAuthType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-description" }, "stability": "external", "summary": "A user-specified description about the authentication used by a proxy to log in as a specific database user." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6645 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-iamauth" }, "remarks": "The `ENABLED` value is valid only for proxies with RDS for Microsoft SQL Server.\n\nValid Values: `ENABLED | DISABLED | REQUIRED`", "stability": "external", "summary": "Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6653 }, "name": "iamAuth", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-authformat.html#cfn-rds-dbproxy-authformat-secretarn" }, "remarks": "These secrets are stored within Amazon Secrets Manager.", "stability": "external", "summary": "The Amazon Resource Name (ARN) representing the secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6659 }, "name": "secretArn", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBProxy.AuthFormatProperty" }, "@aws-cdk/aws-rds.CfnDBProxy.TagFormatProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Metadata assigned to a DB proxy consisting of a key-value pair.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst tagFormatProperty: rds.CfnDBProxy.TagFormatProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxy.TagFormatProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6732 }, "name": "TagFormatProperty", "namespace": "CfnDBProxy", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-key" }, "remarks": "The string value can be 1-128 Unicode characters in length and can't be prefixed with `aws:` . The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").", "stability": "external", "summary": "A key is the required name of the tag." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6738 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxy-tagformat.html#cfn-rds-dbproxy-tagformat-value" }, "remarks": "The string value can be 1-256 Unicode characters in length and can't be prefixed with `aws:` . The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").", "stability": "external", "summary": "A value is the optional value of the tag." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6744 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBProxy.TagFormatProperty" }, "@aws-cdk/aws-rds.CfnDBProxyEndpoint": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBProxyEndpoint", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBProxyEndpoint` resource creates or updates a DB proxy endpoint. You can use custom proxy endpoints to access a proxy through a different VPC than the proxy's default VPC.\n\nFor more information about RDS Proxy, see [AWS::RDS::DBProxy](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html) .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBProxyEndpoint`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxyEndpoint = new rds.CfnDBProxyEndpoint(this, 'MyCfnDBProxyEndpoint', {\n dbProxyEndpointName: 'dbProxyEndpointName',\n dbProxyName: 'dbProxyName',\n vpcSubnetIds: ['vpcSubnetIds'],\n\n // the properties below are optional\n tags: [{\n key: 'key',\n value: 'value',\n }],\n targetRole: 'targetRole',\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpoint", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBProxyEndpoint`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7029 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpointProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6929 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7053 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7069 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBProxyEndpoint", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6933 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "DBProxyEndpointArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) representing the DB proxy endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6958 }, "name": "attrDbProxyEndpointArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "Endpoint" }, "stability": "external", "summary": "The custom endpoint for the RDS DB instance or Aurora DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6964 }, "name": "attrEndpoint", "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "IsDefault" }, "remarks": "Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.", "stability": "external", "summary": "A value that indicates whether this endpoint is the default endpoint for the associated DB proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6970 }, "name": "attrIsDefault", "type": { "fqn": "@aws-cdk/core.IResolvable" } }, { "docs": { "custom": { "cloudformationAttribute": "VpcId" }, "stability": "external", "summary": "The VPC ID of the DB proxy endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6976 }, "name": "attrVpcId", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7058 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyendpointname" }, "stability": "external", "summary": "The name of the DB proxy endpoint to create." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6983 }, "name": "dbProxyEndpointName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyname" }, "stability": "external", "summary": "The name of the DB proxy associated with the DB proxy endpoint that you create." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6990 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsubnetids" }, "remarks": "You can specify a different set of subnet IDs than for the original DB proxy.", "stability": "external", "summary": "The VPC subnet IDs for the DB proxy endpoint that you create." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6997 }, "name": "vpcSubnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-tags" }, "stability": "external", "summary": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7004 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpoint.TagFormatProperty" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole" }, "remarks": "Valid Values: `READ_WRITE | READ_ONLY`", "stability": "external", "summary": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7013 }, "name": "targetRole", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsecuritygroupids" }, "remarks": "You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.", "stability": "external", "summary": "The VPC security group IDs for the DB proxy endpoint that you create." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7020 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyEndpoint" }, "@aws-cdk/aws-rds.CfnDBProxyEndpoint.TagFormatProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Metadata assigned to a DB proxy endpoint consisting of a key-value pair.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst tagFormatProperty: rds.CfnDBProxyEndpoint.TagFormatProperty = {\n key: 'key',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpoint.TagFormatProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7083 }, "name": "TagFormatProperty", "namespace": "CfnDBProxyEndpoint", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-key" }, "remarks": "The string value can be 1-256 Unicode characters in length and can't be prefixed with `aws:` . The string can contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").", "stability": "external", "summary": "A value is the optional value of the tag." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7089 }, "name": "key", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxyendpoint-tagformat.html#cfn-rds-dbproxyendpoint-tagformat-value" }, "stability": "external", "summary": "Metadata assigned to a DB instance consisting of a key-value pair." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7095 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBProxyEndpoint.TagFormatProperty" }, "@aws-cdk/aws-rds.CfnDBProxyEndpointProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBProxyEndpoint`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxyEndpointProps: rds.CfnDBProxyEndpointProps = {\n dbProxyEndpointName: 'dbProxyEndpointName',\n dbProxyName: 'dbProxyName',\n vpcSubnetIds: ['vpcSubnetIds'],\n\n // the properties below are optional\n tags: [{\n key: 'key',\n value: 'value',\n }],\n targetRole: 'targetRole',\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpointProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6807 }, "name": "CfnDBProxyEndpointProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyendpointname" }, "stability": "external", "summary": "The name of the DB proxy endpoint to create." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6814 }, "name": "dbProxyEndpointName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-dbproxyname" }, "stability": "external", "summary": "The name of the DB proxy associated with the DB proxy endpoint that you create." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6821 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsubnetids" }, "remarks": "You can specify a different set of subnet IDs than for the original DB proxy.", "stability": "external", "summary": "The VPC subnet IDs for the DB proxy endpoint that you create." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6828 }, "name": "vpcSubnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-tags" }, "stability": "external", "summary": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6835 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.CfnDBProxyEndpoint.TagFormatProperty" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-targetrole" }, "remarks": "Valid Values: `READ_WRITE | READ_ONLY`", "stability": "external", "summary": "A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6844 }, "name": "targetRole", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html#cfn-rds-dbproxyendpoint-vpcsecuritygroupids" }, "remarks": "You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.", "stability": "external", "summary": "The VPC security group IDs for the DB proxy endpoint that you create." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6851 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyEndpointProps" }, "@aws-cdk/aws-rds.CfnDBProxyProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBProxy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxyProps: rds.CfnDBProxyProps = {\n auth: [{\n authScheme: 'authScheme',\n clientPasswordAuthType: 'clientPasswordAuthType',\n description: 'description',\n iamAuth: 'iamAuth',\n secretArn: 'secretArn',\n }],\n dbProxyName: 'dbProxyName',\n engineFamily: 'engineFamily',\n roleArn: 'roleArn',\n vpcSubnetIds: ['vpcSubnetIds'],\n\n // the properties below are optional\n debugLogging: false,\n idleClientTimeout: 123,\n requireTls: false,\n tags: [{\n key: 'key',\n value: 'value',\n }],\n vpcSecurityGroupIds: ['vpcSecurityGroupIds'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6264 }, "name": "CfnDBProxyProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-auth" }, "stability": "external", "summary": "The authorization mechanism that the proxy uses." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6271 }, "name": "auth", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBProxy.AuthFormatProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-dbproxyname" }, "remarks": "This name must be unique for all proxies owned by your AWS account in the specified AWS Region . An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it can't end with a hyphen or contain two consecutive hyphens.", "stability": "external", "summary": "The identifier for the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6278 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-enginefamily" }, "remarks": "This value determines which database network protocol the proxy recognizes when it interprets network traffic to and from the database. For Aurora MySQL, RDS for MariaDB, and RDS for MySQL databases, specify `MYSQL` . For Aurora PostgreSQL and RDS for PostgreSQL databases, specify `POSTGRESQL` . For RDS for Microsoft SQL Server, specify `SQLSERVER` .\n\n*Valid values* : `MYSQL` | `POSTGRESQL` | `SQLSERVER`", "stability": "external", "summary": "The kinds of databases that the proxy can connect to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6287 }, "name": "engineFamily", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-rolearn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6294 }, "name": "roleArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsubnetids" }, "stability": "external", "summary": "One or more VPC subnet IDs to associate with the new proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6301 }, "name": "vpcSubnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-debuglogging" }, "remarks": "This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections. The debug information includes the text of SQL statements that you submit through the proxy. Thus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive information that appears in the logs.", "stability": "external", "summary": "Whether the proxy includes detailed information about SQL statements in its logs." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6308 }, "name": "debugLogging", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-idleclienttimeout" }, "remarks": "You can set this value higher or lower than the connection timeout limit for the associated database.", "stability": "external", "summary": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6315 }, "name": "idleClientTimeout", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-requiretls" }, "remarks": "By enabling this setting, you can enforce encrypted TLS connections to the proxy.", "stability": "external", "summary": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6322 }, "name": "requireTls", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-tags" }, "stability": "external", "summary": "An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6329 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.CfnDBProxy.TagFormatProperty" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#cfn-rds-dbproxy-vpcsecuritygroupids" }, "remarks": "If you plan to update the resource, don't specify VPC security groups in a shared VPC.", "stability": "external", "summary": "One or more VPC security group IDs to associate with the new proxy." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 6338 }, "name": "vpcSecurityGroupIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyProps" }, "@aws-cdk/aws-rds.CfnDBProxyTargetGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBProxyTargetGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBProxyTargetGroup` resource represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.\n\nThis data type is used as a response element in the `DescribeDBProxyTargetGroups` action.\n\nFor information about RDS Proxy for Amazon RDS, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html) in the *Amazon RDS User Guide* .\n\nFor information about RDS Proxy for Amazon Aurora, see [Managing Connections with Amazon RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html) in the *Amazon Aurora User Guide* .\n\nFor a sample template that creates a DB proxy and registers a DB instance, see [Examples](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxy.html#aws-resource-rds-dbproxy--examples) in AWS::RDS::DBProxy.\n\n> Limitations apply to RDS Proxy, including DB engine version limitations and AWS Region limitations.\n>\n> For information about limitations that apply to RDS Proxy for Amazon RDS, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon RDS User Guide* .\n>\n> For information about that apply to RDS Proxy for Amazon Aurora, see [Limitations for RDS Proxy](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy.html#rds-proxy.limitations) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBProxyTargetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxyTargetGroup = new rds.CfnDBProxyTargetGroup(this, 'MyCfnDBProxyTargetGroup', {\n dbProxyName: 'dbProxyName',\n targetGroupName: 'targetGroupName',\n\n // the properties below are optional\n connectionPoolConfigurationInfo: {\n connectionBorrowTimeout: 123,\n initQuery: 'initQuery',\n maxConnectionsPercent: 123,\n maxIdleConnectionsPercent: 123,\n sessionPinningFilters: ['sessionPinningFilters'],\n },\n dbClusterIdentifiers: ['dbClusterIdentifiers'],\n dbInstanceIdentifiers: ['dbInstanceIdentifiers'],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBProxyTargetGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7356 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7281 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7375 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7390 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBProxyTargetGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7285 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "cloudformationAttribute": "TargetGroupArn" }, "stability": "external", "summary": "The Amazon Resource Name (ARN) representing the target group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7310 }, "name": "attrTargetGroupArn", "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7380 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbproxyname" }, "stability": "external", "summary": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7317 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-targetgroupname" }, "remarks": "> Currently, this property must be set to `default` .", "stability": "external", "summary": "The identifier for the target group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7326 }, "name": "targetGroupName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfo" }, "stability": "external", "summary": "Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` ." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7333 }, "name": "connectionPoolConfigurationInfo", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbclusteridentifiers" }, "stability": "external", "summary": "One or more DB cluster identifiers." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7340 }, "name": "dbClusterIdentifiers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbinstanceidentifiers" }, "stability": "external", "summary": "One or more DB instance identifiers." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7347 }, "name": "dbInstanceIdentifiers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyTargetGroup" }, "@aws-cdk/aws-rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Specifies the settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` .", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst connectionPoolConfigurationInfoFormatProperty: rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty = {\n connectionBorrowTimeout: 123,\n initQuery: 'initQuery',\n maxConnectionsPercent: 123,\n maxIdleConnectionsPercent: 123,\n sessionPinningFilters: ['sessionPinningFilters'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7404 }, "name": "ConnectionPoolConfigurationInfoFormatProperty", "namespace": "CfnDBProxyTargetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-connectionborrowtimeout" }, "remarks": "Only applies when the proxy has opened its maximum number of connections and all connections are busy with client sessions.\n\nDefault: 120\n\nConstraints: between 1 and 3600, or 0 representing unlimited", "stability": "external", "summary": "The number of seconds for a proxy to wait for a connection to become available in the connection pool." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7414 }, "name": "connectionBorrowTimeout", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-initquery" }, "remarks": "Typically used with `SET` statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single `SET` statement, such as `SET x=1, y=2` .\n\nDefault: no initialization query", "stability": "external", "summary": "One or more SQL statements for the proxy to run when opening each new database connection." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7422 }, "name": "initQuery", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-maxconnectionspercent" }, "remarks": "The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group.\n\nIf you specify `MaxIdleConnectionsPercent` , then you must also include a value for this parameter.\n\nDefault: 10 for RDS for Microsoft SQL Server, and 100 for all other engines\n\nConstraints: Must be between 1 and 100.", "stability": "external", "summary": "The maximum size of the connection pool for each target in a target group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7434 }, "name": "maxConnectionsPercent", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-maxidleconnectionspercent" }, "remarks": "The value is expressed as a percentage of the `max_connections` setting for the RDS DB instance or Aurora DB cluster used by the target group. With a high value, the proxy leaves a high percentage of idle database connections open. A low value causes the proxy to close more idle connections and return them to the database.\n\nIf you specify this parameter, then you must also include a value for `MaxConnectionsPercent` .\n\nDefault: The default value is half of the value of `MaxConnectionsPercent` . For example, if `MaxConnectionsPercent` is 80, then the default value of `MaxIdleConnectionsPercent` is 40. If the value of `MaxConnectionsPercent` isn't specified, then for SQL Server, `MaxIdleConnectionsPercent` is 5, and for all other engines, the default is 50.\n\nConstraints: Must be between 0 and the value of `MaxConnectionsPercent` .", "stability": "external", "summary": "Controls how actively the proxy closes idle database connections in the connection pool." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7446 }, "name": "maxIdleConnectionsPercent", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfoformat-sessionpinningfilters" }, "remarks": "Including an item in the list exempts that class of SQL operations from the pinning behavior.\n\nDefault: no session pinning filters", "stability": "external", "summary": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7454 }, "name": "sessionPinningFilters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty" }, "@aws-cdk/aws-rds.CfnDBProxyTargetGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBProxyTargetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBProxyTargetGroupProps: rds.CfnDBProxyTargetGroupProps = {\n dbProxyName: 'dbProxyName',\n targetGroupName: 'targetGroupName',\n\n // the properties below are optional\n connectionPoolConfigurationInfo: {\n connectionBorrowTimeout: 123,\n initQuery: 'initQuery',\n maxConnectionsPercent: 123,\n maxIdleConnectionsPercent: 123,\n sessionPinningFilters: ['sessionPinningFilters'],\n },\n dbClusterIdentifiers: ['dbClusterIdentifiers'],\n dbInstanceIdentifiers: ['dbInstanceIdentifiers'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7158 }, "name": "CfnDBProxyTargetGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbproxyname" }, "stability": "external", "summary": "The identifier of the `DBProxy` that is associated with the `DBProxyTargetGroup` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7165 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-targetgroupname" }, "remarks": "> Currently, this property must be set to `default` .", "stability": "external", "summary": "The identifier for the target group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7174 }, "name": "targetGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-connectionpoolconfigurationinfo" }, "stability": "external", "summary": "Settings that control the size and behavior of the connection pool associated with a `DBProxyTargetGroup` ." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7181 }, "name": "connectionPoolConfigurationInfo", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBProxyTargetGroup.ConnectionPoolConfigurationInfoFormatProperty" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbclusteridentifiers" }, "stability": "external", "summary": "One or more DB cluster identifiers." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7188 }, "name": "dbClusterIdentifiers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxytargetgroup.html#cfn-rds-dbproxytargetgroup-dbinstanceidentifiers" }, "stability": "external", "summary": "One or more DB instance identifiers." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7195 }, "name": "dbInstanceIdentifiers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBProxyTargetGroupProps" }, "@aws-cdk/aws-rds.CfnDBSecurityGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBSecurityGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBSecurityGroup` resource creates or updates an Amazon RDS DB security group.\n\n> EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide* , the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](https://docs.aws.amazon.com/aws/ec2-classic-is-retiring-heres-how-to-prepare/) , and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBSecurityGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSecurityGroup = new rds.CfnDBSecurityGroup(this, 'MyCfnDBSecurityGroup', {\n dbSecurityGroupIngress: [{\n cidrip: 'cidrip',\n ec2SecurityGroupId: 'ec2SecurityGroupId',\n ec2SecurityGroupName: 'ec2SecurityGroupName',\n ec2SecurityGroupOwnerId: 'ec2SecurityGroupOwnerId',\n }],\n groupDescription: 'groupDescription',\n\n // the properties below are optional\n ec2VpcId: 'ec2VpcId',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBSecurityGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7689 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7627 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7706 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7720 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBSecurityGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7631 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7711 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB security group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7680 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress" }, "stability": "external", "summary": "Ingress rules to be applied to the DB security group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7657 }, "name": "dbSecurityGroupIngress", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroup.IngressProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription" }, "stability": "external", "summary": "Provides the description of the DB security group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7664 }, "name": "groupDescription", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid" }, "remarks": "> The `EC2VpcId` property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance.", "stability": "external", "summary": "The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7673 }, "name": "ec2VpcId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBSecurityGroup" }, "@aws-cdk/aws-rds.CfnDBSecurityGroup.IngressProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html", "exampleMetadata": "fixture=_generated" }, "remarks": "> EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide* , the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](https://docs.aws.amazon.com/aws/ec2-classic-is-retiring-heres-how-to-prepare/) , and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "The `Ingress` property type specifies an individual ingress rule within an `AWS::RDS::DBSecurityGroup` resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst ingressProperty: rds.CfnDBSecurityGroup.IngressProperty = {\n cidrip: 'cidrip',\n ec2SecurityGroupId: 'ec2SecurityGroupId',\n ec2SecurityGroupName: 'ec2SecurityGroupName',\n ec2SecurityGroupOwnerId: 'ec2SecurityGroupOwnerId',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroup.IngressProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7736 }, "name": "IngressProperty", "namespace": "CfnDBSecurityGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-cidrip" }, "stability": "external", "summary": "The IP range to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7742 }, "name": "cidrip", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupid" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Id of the EC2 security group to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7748 }, "name": "ec2SecurityGroupId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupname" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Name of the EC2 security group to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7754 }, "name": "ec2SecurityGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group-rule.html#cfn-rds-securitygroup-ec2securitygroupownerid" }, "remarks": "The AWS access key ID isn't an acceptable value. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7760 }, "name": "ec2SecurityGroupOwnerId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBSecurityGroup.IngressProperty" }, "@aws-cdk/aws-rds.CfnDBSecurityGroupIngress": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBSecurityGroupIngress", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBSecurityGroupIngress` resource enables ingress to a DB security group using one of two forms of authorization. First, you can add EC2 or VPC security groups to the DB security group if the application using the database is running on EC2 or VPC instances. Second, IP ranges are available if the application accessing your database is running on the Internet.\n\nThis type supports updates. For more information about updating stacks, see [AWS CloudFormation Stacks Updates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html) .\n\nFor details about the settings for DB security group ingress, see [AuthorizeDBSecurityGroupIngress](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_AuthorizeDBSecurityGroupIngress.html) .\n\n> EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see [Migrate from EC2-Classic to a VPC](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html) in the *Amazon EC2 User Guide* , the blog [EC2-Classic Networking is Retiring – Here’s How to Prepare](https://docs.aws.amazon.com/aws/ec2-classic-is-retiring-heres-how-to-prepare/) , and [Moving a DB instance not in a VPC into a VPC](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBSecurityGroupIngress`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSecurityGroupIngress = new rds.CfnDBSecurityGroupIngress(this, 'MyCfnDBSecurityGroupIngress', {\n dbSecurityGroupName: 'dbSecurityGroupName',\n\n // the properties below are optional\n cidrip: 'cidrip',\n ec2SecurityGroupId: 'ec2SecurityGroupId',\n ec2SecurityGroupName: 'ec2SecurityGroupName',\n ec2SecurityGroupOwnerId: 'ec2SecurityGroupOwnerId',\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroupIngress", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBSecurityGroupIngress`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8008 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroupIngressProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7941 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8025 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8040 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBSecurityGroupIngress", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7945 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8030 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname" }, "stability": "external", "summary": "The name of the DB security group to add authorization to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7971 }, "name": "dbSecurityGroupName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip" }, "stability": "external", "summary": "The IP range to authorize." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7978 }, "name": "cidrip", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Id of the EC2 security group to authorize." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7985 }, "name": "ec2SecurityGroupId", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Name of the EC2 security group to authorize." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7992 }, "name": "ec2SecurityGroupName", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid" }, "remarks": "The AWS access key ID isn't an acceptable value. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7999 }, "name": "ec2SecurityGroupOwnerId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBSecurityGroupIngress" }, "@aws-cdk/aws-rds.CfnDBSecurityGroupIngressProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBSecurityGroupIngress`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSecurityGroupIngressProps: rds.CfnDBSecurityGroupIngressProps = {\n dbSecurityGroupName: 'dbSecurityGroupName',\n\n // the properties below are optional\n cidrip: 'cidrip',\n ec2SecurityGroupId: 'ec2SecurityGroupId',\n ec2SecurityGroupName: 'ec2SecurityGroupName',\n ec2SecurityGroupOwnerId: 'ec2SecurityGroupOwnerId',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroupIngressProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7829 }, "name": "CfnDBSecurityGroupIngressProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-dbsecuritygroupname" }, "stability": "external", "summary": "The name of the DB security group to add authorization to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7836 }, "name": "dbSecurityGroupName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-cidrip" }, "stability": "external", "summary": "The IP range to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7843 }, "name": "cidrip", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupid" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Id of the EC2 security group to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7850 }, "name": "ec2SecurityGroupId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupname" }, "remarks": "For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "Name of the EC2 security group to authorize." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7857 }, "name": "ec2SecurityGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-security-group-ingress.html#cfn-rds-securitygroup-ingress-ec2securitygroupownerid" }, "remarks": "The AWS access key ID isn't an acceptable value. For VPC DB security groups, `EC2SecurityGroupId` must be provided. Otherwise, `EC2SecurityGroupOwnerId` and either `EC2SecurityGroupName` or `EC2SecurityGroupId` must be provided.", "stability": "external", "summary": "AWS account number of the owner of the EC2 security group specified in the `EC2SecurityGroupName` parameter." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7864 }, "name": "ec2SecurityGroupOwnerId", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBSecurityGroupIngressProps" }, "@aws-cdk/aws-rds.CfnDBSecurityGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBSecurityGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSecurityGroupProps: rds.CfnDBSecurityGroupProps = {\n dbSecurityGroupIngress: [{\n cidrip: 'cidrip',\n ec2SecurityGroupId: 'ec2SecurityGroupId',\n ec2SecurityGroupName: 'ec2SecurityGroupName',\n ec2SecurityGroupOwnerId: 'ec2SecurityGroupOwnerId',\n }],\n groupDescription: 'groupDescription',\n\n // the properties below are optional\n ec2VpcId: 'ec2VpcId',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7526 }, "name": "CfnDBSecurityGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-dbsecuritygroupingress" }, "stability": "external", "summary": "Ingress rules to be applied to the DB security group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7533 }, "name": "dbSecurityGroupIngress", "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnDBSecurityGroup.IngressProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-groupdescription" }, "stability": "external", "summary": "Provides the description of the DB security group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7540 }, "name": "groupDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-ec2vpcid" }, "remarks": "> The `EC2VpcId` property is for backward compatibility with older regions, and is no longer recommended for providing security information to an RDS DB instance.", "stability": "external", "summary": "The identifier of an Amazon VPC. This property indicates the VPC that this DB security group belongs to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7549 }, "name": "ec2VpcId", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-security-group.html#cfn-rds-dbsecuritygroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB security group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 7556 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBSecurityGroupProps" }, "@aws-cdk/aws-rds.CfnDBSubnetGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::DBSubnetGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::DBSubnetGroup` resource creates a database subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same region.\n\nFor more information, see [Working with DB subnet groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html#USER_VPC.Subnets) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::DBSubnetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSubnetGroup = new rds.CfnDBSubnetGroup(this, 'MyCfnDBSubnetGroup', {\n dbSubnetGroupDescription: 'dbSubnetGroupDescription',\n subnetIds: ['subnetIds'],\n\n // the properties below are optional\n dbSubnetGroupName: 'dbSubnetGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnDBSubnetGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::DBSubnetGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8220 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnDBSubnetGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8156 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8237 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8251 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnDBSubnetGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8160 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8242 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8211 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription" }, "stability": "external", "summary": "The description for the DB subnet group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8186 }, "name": "dbSubnetGroupDescription", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-subnetids" }, "stability": "external", "summary": "The EC2 Subnet IDs for the DB subnet group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8193 }, "name": "subnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname" }, "remarks": "Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be \"Default\".\n\nExample: `mysubnetgroup`", "stability": "external", "summary": "The name for the DB subnet group. This value is stored as a lowercase string." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8204 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnDBSubnetGroup" }, "@aws-cdk/aws-rds.CfnDBSubnetGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnDBSubnetGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnDBSubnetGroupProps: rds.CfnDBSubnetGroupProps = {\n dbSubnetGroupDescription: 'dbSubnetGroupDescription',\n subnetIds: ['subnetIds'],\n\n // the properties below are optional\n dbSubnetGroupName: 'dbSubnetGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnDBSubnetGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8053 }, "name": "CfnDBSubnetGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupdescription" }, "stability": "external", "summary": "The description for the DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8060 }, "name": "dbSubnetGroupDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-subnetids" }, "stability": "external", "summary": "The EC2 Subnet IDs for the DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8067 }, "name": "subnetIds", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-dbsubnetgroupname" }, "remarks": "Constraints: Must contain no more than 255 lowercase alphanumeric characters or hyphens. Must not be \"Default\".\n\nExample: `mysubnetgroup`", "stability": "external", "summary": "The name for the DB subnet group. This value is stored as a lowercase string." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8078 }, "name": "dbSubnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbsubnetgroup.html#cfn-rds-dbsubnetgroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8085 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnDBSubnetGroupProps" }, "@aws-cdk/aws-rds.CfnEventSubscription": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::EventSubscription", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::EventSubscription` resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS). For more information, see [Using Amazon RDS Event Notification](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.html) in the *Amazon RDS User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::EventSubscription`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnEventSubscription = new rds.CfnEventSubscription(this, 'MyCfnEventSubscription', {\n snsTopicArn: 'snsTopicArn',\n\n // the properties below are optional\n enabled: false,\n eventCategories: ['eventCategories'],\n sourceIds: ['sourceIds'],\n sourceType: 'sourceType',\n subscriptionName: 'subscriptionName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnEventSubscription", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::EventSubscription`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8499 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnEventSubscriptionProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8404 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8518 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8535 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnEventSubscription", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8408 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8523 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this subscription." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8490 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn" }, "remarks": "The ARN is created by Amazon SNS when you create a topic and subscribe to it.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the SNS topic created for event notification." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8434 }, "name": "snsTopicArn", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled" }, "remarks": "If the event notification subscription isn't activated, the subscription is created but not active.", "stability": "external", "summary": "A value that indicates whether to activate the subscription." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8441 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories" }, "remarks": "You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [*Amazon RDS User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [*Amazon Aurora User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html) . You can also see this list by using the `DescribeEventCategories` operation.", "stability": "external", "summary": "A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8448 }, "name": "eventCategories", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids" }, "remarks": "If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.\n\nConstraints:\n\n- If a `SourceIds` value is supplied, `SourceType` must also be provided.\n- If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied.\n- If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied.\n- If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied.\n- If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied.\n- If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied.\n- If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied.", "stability": "external", "summary": "The list of identifiers of the event sources for which events are returned." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8465 }, "name": "sourceIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype" }, "remarks": "For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance` . If this value isn't specified, all events are returned.\n\nValid values: `db-instance` | `db-cluster` | `db-parameter-group` | `db-security-group` | `db-snapshot` | `db-cluster-snapshot`", "stability": "external", "summary": "The type of source that is generating the events." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8474 }, "name": "sourceType", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-subscriptionname" }, "remarks": "Constraints: The name must be less than 255 characters.", "stability": "external", "summary": "The name of the subscription." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8483 }, "name": "subscriptionName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnEventSubscription" }, "@aws-cdk/aws-rds.CfnEventSubscriptionProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnEventSubscription`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnEventSubscriptionProps: rds.CfnEventSubscriptionProps = {\n snsTopicArn: 'snsTopicArn',\n\n // the properties below are optional\n enabled: false,\n eventCategories: ['eventCategories'],\n sourceIds: ['sourceIds'],\n sourceType: 'sourceType',\n subscriptionName: 'subscriptionName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnEventSubscriptionProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8264 }, "name": "CfnEventSubscriptionProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn" }, "remarks": "The ARN is created by Amazon SNS when you create a topic and subscribe to it.", "stability": "external", "summary": "The Amazon Resource Name (ARN) of the SNS topic created for event notification." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8271 }, "name": "snsTopicArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled" }, "remarks": "If the event notification subscription isn't activated, the subscription is created but not active.", "stability": "external", "summary": "A value that indicates whether to activate the subscription." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8278 }, "name": "enabled", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories" }, "remarks": "You can see a list of the categories for a given source type in the \"Amazon RDS event categories and event messages\" section of the [*Amazon RDS User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html) or the [*Amazon Aurora User Guide*](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html) . You can also see this list by using the `DescribeEventCategories` operation.", "stability": "external", "summary": "A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8285 }, "name": "eventCategories", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids" }, "remarks": "If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It can't end with a hyphen or contain two consecutive hyphens.\n\nConstraints:\n\n- If a `SourceIds` value is supplied, `SourceType` must also be provided.\n- If the source type is a DB instance, a `DBInstanceIdentifier` value must be supplied.\n- If the source type is a DB cluster, a `DBClusterIdentifier` value must be supplied.\n- If the source type is a DB parameter group, a `DBParameterGroupName` value must be supplied.\n- If the source type is a DB security group, a `DBSecurityGroupName` value must be supplied.\n- If the source type is a DB snapshot, a `DBSnapshotIdentifier` value must be supplied.\n- If the source type is a DB cluster snapshot, a `DBClusterSnapshotIdentifier` value must be supplied.", "stability": "external", "summary": "The list of identifiers of the event sources for which events are returned." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8302 }, "name": "sourceIds", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype" }, "remarks": "For example, if you want to be notified of events generated by a DB instance, set this parameter to `db-instance` . If this value isn't specified, all events are returned.\n\nValid values: `db-instance` | `db-cluster` | `db-parameter-group` | `db-security-group` | `db-snapshot` | `db-cluster-snapshot`", "stability": "external", "summary": "The type of source that is generating the events." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8311 }, "name": "sourceType", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-subscriptionname" }, "remarks": "Constraints: The name must be less than 255 characters.", "stability": "external", "summary": "The name of the subscription." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8320 }, "name": "subscriptionName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this subscription." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8327 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnEventSubscriptionProps" }, "@aws-cdk/aws-rds.CfnGlobalCluster": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::GlobalCluster", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::GlobalCluster` resource creates or updates an Amazon Aurora global database spread across multiple AWS Regions.\n\nThe global database contains a single primary cluster with read-write capability, and a read-only secondary cluster that receives data from the primary cluster through high-speed replication performed by the Aurora storage subsystem.\n\nYou can create a global database that is initially empty, and then add a primary cluster and a secondary cluster to it.\n\nFor information about Aurora global databases, see [Working with Amazon Aurora Global Databases](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database.html) in the *Amazon Aurora User Guide* .", "stability": "external", "summary": "A CloudFormation `AWS::RDS::GlobalCluster`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnGlobalCluster = new rds.CfnGlobalCluster(this, 'MyCfnGlobalCluster', /* all optional props */ {\n deletionProtection: false,\n engine: 'engine',\n engineVersion: 'engineVersion',\n globalClusterIdentifier: 'globalClusterIdentifier',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n storageEncrypted: false,\n});" }, "fqn": "@aws-cdk/aws-rds.CfnGlobalCluster", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::GlobalCluster`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8755 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnGlobalClusterProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8675 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8772 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8788 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnGlobalCluster", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8679 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8777 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-deletionprotection" }, "remarks": "The global database can't be deleted when deletion protection is enabled.", "stability": "external", "summary": "The deletion protection setting for the new global database." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8705 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engine" }, "remarks": "If this property isn't specified, the database engine is derived from the source DB cluster specified by the `SourceDBClusterIdentifier` property.\n\n> If the `SourceDBClusterIdentifier` property isn't specified, this property is required. If the `SourceDBClusterIdentifier` property is specified, make sure this property isn't specified.", "stability": "external", "summary": "The name of the database engine to be used for this DB cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8716 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engineversion" }, "stability": "external", "summary": "The engine version of the Aurora global database." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8723 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-globalclusteridentifier" }, "stability": "external", "summary": "The cluster identifier of the global database cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8730 }, "name": "globalClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-sourcedbclusteridentifier" }, "remarks": "> If the `Engine` property isn't specified, this property is required. If the `Engine` property is specified, make sure this property isn't specified.", "stability": "external", "summary": "The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8739 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-storageencrypted" }, "stability": "external", "summary": "The storage encryption setting for the global database cluster." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8746 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/rds.generated:CfnGlobalCluster" }, "@aws-cdk/aws-rds.CfnGlobalClusterProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnGlobalCluster`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnGlobalClusterProps: rds.CfnGlobalClusterProps = {\n deletionProtection: false,\n engine: 'engine',\n engineVersion: 'engineVersion',\n globalClusterIdentifier: 'globalClusterIdentifier',\n sourceDbClusterIdentifier: 'sourceDbClusterIdentifier',\n storageEncrypted: false,\n};" }, "fqn": "@aws-cdk/aws-rds.CfnGlobalClusterProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8548 }, "name": "CfnGlobalClusterProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-deletionprotection" }, "remarks": "The global database can't be deleted when deletion protection is enabled.", "stability": "external", "summary": "The deletion protection setting for the new global database." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8555 }, "name": "deletionProtection", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engine" }, "remarks": "If this property isn't specified, the database engine is derived from the source DB cluster specified by the `SourceDBClusterIdentifier` property.\n\n> If the `SourceDBClusterIdentifier` property isn't specified, this property is required. If the `SourceDBClusterIdentifier` property is specified, make sure this property isn't specified.", "stability": "external", "summary": "The name of the database engine to be used for this DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8566 }, "name": "engine", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-engineversion" }, "stability": "external", "summary": "The engine version of the Aurora global database." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8573 }, "name": "engineVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-globalclusteridentifier" }, "stability": "external", "summary": "The cluster identifier of the global database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8580 }, "name": "globalClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-sourcedbclusteridentifier" }, "remarks": "> If the `Engine` property isn't specified, this property is required. If the `Engine` property is specified, make sure this property isn't specified.", "stability": "external", "summary": "The DB cluster identifier or Amazon Resource Name (ARN) to use as the primary cluster of the global database." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8589 }, "name": "sourceDbClusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-globalcluster.html#cfn-rds-globalcluster-storageencrypted" }, "stability": "external", "summary": "The storage encryption setting for the global database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8596 }, "name": "storageEncrypted", "optional": true, "type": { "union": { "types": [ { "primitive": "boolean" }, { "fqn": "@aws-cdk/core.IResolvable" } ] } } } ], "symbolId": "lib/rds.generated:CfnGlobalClusterProps" }, "@aws-cdk/aws-rds.CfnOptionGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.CfnResource", "docs": { "custom": { "cloudformationResource": "AWS::RDS::OptionGroup", "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html", "exampleMetadata": "fixture=_generated" }, "remarks": "The `AWS::RDS::OptionGroup` resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.", "stability": "external", "summary": "A CloudFormation `AWS::RDS::OptionGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnOptionGroup = new rds.CfnOptionGroup(this, 'MyCfnOptionGroup', {\n engineName: 'engineName',\n majorEngineVersion: 'majorEngineVersion',\n optionGroupDescription: 'optionGroupDescription',\n\n // the properties below are optional\n optionConfigurations: [{\n optionName: 'optionName',\n\n // the properties below are optional\n dbSecurityGroupMemberships: ['dbSecurityGroupMemberships'],\n optionSettings: [{\n name: 'name',\n value: 'value',\n }],\n optionVersion: 'optionVersion',\n port: 123,\n vpcSecurityGroupMemberships: ['vpcSecurityGroupMemberships'],\n }],\n optionGroupName: 'optionGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n});" }, "fqn": "@aws-cdk/aws-rds.CfnOptionGroup", "initializer": { "docs": { "stability": "external", "summary": "Create a new `AWS::RDS::OptionGroup`." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9045 }, "parameters": [ { "docs": { "summary": "- scope in which this resource is defined." }, "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "docs": { "summary": "- scoped id of the resource." }, "name": "id", "type": { "primitive": "string" } }, { "docs": { "summary": "- resource properties." }, "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.CfnOptionGroupProps" } } ] }, "interfaces": [ "@aws-cdk/core.IInspectable" ], "kind": "class", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8945 }, "methods": [ { "docs": { "stability": "external", "summary": "Examines the CloudFormation resource and discloses attributes." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9065 }, "name": "inspect", "overrides": "@aws-cdk/core.IInspectable", "parameters": [ { "docs": { "summary": "- tree inspector to collect and process attributes." }, "name": "inspector", "type": { "fqn": "@aws-cdk/core.TreeInspector" } } ] }, { "docs": { "stability": "external" }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9081 }, "name": "renderProperties", "overrides": "@aws-cdk/core.CfnResource", "parameters": [ { "name": "props", "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } ], "protected": true, "returns": { "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } } } ], "name": "CfnOptionGroup", "properties": [ { "const": true, "docs": { "stability": "external", "summary": "The CloudFormation resource type name for this resource class." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8949 }, "name": "CFN_RESOURCE_TYPE_NAME", "static": true, "type": { "primitive": "string" } }, { "docs": { "stability": "external" }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9070 }, "name": "cfnProperties", "overrides": "@aws-cdk/core.CfnResource", "protected": true, "type": { "collection": { "elementtype": { "primitive": "any" }, "kind": "map" } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this option group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9036 }, "name": "tags", "type": { "fqn": "@aws-cdk/core.TagManager" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename" }, "remarks": "Valid Values:\n\n- `mariadb`\n- `mysql`\n- `oracle-ee`\n- `oracle-ee-cdb`\n- `oracle-se2`\n- `oracle-se2-cdb`\n- `postgres`\n- `sqlserver-ee`\n- `sqlserver-se`\n- `sqlserver-ex`\n- `sqlserver-web`", "stability": "external", "summary": "Specifies the name of the engine that this option group should be associated with." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8989 }, "name": "engineName", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion" }, "stability": "external", "summary": "Specifies the major version of the engine that this option group should be associated with." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8996 }, "name": "majorEngineVersion", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription" }, "stability": "external", "summary": "The description of the option group." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9003 }, "name": "optionGroupDescription", "type": { "primitive": "string" } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations" }, "stability": "external", "summary": "A list of options and the settings for each option." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9010 }, "name": "optionConfigurations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnOptionGroup.OptionConfigurationProperty" } ] } }, "kind": "array" } } ] } } }, { "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupname" }, "remarks": "Constraints:\n\n- Must be 1 to 255 letters, numbers, or hyphens\n- First character must be a letter\n- Can't end with a hyphen or contain two consecutive hyphens\n\nExample: `myoptiongroup`\n\nIf you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the option group to be created." }, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9029 }, "name": "optionGroupName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnOptionGroup" }, "@aws-cdk/aws-rds.CfnOptionGroup.OptionConfigurationProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `OptionConfiguration` property type specifies an individual option, and its settings, within an `AWS::RDS::OptionGroup` resource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst optionConfigurationProperty: rds.CfnOptionGroup.OptionConfigurationProperty = {\n optionName: 'optionName',\n\n // the properties below are optional\n dbSecurityGroupMemberships: ['dbSecurityGroupMemberships'],\n optionSettings: [{\n name: 'name',\n value: 'value',\n }],\n optionVersion: 'optionVersion',\n port: 123,\n vpcSecurityGroupMemberships: ['vpcSecurityGroupMemberships'],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnOptionGroup.OptionConfigurationProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9095 }, "name": "OptionConfigurationProperty", "namespace": "CfnOptionGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionname" }, "stability": "external", "summary": "The configuration of options to include in a group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9107 }, "name": "optionName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-dbsecuritygroupmemberships" }, "stability": "external", "summary": "A list of DBSecurityGroupMembership name strings used for this option." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9101 }, "name": "dbSecurityGroupMemberships", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionsettings" }, "stability": "external", "summary": "The option settings to include in an option group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9113 }, "name": "optionSettings", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnOptionGroup.OptionSettingProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-optionversion" }, "stability": "external", "summary": "The version for the option." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9119 }, "name": "optionVersion", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-port" }, "stability": "external", "summary": "The optional port for the option." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9125 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionconfiguration.html#cfn-rds-optiongroup-optionconfiguration-vpcsecuritygroupmemberships" }, "stability": "external", "summary": "A list of VpcSecurityGroupMembership name strings used for this option." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9131 }, "name": "vpcSecurityGroupMemberships", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnOptionGroup.OptionConfigurationProperty" }, "@aws-cdk/aws-rds.CfnOptionGroup.OptionSettingProperty": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "The `OptionSetting` property type specifies the value for an option within an `OptionSetting` property.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst optionSettingProperty: rds.CfnOptionGroup.OptionSettingProperty = {\n name: 'name',\n value: 'value',\n};" }, "fqn": "@aws-cdk/aws-rds.CfnOptionGroup.OptionSettingProperty", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9208 }, "name": "OptionSettingProperty", "namespace": "CfnOptionGroup", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-name" }, "stability": "external", "summary": "The name of the option that has settings that you can set." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9214 }, "name": "name", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-rds-optiongroup-optionsetting.html#cfn-rds-optiongroup-optionsetting-value" }, "stability": "external", "summary": "The current value of the option setting." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 9220 }, "name": "value", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/rds.generated:CfnOptionGroup.OptionSettingProperty" }, "@aws-cdk/aws-rds.CfnOptionGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html", "exampleMetadata": "fixture=_generated" }, "stability": "external", "summary": "Properties for defining a `CfnOptionGroup`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst cfnOptionGroupProps: rds.CfnOptionGroupProps = {\n engineName: 'engineName',\n majorEngineVersion: 'majorEngineVersion',\n optionGroupDescription: 'optionGroupDescription',\n\n // the properties below are optional\n optionConfigurations: [{\n optionName: 'optionName',\n\n // the properties below are optional\n dbSecurityGroupMemberships: ['dbSecurityGroupMemberships'],\n optionSettings: [{\n name: 'name',\n value: 'value',\n }],\n optionVersion: 'optionVersion',\n port: 123,\n vpcSecurityGroupMemberships: ['vpcSecurityGroupMemberships'],\n }],\n optionGroupName: 'optionGroupName',\n tags: [{\n key: 'key',\n value: 'value',\n }],\n};" }, "fqn": "@aws-cdk/aws-rds.CfnOptionGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8801 }, "name": "CfnOptionGroupProps", "properties": [ { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-enginename" }, "remarks": "Valid Values:\n\n- `mariadb`\n- `mysql`\n- `oracle-ee`\n- `oracle-ee-cdb`\n- `oracle-se2`\n- `oracle-se2-cdb`\n- `postgres`\n- `sqlserver-ee`\n- `sqlserver-se`\n- `sqlserver-ex`\n- `sqlserver-web`", "stability": "external", "summary": "Specifies the name of the engine that this option group should be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8822 }, "name": "engineName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-majorengineversion" }, "stability": "external", "summary": "Specifies the major version of the engine that this option group should be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8829 }, "name": "majorEngineVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupdescription" }, "stability": "external", "summary": "The description of the option group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8836 }, "name": "optionGroupDescription", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optionconfigurations" }, "stability": "external", "summary": "A list of options and the settings for each option." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8843 }, "name": "optionConfigurations", "optional": true, "type": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "collection": { "elementtype": { "union": { "types": [ { "fqn": "@aws-cdk/core.IResolvable" }, { "fqn": "@aws-cdk/aws-rds.CfnOptionGroup.OptionConfigurationProperty" } ] } }, "kind": "array" } } ] } } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-optiongroupname" }, "remarks": "Constraints:\n\n- Must be 1 to 255 letters, numbers, or hyphens\n- First character must be a letter\n- Can't end with a hyphen or contain two consecutive hyphens\n\nExample: `myoptiongroup`\n\nIf you don't specify a value for `OptionGroupName` property, a name is automatically created for the option group.\n\n> This value is stored as a lowercase string.", "stability": "external", "summary": "The name of the option group to be created." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8862 }, "name": "optionGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "link": "http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-optiongroup.html#cfn-rds-optiongroup-tags" }, "stability": "external", "summary": "An optional array of key-value pairs to apply to this option group." }, "immutable": true, "locationInModule": { "filename": "lib/rds.generated.ts", "line": 8869 }, "name": "tags", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/core.CfnTag" }, "kind": "array" } } } ], "symbolId": "lib/rds.generated:CfnOptionGroupProps" }, "@aws-cdk/aws-rds.ClusterEngineBindOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The extra options passed to the {@link IClusterEngine.bindToCluster} method.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameterGroup: rds.ParameterGroup;\ndeclare const role: iam.Role;\nconst clusterEngineBindOptions: rds.ClusterEngineBindOptions = {\n parameterGroup: parameterGroup,\n s3ExportRole: role,\n s3ImportRole: role,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ClusterEngineBindOptions", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 14 }, "name": "ClusterEngineBindOptions", "properties": [ { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The customer-provided ParameterGroup." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 34 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The role used for S3 exporting." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 27 }, "name": "s3ExportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The role used for S3 importing." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 20 }, "name": "s3ImportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } } ], "symbolId": "lib/cluster-engine:ClusterEngineBindOptions" }, "@aws-cdk/aws-rds.ClusterEngineConfig": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The type returned from the {@link IClusterEngine.bindToCluster} method.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const parameterGroup: rds.ParameterGroup;\nconst clusterEngineConfig: rds.ClusterEngineConfig = {\n features: {\n s3Export: 's3Export',\n s3Import: 's3Import',\n },\n parameterGroup: parameterGroup,\n port: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ClusterEngineConfig", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 40 }, "name": "ClusterEngineConfig", "properties": [ { "abstract": true, "docs": { "default": "- no features", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html", "stability": "stable", "summary": "Features supported by the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 63 }, "name": "features", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ClusterEngineFeatures" } }, { "abstract": true, "docs": { "default": "- no ParameterGroup will be used", "stability": "stable", "summary": "The ParameterGroup to use for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 46 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- use the default port for clusters (3306)", "stability": "stable", "summary": "The port to use for this cluster, unless the customer specified the port directly." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 54 }, "name": "port", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/cluster-engine:ClusterEngineConfig" }, "@aws-cdk/aws-rds.ClusterEngineFeatures": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Represents Database Engine features.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst clusterEngineFeatures: rds.ClusterEngineFeatures = {\n s3Export: 's3Export',\n s3Import: 's3Import',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ClusterEngineFeatures", "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 69 }, "name": "ClusterEngineFeatures", "properties": [ { "abstract": true, "docs": { "default": "- no s3Export feature name", "stability": "stable", "summary": "Feature name for the DB instance that the IAM role to export to S3 bucket is to be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 84 }, "name": "s3Export", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no s3Import feature name", "stability": "stable", "summary": "Feature name for the DB instance that the IAM role to access the S3 bucket for import is to be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 76 }, "name": "s3Import", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/cluster-engine:ClusterEngineFeatures" }, "@aws-cdk/aws-rds.CommonRotationUserOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties common to single-user and multi-user rotation options.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const interfaceVpcEndpoint: ec2.InterfaceVpcEndpoint;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\nconst commonRotationUserOptions: rds.CommonRotationUserOptions = {\n automaticallyAfter: cdk.Duration.minutes(30),\n endpoint: interfaceVpcEndpoint,\n excludeCharacters: 'excludeCharacters',\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.CommonRotationUserOptions", "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 461 }, "name": "CommonRotationUserOptions", "properties": [ { "abstract": true, "docs": { "default": "- 30 days", "stability": "stable", "summary": "Specifies the number of days after the previous rotation before Secrets Manager triggers the next automatic rotation." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 468 }, "name": "automaticallyAfter", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "https://secretsmanager..amazonaws.com", "remarks": "If you enable private DNS hostnames for your VPC private endpoint (the default), you don't\nneed to specify an endpoint. The standard Secrets Manager DNS hostname the Secrets Manager\nCLI and SDKs use by default (https://secretsmanager..amazonaws.com) automatically\nresolves to your VPC endpoint.", "stability": "stable", "summary": "The VPC interface endpoint to use for the Secrets Manager API." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 494 }, "name": "endpoint", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IInterfaceVpcEndpoint" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\"" }, "default": "\" %+~`#$&*()|[]{}:;<>?!'/", "stability": "stable", "summary": "Specifies characters to not include in generated passwords." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 475 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- same placement as instance or cluster", "stability": "stable", "summary": "Where to place the rotation Lambda function." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 482 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/props:CommonRotationUserOptions" }, "@aws-cdk/aws-rds.Credentials": { "abstract": true, "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Username and password combination.", "example": "// Create username and password secret for DB Cluster\nconst secret = new rds.DatabaseSecret(this, 'AuroraSecret', {\n username: 'clusteradmin',\n});\n\n// The VPC to place the cluster in\nconst vpc = new ec2.Vpc(this, 'AuroraVpc');\n\n// Create the serverless cluster, provide all values needed to customise the database.\nconst cluster = new rds.ServerlessCluster(this, 'AuroraCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc,\n credentials: { username: 'clusteradmin' },\n clusterIdentifier: 'db-endpoint-test',\n defaultDatabaseName: 'demos',\n});\n\n// Build a data source for AppSync to access the database.\ndeclare const api: appsync.GraphqlApi;\nconst rdsDS = api.addRdsDataSource('rds', cluster, secret, 'demos');\n\n// Set up a resolver for an RDS query.\nrdsDS.createResolver({\n typeName: 'Query',\n fieldName: 'getDemosRds',\n requestMappingTemplate: appsync.MappingTemplate.fromString(`\n {\n \"version\": \"2018-05-29\",\n \"statements\": [\n \"SELECT * FROM demos\"\n ]\n }\n `),\n responseMappingTemplate: appsync.MappingTemplate.fromString(`\n $utils.toJson($utils.rds.toJsonObject($ctx.result)[0])\n `),\n});\n\n// Set up a resolver for an RDS mutation.\nrdsDS.createResolver({\n typeName: 'Mutation',\n fieldName: 'addDemoRds',\n requestMappingTemplate: appsync.MappingTemplate.fromString(`\n {\n \"version\": \"2018-05-29\",\n \"statements\": [\n \"INSERT INTO demos VALUES (:id, :version)\",\n \"SELECT * WHERE id = :id\"\n ],\n \"variableMap\": {\n \":id\": $util.toJson($util.autoId()),\n \":version\": $util.toJson($ctx.args.version)\n }\n }\n `),\n responseMappingTemplate: appsync.MappingTemplate.fromString(`\n $utils.toJson($utils.rds.toJsonObject($ctx.result)[1][0])\n `),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.Credentials", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/props.ts", "line": 186 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates Credentials with a password generated and stored in Secrets Manager." }, "locationInModule": { "filename": "lib/props.ts", "line": 190 }, "name": "fromGeneratedSecret", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.CredentialsBaseOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, "static": true }, { "docs": { "remarks": "Do not put passwords in your CDK code directly.", "stability": "stable", "summary": "Creates Credentials from a password." }, "locationInModule": { "filename": "lib/props.ts", "line": 203 }, "name": "fromPassword", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "password", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, "static": true }, { "docs": { "remarks": "The Secret must be a JSON string with a ``username`` and ``password`` field:\n```\n{\n ...\n \"username\": ,\n \"password\": ,\n}\n```", "stability": "stable", "summary": "Creates Credentials from an existing Secrets Manager ``Secret`` (or ``DatabaseSecret``)." }, "locationInModule": { "filename": "lib/props.ts", "line": 240 }, "name": "fromSecret", "parameters": [ { "docs": { "summary": "The secret where the credentials are stored." }, "name": "secret", "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "remarks": "If specified the username\nwill be referenced as a string and not a dynamic reference to the username\nfield in the secret. This allows to replace the secret without replacing the\ninstance or cluster.", "summary": "The username defined in the secret." }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, "static": true }, { "docs": { "remarks": "If no password is provided, one will be generated and stored in Secrets Manager.", "stability": "stable", "summary": "Creates Credentials for the given username, and optional password and key." }, "locationInModule": { "filename": "lib/props.ts", "line": 215 }, "name": "fromUsername", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.CredentialsFromUsernameOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, "static": true } ], "name": "Credentials", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Username." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 252 }, "name": "username", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "KMS encryption key to encrypt the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 284 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\")" }, "default": "- the DatabaseSecret default exclude character set (\" %+~`#$&*()|[]{}:;<>?!'/", "remarks": "Only used if {@link password} has not been set.", "stability": "stable", "summary": "The characters to exclude from the generated password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 299 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- a Secrets Manager generated password", "remarks": "Do not put passwords in your CDK code directly.", "stability": "stable", "summary": "Password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 277 }, "name": "password", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "default": "- Secret is not replicated", "stability": "stable", "summary": "A list of regions where to replicate the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 306 }, "name": "replicaRegions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ReplicaRegion" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "Secret used to instantiate this Login." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 291 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "abstract": true, "docs": { "default": "- A name is generated by CloudFormation.", "stability": "stable", "summary": "The name to use for the Secret if a new Secret is to be generated in SecretsManager for these Credentials." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 260 }, "name": "secretName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether the username should be referenced as a string and not as a dynamic reference to the username in the secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 268 }, "name": "usernameAsString", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/props:Credentials" }, "@aws-cdk/aws-rds.CredentialsBaseOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Base options for creating Credentials.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstance(this, 'InstanceWithCustomizedSecret', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres', {\n secretName: 'my-cool-name',\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.CredentialsBaseOptions", "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 138 }, "name": "CredentialsBaseOptions", "properties": [ { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "KMS encryption key to encrypt the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 151 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\")" }, "default": "- the DatabaseSecret default exclude character set (\" %+~`#$&*()|[]{}:;<>?!'/", "remarks": "Has no effect if {@link password} has been provided.", "stability": "stable", "summary": "The characters to exclude from the generated password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 159 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Secret is not replicated", "stability": "stable", "summary": "A list of regions where to replicate this secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 166 }, "name": "replicaRegions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ReplicaRegion" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- A name is generated by CloudFormation.", "stability": "stable", "summary": "The name of the secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 144 }, "name": "secretName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/props:CredentialsBaseOptions" }, "@aws-cdk/aws-rds.CredentialsFromUsernameOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options for creating Credentials from a username.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const key: kms.Key;\ndeclare const secretValue: cdk.SecretValue;\nconst credentialsFromUsernameOptions: rds.CredentialsFromUsernameOptions = {\n encryptionKey: key,\n excludeCharacters: 'excludeCharacters',\n password: secretValue,\n replicaRegions: [{\n region: 'region',\n\n // the properties below are optional\n encryptionKey: key,\n }],\n secretName: 'secretName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.CredentialsFromUsernameOptions", "interfaces": [ "@aws-cdk/aws-rds.CredentialsBaseOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 172 }, "name": "CredentialsFromUsernameOptions", "properties": [ { "abstract": true, "docs": { "default": "- a Secrets Manager generated password", "remarks": "Do not put passwords in your CDK code directly.", "stability": "stable", "summary": "Password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 180 }, "name": "password", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "symbolId": "lib/props:CredentialsFromUsernameOptions" }, "@aws-cdk/aws-rds.DatabaseCluster": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-rds.DatabaseClusterBase", "docs": { "custom": { "resource": "AWS::RDS::DBCluster", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Create a clustered database with a given number of instances.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'." }, "fqn": "@aws-cdk/aws-rds.DatabaseCluster", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/cluster.ts", "line": 613 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseClusterProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/cluster.ts", "line": 593 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing DatabaseCluster from properties." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 597 }, "name": "fromDatabaseClusterAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseClusterAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseCluster" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds the multi user rotation to this cluster." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 498 }, "name": "addRotationMultiUser", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Adds the single user rotation of the master password to this cluster." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 475 }, "name": "addRotationSingleUser", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } } ], "name": "DatabaseCluster", "properties": [ { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 602 }, "name": "clusterEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 601 }, "name": "clusterIdentifier", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Endpoint to use for load-balanced read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 603 }, "name": "clusterReadEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Access to the network connections." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 604 }, "name": "connections", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "Endpoints which address each individual replica." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 606 }, "name": "instanceEndpoints", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.Endpoint" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Identifiers of the replicas." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 605 }, "name": "instanceIdentifiers", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Application for multi user rotation to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 372 }, "name": "multiUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 345 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 346 }, "name": "securityGroups", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Application for single user rotation of the master password to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 367 }, "name": "singleUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 347 }, "name": "subnetGroup", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, { "docs": { "stability": "stable", "summary": "The VPC network to place the cluster in." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 357 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "docs": { "remarks": "Never undefined.", "stability": "stable", "summary": "The engine for this Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 343 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "docs": { "stability": "stable", "summary": "The secret attached to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 611 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable", "summary": "The cluster's subnets." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 362 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/cluster:DatabaseCluster" }, "@aws-cdk/aws-rds.DatabaseClusterAttributes": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties that describe an existing cluster instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const clusterEngine: rds.IClusterEngine;\ndeclare const securityGroup: ec2.SecurityGroup;\nconst databaseClusterAttributes: rds.DatabaseClusterAttributes = {\n clusterIdentifier: 'clusterIdentifier',\n\n // the properties below are optional\n clusterEndpointAddress: 'clusterEndpointAddress',\n engine: clusterEngine,\n instanceEndpointAddresses: ['instanceEndpointAddresses'],\n instanceIdentifiers: ['instanceIdentifiers'],\n port: 123,\n readerEndpointAddress: 'readerEndpointAddress',\n securityGroups: [securityGroup],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterAttributes", "kind": "interface", "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 54 }, "name": "DatabaseClusterAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 58 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no endpoint address", "stability": "stable", "summary": "Cluster endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 87 }, "name": "clusterEndpointAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- the imported Cluster's engine is unknown", "stability": "stable", "summary": "The engine of the existing Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 108 }, "name": "engine", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "abstract": true, "docs": { "default": "- no instance endpoints", "stability": "stable", "summary": "Endpoint addresses of individual instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 101 }, "name": "instanceEndpointAddresses", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no instance identifiers", "stability": "stable", "summary": "Identifier for the instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 79 }, "name": "instanceIdentifiers", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The database port." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 65 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no reader address", "stability": "stable", "summary": "Reader endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 94 }, "name": "readerEndpointAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no security groups", "stability": "stable", "summary": "The security groups of the database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 72 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } } ], "symbolId": "lib/cluster-ref:DatabaseClusterAttributes" }, "@aws-cdk/aws-rds.DatabaseClusterBase": { "abstract": true, "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A new or imported clustered database." }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 150 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/core.ResourceProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IDatabaseCluster" ], "kind": "class", "locationInModule": { "filename": "lib/cluster.ts", "line": 280 }, "methods": [ { "docs": { "stability": "stable", "summary": "Add a new db proxy to this cluster." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 317 }, "name": "addProxy", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxy" } } }, { "docs": { "stability": "stable", "summary": "Renders the secret attachment target specifications." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 327 }, "name": "asSecretAttachmentTarget", "overrides": "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretAttachmentTargetProps" } } }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this DBCluster." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 103 }, "name": "metric", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The percentage of CPU utilization." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 109 }, "name": "metricCPUUtilization", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of database connections in use." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 115 }, "name": "metricDatabaseConnections", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of deadlocks in the database per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 121 }, "name": "metricDeadlocks", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of time that the instance has been running, in seconds." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 127 }, "name": "metricEngineUptime", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available random access memory, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 133 }, "name": "metricFreeableMemory", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of local storage available, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 139 }, "name": "metricFreeLocalStorage", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput received from clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 145 }, "name": "metricNetworkReceiveThroughput", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 151 }, "name": "metricNetworkThroughput", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput sent to clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 157 }, "name": "metricNetworkTransmitThroughput", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 163 }, "name": "metricSnapshotStorageUsed", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The total amount of backup storage in bytes for which you are billed." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 169 }, "name": "metricTotalBackupStorageBilled", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of storage used by your Aurora DB instance, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 175 }, "name": "metricVolumeBytesUsed", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 181 }, "name": "metricVolumeReadIOPs", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 187 }, "name": "metricVolumeWriteIOPs", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "DatabaseClusterBase", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 297 }, "name": "clusterEndpoint", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 287 }, "name": "clusterIdentifier", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Endpoint to use for load-balanced read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 302 }, "name": "clusterReadEndpoint", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Access to the network connections." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 312 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Endpoints which address each individual replica." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 307 }, "name": "instanceEndpoints", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.Endpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Identifiers of the replicas." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 292 }, "name": "instanceIdentifiers", "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "May be not known for imported Clusters if it wasn't provided explicitly.", "stability": "stable", "summary": "The engine of this Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 282 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.IDatabaseCluster", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } } ], "symbolId": "lib/cluster:DatabaseClusterBase" }, "@aws-cdk/aws-rds.DatabaseClusterEngine": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Provides mapping to the serverless application\nused for secret rotation.", "stability": "stable", "summary": "A database cluster engine.", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),\n vpc,\n scaling: {\n autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time\n minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)\n maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterEngine", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 651 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates a new plain Aurora database cluster engine." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 680 }, "name": "aurora", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.AuroraClusterEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new Aurora MySQL database cluster engine." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 685 }, "name": "auroraMysql", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.AuroraMysqlClusterEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new Aurora PostgreSQL database cluster engine." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 690 }, "name": "auroraPostgres", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.AuroraPostgresClusterEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, "static": true } ], "name": "DatabaseClusterEngine", "properties": [ { "const": true, "docs": { "remarks": "**Note**: we do not recommend using unversioned engines for non-serverless Clusters,\n as that can pose an availability risk.\n We recommend using versioned engines created using the {@link aurora()} method", "stability": "stable", "summary": "The unversioned 'aurora' cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 659 }, "name": "AURORA", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "const": true, "docs": { "remarks": "**Note**: we do not recommend using unversioned engines for non-serverless Clusters,\n as that can pose an availability risk.\n We recommend using versioned engines created using the {@link auroraMysql()} method", "stability": "stable", "summary": "The unversioned 'aurora-msql' cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 668 }, "name": "AURORA_MYSQL", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "const": true, "docs": { "remarks": "**Note**: we do not recommend using unversioned engines for non-serverless Clusters,\n as that can pose an availability risk.\n We recommend using versioned engines created using the {@link auroraPostgres()} method", "stability": "stable", "summary": "The unversioned 'aurora-postgresql' cluster engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 677 }, "name": "AURORA_POSTGRESQL", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } } ], "symbolId": "lib/cluster-engine:DatabaseClusterEngine" }, "@aws-cdk/aws-rds.DatabaseClusterFromSnapshot": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-rds.DatabaseClusterBase", "docs": { "custom": { "resource": "AWS::RDS::DBInstance", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A database cluster restored from a snapshot.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseClusterFromSnapshot(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),\n instanceProps: {\n vpc,\n },\n snapshotIdentifier: 'mySnapshot',\n});" }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterFromSnapshot", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/cluster.ts", "line": 687 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseClusterFromSnapshotProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/cluster.ts", "line": 674 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds the multi user rotation to this cluster." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 498 }, "name": "addRotationMultiUser", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Adds the single user rotation of the master password to this cluster." }, "locationInModule": { "filename": "lib/cluster.ts", "line": 475 }, "name": "addRotationSingleUser", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } } ], "name": "DatabaseClusterFromSnapshot", "properties": [ { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 676 }, "name": "clusterEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 675 }, "name": "clusterIdentifier", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "Endpoint to use for load-balanced read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 677 }, "name": "clusterReadEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Access to the network connections." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 678 }, "name": "connections", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "Endpoints which address each individual replica." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 680 }, "name": "instanceEndpoints", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.Endpoint" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Identifiers of the replicas." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 679 }, "name": "instanceIdentifiers", "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Application for multi user rotation to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 372 }, "name": "multiUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 345 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 346 }, "name": "securityGroups", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "Application for single user rotation of the master password to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 367 }, "name": "singleUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 347 }, "name": "subnetGroup", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, { "docs": { "stability": "stable", "summary": "The VPC network to place the cluster in." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 357 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "docs": { "remarks": "Never undefined.", "stability": "stable", "summary": "The engine for this Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 343 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseClusterBase", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "docs": { "stability": "stable", "summary": "The secret attached to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 685 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable", "summary": "The cluster's subnets." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 362 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/cluster:DatabaseClusterFromSnapshot" }, "@aws-cdk/aws-rds.DatabaseClusterFromSnapshotProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for ``DatabaseClusterFromSnapshot``.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseClusterFromSnapshot(this, 'Database', {\n engine: rds.DatabaseClusterEngine.aurora({ version: rds.AuroraEngineVersion.VER_1_22_2 }),\n instanceProps: {\n vpc,\n },\n snapshotIdentifier: 'mySnapshot',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterFromSnapshotProps", "kind": "interface", "locationInModule": { "filename": "lib/cluster.ts", "line": 653 }, "name": "DatabaseClusterFromSnapshotProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "What kind of database to start." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 27 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Settings for the individual instances that are launched." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 41 }, "name": "instanceProps", "type": { "fqn": "@aws-cdk/aws-rds.InstanceProps" } }, { "abstract": true, "docs": { "remarks": "You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot.\nHowever, you can use only the ARN to specify a DB instance snapshot.", "stability": "stable", "summary": "The identifier for the DB instance snapshot or DB cluster snapshot to restore from." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 659 }, "name": "snapshotIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "0 seconds (no backtrack)", "remarks": "This feature is only supported by the Aurora MySQL database engine and\ncannot be enabled on existing clusters.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html", "stability": "stable", "summary": "The number of seconds to set a cluster's target backtrack window to." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 51 }, "name": "backtrackWindow", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- Backup retention period for automated backups is 1 day.\nBackup preferred window is set to a 30-minute window selected at random from an\n8-hour block of time for each AWS Region, occurring on a random day of the week.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow", "stability": "stable", "summary": "Backup settings." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 61 }, "name": "backup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.BackupProps" } }, { "abstract": true, "docs": { "default": "- no log exports", "stability": "stable", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 143 }, "name": "cloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- logs never expire", "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `Infinity`.", "stability": "stable", "summary": "The number of days log events are kept in CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 152 }, "name": "cloudwatchLogsRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } }, { "abstract": true, "docs": { "default": "- a new role is created.", "stability": "stable", "summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 160 }, "name": "cloudwatchLogsRetentionRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- A name is automatically generated.", "stability": "stable", "summary": "An optional identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 75 }, "name": "clusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "stability": "stable", "summary": "Whether to copy tags to the snapshot when a snapshot is created." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 274 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password", "stability": "stable", "summary": "Credentials for the administrative user." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 666 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, { "abstract": true, "docs": { "default": "- Database is not created in cluster.", "stability": "stable", "summary": "Name of a database which is automatically created inside the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 92 }, "name": "defaultDatabaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if ``removalPolicy`` is RETAIN, false otherwise", "stability": "stable", "summary": "Indicates whether the DB cluster should have deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 99 }, "name": "deletionProtection", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 252 }, "name": "iamAuthentication", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- clusterIdentifier is used with the word \"Instance\" appended.\nIf clusterIdentifier is not provided, the identifier is automatically generated.", "remarks": "Every replica is named by appending the replica number to this string, 1-based.", "stability": "stable", "summary": "Base identifier for instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 85 }, "name": "instanceIdentifierBase", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "2", "remarks": "Has to be at least 1.", "stability": "stable", "summary": "How many replicas/instances to create." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 36 }, "name": "instances", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "no enhanced monitoring", "stability": "stable", "summary": "The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 168 }, "name": "monitoringInterval", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A role is automatically created for you", "stability": "stable", "summary": "Role that will be used to manage DB instances monitoring." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 175 }, "name": "monitoringRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- No parameter group.", "stability": "stable", "summary": "Additional parameters to pass to the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 117 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "You can only specify parameterGroup or parameters but not both.\nYou need to use a versioned engine to auto-generate a DBClusterParameterGroup.", "stability": "stable", "summary": "The parameters in the DBClusterParameterGroup to create automatically." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 127 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- The default for the engine is used.", "stability": "stable", "summary": "What port to listen on." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 68 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- 30-minute window selected at random from an 8-hour block of time for\neach AWS Region, occurring on a random day of the week.", "remarks": "Example: 'Sun:23:45-Mon:00:15'", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance", "stability": "stable", "summary": "A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC)." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 110 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)", "stability": "stable", "summary": "The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 135 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This property must not be used if `s3ExportRole` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html", "stability": "stable", "summary": "S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 237 }, "name": "s3ExportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ExportBuckets` is set, no role is defined otherwise", "remarks": "This feature is only supported by the Aurora database engine.\n\nThis property must not be used if `s3ExportBuckets` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html", "stability": "stable", "summary": "Role that will be associated with this DB cluster to enable S3 export." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 222 }, "name": "s3ExportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This property must not be used if `s3ImportRole` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html", "stability": "stable", "summary": "S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 206 }, "name": "s3ImportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ImportBuckets` is set, no role is defined otherwise", "remarks": "This feature is only supported by the Aurora database engine.\n\nThis property must not be used if `s3ImportBuckets` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html", "stability": "stable", "summary": "Role that will be associated with this DB cluster to enable S3 import." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 191 }, "name": "s3ImportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- true if storageEncryptionKey is provided, false otherwise", "stability": "stable", "summary": "Whether to enable storage encryption." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 259 }, "name": "storageEncrypted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- if storageEncrypted is true then the default master key, no key otherwise", "remarks": "If specified, {@link storageEncrypted} will be set to `true`.", "stability": "stable", "summary": "The KMS key for storage encryption." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 267 }, "name": "storageEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "- a new subnet group will be created.", "stability": "stable", "summary": "Existing subnet group for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 244 }, "name": "subnetGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } } ], "symbolId": "lib/cluster:DatabaseClusterFromSnapshotProps" }, "@aws-cdk/aws-rds.DatabaseClusterProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new database cluster.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseClusterProps", "kind": "interface", "locationInModule": { "filename": "lib/cluster.ts", "line": 579 }, "name": "DatabaseClusterProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "What kind of database to start." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 27 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Settings for the individual instances that are launched." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 41 }, "name": "instanceProps", "type": { "fqn": "@aws-cdk/aws-rds.InstanceProps" } }, { "abstract": true, "docs": { "default": "0 seconds (no backtrack)", "remarks": "This feature is only supported by the Aurora MySQL database engine and\ncannot be enabled on existing clusters.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Managing.Backtrack.html", "stability": "stable", "summary": "The number of seconds to set a cluster's target backtrack window to." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 51 }, "name": "backtrackWindow", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- Backup retention period for automated backups is 1 day.\nBackup preferred window is set to a 30-minute window selected at random from an\n8-hour block of time for each AWS Region, occurring on a random day of the week.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow", "stability": "stable", "summary": "Backup settings." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 61 }, "name": "backup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.BackupProps" } }, { "abstract": true, "docs": { "default": "- no log exports", "stability": "stable", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 143 }, "name": "cloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- logs never expire", "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `Infinity`.", "stability": "stable", "summary": "The number of days log events are kept in CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 152 }, "name": "cloudwatchLogsRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } }, { "abstract": true, "docs": { "default": "- a new role is created.", "stability": "stable", "summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 160 }, "name": "cloudwatchLogsRetentionRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- A name is automatically generated.", "stability": "stable", "summary": "An optional identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 75 }, "name": "clusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true", "stability": "stable", "summary": "Whether to copy tags to the snapshot when a snapshot is created." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 274 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password", "stability": "stable", "summary": "Credentials for the administrative user." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 585 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, { "abstract": true, "docs": { "default": "- Database is not created in cluster.", "stability": "stable", "summary": "Name of a database which is automatically created inside the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 92 }, "name": "defaultDatabaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if ``removalPolicy`` is RETAIN, false otherwise", "stability": "stable", "summary": "Indicates whether the DB cluster should have deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 99 }, "name": "deletionProtection", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 252 }, "name": "iamAuthentication", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- clusterIdentifier is used with the word \"Instance\" appended.\nIf clusterIdentifier is not provided, the identifier is automatically generated.", "remarks": "Every replica is named by appending the replica number to this string, 1-based.", "stability": "stable", "summary": "Base identifier for instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 85 }, "name": "instanceIdentifierBase", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "2", "remarks": "Has to be at least 1.", "stability": "stable", "summary": "How many replicas/instances to create." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 36 }, "name": "instances", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "no enhanced monitoring", "stability": "stable", "summary": "The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instances." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 168 }, "name": "monitoringInterval", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A role is automatically created for you", "stability": "stable", "summary": "Role that will be used to manage DB instances monitoring." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 175 }, "name": "monitoringRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- No parameter group.", "stability": "stable", "summary": "Additional parameters to pass to the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 117 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "You can only specify parameterGroup or parameters but not both.\nYou need to use a versioned engine to auto-generate a DBClusterParameterGroup.", "stability": "stable", "summary": "The parameters in the DBClusterParameterGroup to create automatically." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 127 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- The default for the engine is used.", "stability": "stable", "summary": "What port to listen on." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 68 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- 30-minute window selected at random from an 8-hour block of time for\neach AWS Region, occurring on a random day of the week.", "remarks": "Example: 'Sun:23:45-Mon:00:15'", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance", "stability": "stable", "summary": "A preferred maintenance window day/time range. Should be specified as a range ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC)." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 110 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)", "stability": "stable", "summary": "The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 135 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This property must not be used if `s3ExportRole` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html", "stability": "stable", "summary": "S3 buckets that you want to load data into. This feature is only supported by the Aurora database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 237 }, "name": "s3ExportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ExportBuckets` is set, no role is defined otherwise", "remarks": "This feature is only supported by the Aurora database engine.\n\nThis property must not be used if `s3ExportBuckets` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/postgresql-s3-export.html", "stability": "stable", "summary": "Role that will be associated with this DB cluster to enable S3 export." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 222 }, "name": "s3ExportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This property must not be used if `s3ImportRole` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html", "stability": "stable", "summary": "S3 buckets that you want to load data from. This feature is only supported by the Aurora database engine." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 206 }, "name": "s3ImportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ImportBuckets` is set, no role is defined otherwise", "remarks": "This feature is only supported by the Aurora database engine.\n\nThis property must not be used if `s3ImportBuckets` is used.\n\nFor MySQL:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraPostgreSQL.Migrating.html", "stability": "stable", "summary": "Role that will be associated with this DB cluster to enable S3 import." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 191 }, "name": "s3ImportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- true if storageEncryptionKey is provided, false otherwise", "stability": "stable", "summary": "Whether to enable storage encryption." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 259 }, "name": "storageEncrypted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- if storageEncrypted is true then the default master key, no key otherwise", "remarks": "If specified, {@link storageEncrypted} will be set to `true`.", "stability": "stable", "summary": "The KMS key for storage encryption." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 267 }, "name": "storageEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "- a new subnet group will be created.", "stability": "stable", "summary": "Existing subnet group for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster.ts", "line": 244 }, "name": "subnetGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } } ], "symbolId": "lib/cluster:DatabaseClusterProps" }, "@aws-cdk/aws-rds.DatabaseInstance": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-rds.DatabaseInstanceBase", "docs": { "custom": { "resource": "AWS::RDS::DBInstance", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A database instance.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nnew rds.DatabaseInstance(this, 'InstanceWithUsername', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres'), // Creates an admin user of postgres with a generated password\n});\n\nnew rds.DatabaseInstance(this, 'InstanceWithUsernameAndPassword', {\n engine,\n vpc,\n credentials: rds.Credentials.fromPassword('postgres', SecretValue.ssmSecure('/dbPassword', '1')), // Use password from SSM\n});\n\nconst mySecret = secretsmanager.Secret.fromSecretName(this, 'DBSecret', 'myDBLoginInfo');\nnew rds.DatabaseInstance(this, 'InstanceWithSecretLogin', {\n engine,\n vpc,\n credentials: rds.Credentials.fromSecret(mySecret), // Get both username and password from existing secret\n});" }, "fqn": "@aws-cdk/aws-rds.DatabaseInstance", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 1010 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseInstanceProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IDatabaseInstance" ], "kind": "class", "locationInModule": { "filename": "lib/instance.ts", "line": 1003 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds the multi user rotation to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 948 }, "name": "addRotationMultiUser", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Adds the single user rotation of the master password to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 925 }, "name": "addRotationSingleUser", "parameters": [ { "docs": { "summary": "the options for the rotation, if you want to override the defaults." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 765 }, "name": "setLogRetention", "protected": true } ], "name": "DatabaseInstance", "properties": [ { "docs": { "stability": "stable", "summary": "Access to network connections." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 631 }, "name": "connections", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1005 }, "name": "dbInstanceEndpointAddress", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1006 }, "name": "dbInstanceEndpointPort", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1007 }, "name": "instanceEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1004 }, "name": "instanceIdentifier", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 851 }, "name": "instanceType", "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 636 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 850 }, "name": "sourceCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } }, { "docs": { "stability": "stable", "summary": "The VPC where this database instance is deployed." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 629 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "docs": { "remarks": "May be not known for imported Instances if it wasn't provided explicitly,\nor for read replicas.", "stability": "stable", "summary": "The engine of this database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 844 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "docs": { "stability": "stable", "summary": "The AWS Secrets Manager secret attached to the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1008 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 635 }, "name": "vpcPlacement", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 645 }, "name": "enableIamAuthentication", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance:DatabaseInstance" }, "@aws-cdk/aws-rds.DatabaseInstanceAttributes": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties that describe an existing instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const instanceEngine: rds.IInstanceEngine;\ndeclare const securityGroup: ec2.SecurityGroup;\nconst databaseInstanceAttributes: rds.DatabaseInstanceAttributes = {\n instanceEndpointAddress: 'instanceEndpointAddress',\n instanceIdentifier: 'instanceIdentifier',\n port: 123,\n securityGroups: [securityGroup],\n\n // the properties below are optional\n engine: instanceEngine,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceAttributes", "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 84 }, "name": "DatabaseInstanceAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 93 }, "name": "instanceEndpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 88 }, "name": "instanceIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The database port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 98 }, "name": "port", "type": { "primitive": "number" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The security groups of the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 103 }, "name": "securityGroups", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the imported Instance's engine is unknown", "stability": "stable", "summary": "The engine of the existing database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 110 }, "name": "engine", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } } ], "symbolId": "lib/instance:DatabaseInstanceAttributes" }, "@aws-cdk/aws-rds.DatabaseInstanceBase": { "abstract": true, "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "A new or imported database instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const instanceEngine: rds.IInstanceEngine;\ndeclare const securityGroup: ec2.SecurityGroup;\nconst databaseInstanceBase = rds.DatabaseInstanceBase.fromDatabaseInstanceAttributes(this, 'MyDatabaseInstanceBase', {\n instanceEndpointAddress: 'instanceEndpointAddress',\n instanceIdentifier: 'instanceIdentifier',\n port: 123,\n securityGroups: [securityGroup],\n\n // the properties below are optional\n engine: instanceEngine,\n});", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceBase", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/resource.ts", "line": 150 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/core.ResourceProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IDatabaseInstance" ], "kind": "class", "locationInModule": { "filename": "lib/instance.ts", "line": 116 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing database instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 120 }, "name": "fromDatabaseInstanceAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseInstanceAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseInstance" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Add a new db proxy to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 154 }, "name": "addProxy", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxy" } } }, { "docs": { "stability": "stable", "summary": "Renders the secret attachment target specifications." }, "locationInModule": { "filename": "lib/instance.ts", "line": 210 }, "name": "asSecretAttachmentTarget", "overrides": "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretAttachmentTargetProps" } } }, { "docs": { "remarks": "**Note**: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.", "stability": "stable", "summary": "Grant the given identity connection access to the database." }, "locationInModule": { "filename": "lib/instance.ts", "line": 161 }, "name": "grantConnect", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "docs": { "stability": "stable", "summary": "Return the given named metric for this DBInstance." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 288 }, "name": "metric", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The percentage of CPU utilization." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 294 }, "name": "metricCPUUtilization", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of database connections in use." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 300 }, "name": "metricDatabaseConnections", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available random access memory." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 312 }, "name": "metricFreeableMemory", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available storage space." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 306 }, "name": "metricFreeStorageSpace", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of disk write I/O operations per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 324 }, "name": "metricReadIOPS", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of disk read I/O operations per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 318 }, "name": "metricWriteIOPS", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "docs": { "remarks": "Use\n`rule.addEventPattern(pattern)` to specify a filter.", "stability": "stable", "summary": "Defines a CloudWatch event rule which triggers for instance events." }, "locationInModule": { "filename": "lib/instance.ts", "line": 178 }, "name": "onEvent", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.OnEventOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Rule" } } } ], "name": "DatabaseInstanceBase", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Access to network connections." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 149 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 139 }, "name": "dbInstanceEndpointAddress", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance endpoint port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 140 }, "name": "dbInstanceEndpointPort", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance arn." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 191 }, "name": "instanceArn", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 141 }, "name": "instanceEndpoint", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 138 }, "name": "instanceIdentifier", "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "May be not known for imported Instances if it wasn't provided explicitly,\nor for read replicas.", "stability": "stable", "summary": "The engine of this database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 143 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.IDatabaseInstance", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "abstract": true, "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 144 }, "name": "enableIamAuthentication", "optional": true, "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance:DatabaseInstanceBase" }, "@aws-cdk/aws-rds.DatabaseInstanceEngine": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Provides mapping to DatabaseEngine used for\nsecret rotation.", "stability": "stable", "summary": "A database instance engine.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceEngine", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1620 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates a new MariaDB instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1708 }, "name": "mariaDb", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.MariaDbInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new MySQL instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1713 }, "name": "mysql", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.MySqlInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new Oracle Enterprise Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1744 }, "name": "oracleEe", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.OracleEeInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "stability": "deprecated", "summary": "Creates a new Oracle Standard Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1726 }, "name": "oracleSe", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.OracleSeInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "stability": "deprecated", "summary": "Creates a new Oracle Standard Edition 1 instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1734 }, "name": "oracleSe1", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.OracleSe1InstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new Oracle Standard Edition 1 instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1739 }, "name": "oracleSe2", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.OracleSe2InstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new PostgreSQL instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1718 }, "name": "postgres", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.PostgresInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new SQL Server Enterprise Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1764 }, "name": "sqlServerEe", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEeInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new SQL Server Express Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1754 }, "name": "sqlServerEx", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerExInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new SQL Server Standard Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1749 }, "name": "sqlServerSe", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerSeInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Creates a new SQL Server Web Edition instance engine." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1759 }, "name": "sqlServerWeb", "parameters": [ { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerWebInstanceEngineProps" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, "static": true } ], "name": "DatabaseInstanceEngine", "properties": [ { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link mariaDb()} method", "stability": "stable", "summary": "The unversioned 'mariadb' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1627 }, "name": "MARIADB", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link mysql()} method", "stability": "stable", "summary": "The unversioned 'mysql' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1635 }, "name": "MYSQL", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link oracleEe()} method", "stability": "stable", "summary": "The unversioned 'oracle-ee' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1643 }, "name": "ORACLE_EE", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "stability": "deprecated", "summary": "The unversioned 'oracle-se' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1665 }, "name": "ORACLE_SE", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "stability": "deprecated", "summary": "The unversioned 'oracle-se1' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1658 }, "name": "ORACLE_SE1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link oracleSe2()} method", "stability": "stable", "summary": "The unversioned 'oracle-se2' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1651 }, "name": "ORACLE_SE2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link postgres()} method", "stability": "stable", "summary": "The unversioned 'postgres' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1673 }, "name": "POSTGRES", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link sqlServerEe()} method", "stability": "stable", "summary": "The unversioned 'sqlserver-ee' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1681 }, "name": "SQL_SERVER_EE", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link sqlServerEx()} method", "stability": "stable", "summary": "The unversioned 'sqlserver-ex' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1697 }, "name": "SQL_SERVER_EX", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link sqlServerSe()} method", "stability": "stable", "summary": "The unversioned 'sqlserver-se' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1689 }, "name": "SQL_SERVER_SE", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "const": true, "docs": { "remarks": "NOTE: using unversioned engines is an availability risk.\n We recommend using versioned engines created using the {@link sqlServerWeb()} method", "stability": "stable", "summary": "The unversioned 'sqlserver-web' instance engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1705 }, "name": "SQL_SERVER_WEB", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } } ], "symbolId": "lib/instance-engine:DatabaseInstanceEngine" }, "@aws-cdk/aws-rds.DatabaseInstanceFromSnapshot": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-rds.DatabaseInstanceBase", "docs": { "custom": { "resource": "AWS::RDS::DBInstance", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A database instance restored from a snapshot.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});" }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceFromSnapshot", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 1077 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseInstanceFromSnapshotProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IDatabaseInstance" ], "kind": "class", "locationInModule": { "filename": "lib/instance.ts", "line": 1070 }, "methods": [ { "docs": { "stability": "stable", "summary": "Adds the multi user rotation to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 948 }, "name": "addRotationMultiUser", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Adds the single user rotation of the master password to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 925 }, "name": "addRotationSingleUser", "parameters": [ { "docs": { "summary": "the options for the rotation, if you want to override the defaults." }, "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 765 }, "name": "setLogRetention", "protected": true } ], "name": "DatabaseInstanceFromSnapshot", "properties": [ { "docs": { "stability": "stable", "summary": "Access to network connections." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 631 }, "name": "connections", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1072 }, "name": "dbInstanceEndpointAddress", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1073 }, "name": "dbInstanceEndpointPort", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1074 }, "name": "instanceEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1071 }, "name": "instanceIdentifier", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 851 }, "name": "instanceType", "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 636 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 850 }, "name": "sourceCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } }, { "docs": { "stability": "stable", "summary": "The VPC where this database instance is deployed." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 629 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "docs": { "remarks": "May be not known for imported Instances if it wasn't provided explicitly,\nor for read replicas.", "stability": "stable", "summary": "The engine of this database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 844 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "docs": { "stability": "stable", "summary": "The AWS Secrets Manager secret attached to the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1075 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 635 }, "name": "vpcPlacement", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 645 }, "name": "enableIamAuthentication", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance:DatabaseInstanceFromSnapshot" }, "@aws-cdk/aws-rds.DatabaseInstanceFromSnapshotProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseInstanceFromSnapshot.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceFromSnapshotProps", "interfaces": [ "@aws-cdk/aws-rds.DatabaseInstanceSourceProps" ], "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 1046 }, "name": "DatabaseInstanceFromSnapshotProps", "properties": [ { "abstract": true, "docs": { "remarks": "If you're restoring from a shared manual DB\nsnapshot, you must specify the ARN of the snapshot.", "stability": "stable", "summary": "The name or Amazon Resource Name (ARN) of the DB snapshot that's used to restore the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1052 }, "name": "snapshotIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- The existing username and password from the snapshot will be used.", "remarks": "Note - It is not possible to change the master username for a snapshot;\nhowever, it is possible to provide (or generate) a new password.", "stability": "stable", "summary": "Master user credentials." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1062 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } } ], "symbolId": "lib/instance:DatabaseInstanceFromSnapshotProps" }, "@aws-cdk/aws-rds.DatabaseInstanceNewProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseInstanceNew.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const bucket: s3.Bucket;\ndeclare const key: kms.Key;\ndeclare const optionGroup: rds.OptionGroup;\ndeclare const parameterGroup: rds.ParameterGroup;\ndeclare const role: iam.Role;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const subnetGroup: rds.SubnetGroup;\ndeclare const vpc: ec2.Vpc;\nconst databaseInstanceNewProps: rds.DatabaseInstanceNewProps = {\n vpc: vpc,\n\n // the properties below are optional\n autoMinorVersionUpgrade: false,\n availabilityZone: 'availabilityZone',\n backupRetention: cdk.Duration.minutes(30),\n cloudwatchLogsExports: ['cloudwatchLogsExports'],\n cloudwatchLogsRetention: logs.RetentionDays.ONE_DAY,\n cloudwatchLogsRetentionRole: role,\n copyTagsToSnapshot: false,\n deleteAutomatedBackups: false,\n deletionProtection: false,\n domain: 'domain',\n domainRole: role,\n enablePerformanceInsights: false,\n iamAuthentication: false,\n instanceIdentifier: 'instanceIdentifier',\n iops: 123,\n maxAllocatedStorage: 123,\n monitoringInterval: cdk.Duration.minutes(30),\n monitoringRole: role,\n multiAz: false,\n optionGroup: optionGroup,\n parameterGroup: parameterGroup,\n performanceInsightEncryptionKey: key,\n performanceInsightRetention: rds.PerformanceInsightRetention.DEFAULT,\n port: 123,\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n processorFeatures: {\n coreCount: 123,\n threadsPerCore: 123,\n },\n publiclyAccessible: false,\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n s3ExportBuckets: [bucket],\n s3ExportRole: role,\n s3ImportBuckets: [bucket],\n s3ImportRole: role,\n securityGroups: [securityGroup],\n storageType: rds.StorageType.STANDARD,\n subnetGroup: subnetGroup,\n vpcPlacement: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceNewProps", "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 280 }, "name": "DatabaseInstanceNewProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC network where the DB subnet group should be created." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 333 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates that minor engine upgrades are applied automatically to the DB instance during the maintenance window." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 494 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no preference", "stability": "stable", "summary": "The name of the Availability Zone where the DB instance will be located." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 293 }, "name": "availabilityZone", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Duration.days(1) for source instances, disabled for read replicas", "remarks": "Set to zero to disable backups.\nWhen creating a read replica, you must enable automatic backups on the source\ndatabase instance by setting the backup retention to a value other than zero.", "stability": "stable", "summary": "The number of days during which automatic DB snapshots are retained." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 394 }, "name": "backupRetention", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- no log exports", "stability": "stable", "summary": "The list of log types that need to be enabled for exporting to CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 469 }, "name": "cloudwatchLogsExports", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- logs never expire", "remarks": "When updating\nthis property, unsetting it doesn't remove the log retention policy. To\nremove the retention policy, set the value to `Infinity`.", "stability": "stable", "summary": "The number of days log events are kept in CloudWatch Logs." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 478 }, "name": "cloudwatchLogsRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-logs.RetentionDays" } }, { "abstract": true, "docs": { "default": "- a new role is created.", "stability": "stable", "summary": "The IAM role for the Lambda function associated with the custom resource that sets the retention policy." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 486 }, "name": "cloudwatchLogsRetentionRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "true", "stability": "stable", "summary": "Indicates whether to copy all of the user-defined tags from the DB instance to snapshots of the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 417 }, "name": "copyTagsToSnapshot", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Indicates whether automated backups should be deleted or retained when you delete a DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 425 }, "name": "deleteAutomatedBackups", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true if ``removalPolicy`` is RETAIN, false otherwise", "stability": "stable", "summary": "Indicates whether the DB instance should have deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 513 }, "name": "deletionProtection", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Do not join domain", "stability": "stable", "summary": "The Active Directory directory ID to create the DB instance in." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 535 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- The role will be created for you if {@link DatabaseInstanceNewProps#domain} is specified", "remarks": "The role needs the AWS-managed policy\nAmazonRDSDirectoryServiceAccess or equivalent.", "stability": "stable", "summary": "The IAM role to be used when making API calls to the Directory Service." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 543 }, "name": "domainRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.", "stability": "stable", "summary": "Whether to enable Performance Insights for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 447 }, "name": "enablePerformanceInsights", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to enable mapping of AWS Identity and Access Management (IAM) accounts to database accounts." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 384 }, "name": "iamAuthentication", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- a CloudFormation generated name", "remarks": "If you specify a name, AWS CloudFormation\nconverts it to lowercase.", "stability": "stable", "summary": "A name for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 328 }, "name": "instanceIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no provisioned iops", "remarks": "The value must be equal to or greater than 1000.", "stability": "stable", "summary": "The number of I/O operations per second (IOPS) that the database provisions." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 310 }, "name": "iops", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- No autoscaling of RDS instance", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_PIOPS.StorageTypes.html#USER_PIOPS.Autoscaling", "stability": "stable", "summary": "Upper limit to which RDS can scale the storage in GiB(Gibibyte)." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 528 }, "name": "maxAllocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no enhanced monitoring", "stability": "stable", "summary": "The interval, in seconds, between points when Amazon RDS collects enhanced monitoring metrics for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 433 }, "name": "monitoringInterval", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A role is automatically created for you", "stability": "stable", "summary": "Role that will be used to manage DB instance monitoring." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 440 }, "name": "monitoringRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Specifies if the database instance is a multiple Availability Zone deployment." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 286 }, "name": "multiAz", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no option group", "stability": "stable", "summary": "The option group to associate with the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 376 }, "name": "optionGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IOptionGroup" } }, { "abstract": true, "docs": { "default": "- no parameter group", "stability": "stable", "summary": "The DB parameter group to associate with the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 369 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "The AWS KMS key for encryption of Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 461 }, "name": "performanceInsightEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "7", "stability": "stable", "summary": "The amount of time, in days, to retain Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 454 }, "name": "performanceInsightRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.PerformanceInsightRetention" } }, { "abstract": true, "docs": { "default": "- the default port for the chosen engine.", "stability": "stable", "summary": "The port for the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 362 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- a 30-minute window selected at random from an 8-hour block of\ntime for each AWS Region. To see the time blocks available, see\nhttps://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithAutomatedBackups.html#USER_WorkingWithAutomatedBackups.BackupWindow", "remarks": "Constraints:\n- Must be in the format `hh24:mi-hh24:mi`.\n- Must be in Universal Coordinated Time (UTC).\n- Must not conflict with the preferred maintenance window.\n- Must be at least 30 minutes.", "stability": "stable", "summary": "The daily time range during which automated backups are performed." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 409 }, "name": "preferredBackupWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- a 30-minute window selected at random from an 8-hour block of\ntime for each AWS Region, occurring on a random day of the week. To see\nthe time blocks available, see https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html#Concepts.DBMaintenance", "remarks": "Format: `ddd:hh24:mi-ddd:hh24:mi`\nConstraint: Minimum 30-minute window", "stability": "stable", "summary": "The weekly time range (in UTC) during which system maintenance can occur." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 506 }, "name": "preferredMaintenanceWindow", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- the default number of CPU cores and threads per core for the\nchosen instance class.\n\nSee https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor", "stability": "stable", "summary": "The number of CPU cores and the number of threads per core." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 320 }, "name": "processorFeatures", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ProcessorFeatures" } }, { "abstract": true, "docs": { "default": "- `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise", "stability": "stable", "summary": "Indicates whether the DB instance is an internet-facing instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 619 }, "name": "publiclyAccessible", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- RemovalPolicy.SNAPSHOT (remove the resource, but retain a snapshot of the data)", "stability": "stable", "summary": "The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 521 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This property must not be used if `s3ExportRole` is used.\n\nFor Microsoft SQL Server:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html", "stability": "stable", "summary": "S3 buckets that you want to load data into." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 612 }, "name": "s3ExportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ExportBuckets` is set, no role is defined otherwise", "remarks": "This property must not be used if `s3ExportBuckets` is used.\n\nFor Microsoft SQL Server:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/oracle-s3-integration.html", "stability": "stable", "summary": "Role that will be associated with this DB instance to enable S3 export." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 598 }, "name": "s3ExportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.\n\nThis property must not be used if `s3ImportRole` is used.\n\nFor Microsoft SQL Server:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html", "stability": "stable", "summary": "S3 buckets that you want to load data from." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 584 }, "name": "s3ImportBuckets", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-s3.IBucket" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- New role is created if `s3ImportBuckets` is set, no role is defined otherwise", "remarks": "This feature is only supported by the Microsoft SQL Server, Oracle, and PostgreSQL engines.\n\nThis property must not be used if `s3ImportBuckets` is used.\n\nFor Microsoft SQL Server:", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/PostgreSQL.Procedural.Importing.html", "stability": "stable", "summary": "Role that will be associated with this DB instance to enable S3 import." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 567 }, "name": "s3ImportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- a new security group is created", "stability": "stable", "summary": "The security groups to assign to the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 355 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "GP2", "remarks": "Storage types supported are gp2, io1, standard.", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_Storage.html#Concepts.Storage.GeneralSSD", "stability": "stable", "summary": "The storage type." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 302 }, "name": "storageType", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.StorageType" } }, { "abstract": true, "docs": { "default": "- a new subnet group will be created.", "stability": "stable", "summary": "Existing subnet group for the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 550 }, "name": "subnetGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, { "abstract": true, "docs": { "default": "- private subnets", "deprecated": "use `vpcSubnets`", "stability": "deprecated", "summary": "The type of subnets to add to the created DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 341 }, "name": "vpcPlacement", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } }, { "abstract": true, "docs": { "default": "- private subnets", "stability": "stable", "summary": "The type of subnets to add to the created DB subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 348 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/instance:DatabaseInstanceNewProps" }, "@aws-cdk/aws-rds.DatabaseInstanceProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseInstance.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nnew rds.DatabaseInstance(this, 'InstanceWithUsername', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres'), // Creates an admin user of postgres with a generated password\n});\n\nnew rds.DatabaseInstance(this, 'InstanceWithUsernameAndPassword', {\n engine,\n vpc,\n credentials: rds.Credentials.fromPassword('postgres', SecretValue.ssmSecure('/dbPassword', '1')), // Use password from SSM\n});\n\nconst mySecret = secretsmanager.Secret.fromSecretName(this, 'DBSecret', 'myDBLoginInfo');\nnew rds.DatabaseInstance(this, 'InstanceWithSecretLogin', {\n engine,\n vpc,\n credentials: rds.Credentials.fromSecret(mySecret), // Get both username and password from existing secret\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceProps", "interfaces": [ "@aws-cdk/aws-rds.DatabaseInstanceSourceProps" ], "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 967 }, "name": "DatabaseInstanceProps", "properties": [ { "abstract": true, "docs": { "default": "- RDS default character set name", "stability": "stable", "summary": "For supported engines, specifies the character set to associate with the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 981 }, "name": "characterSetName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- A username of 'admin' (or 'postgres' for PostgreSQL) and SecretsManager-generated password", "stability": "stable", "summary": "Credentials for the administrative user." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 973 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, { "abstract": true, "docs": { "default": "- true if storageEncryptionKey has been provided, false otherwise", "stability": "stable", "summary": "Indicates whether the DB instance is encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 988 }, "name": "storageEncrypted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default master key if storageEncrypted is true, no key otherwise", "stability": "stable", "summary": "The KMS key that's used to encrypt the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 995 }, "name": "storageEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "symbolId": "lib/instance:DatabaseInstanceProps" }, "@aws-cdk/aws-rds.DatabaseInstanceReadReplica": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-rds.DatabaseInstanceBase", "docs": { "custom": { "resource": "AWS::RDS::DBInstance", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A read replica database instance.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});" }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceReadReplica", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 1166 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseInstanceReadReplicaProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IDatabaseInstance" ], "kind": "class", "locationInModule": { "filename": "lib/instance.ts", "line": 1158 }, "methods": [ { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 765 }, "name": "setLogRetention", "protected": true } ], "name": "DatabaseInstanceReadReplica", "properties": [ { "docs": { "stability": "stable", "summary": "Access to network connections." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 631 }, "name": "connections", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1160 }, "name": "dbInstanceEndpointAddress", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1161 }, "name": "dbInstanceEndpointPort", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The instance endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1162 }, "name": "instanceEndpoint", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1159 }, "name": "instanceIdentifier", "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "primitive": "string" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1164 }, "name": "instanceType", "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 636 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBInstanceProps" } }, { "docs": { "stability": "stable", "summary": "The VPC where this database instance is deployed." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 629 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "docs": { "remarks": "May be not known for imported Instances if it wasn't provided explicitly,\nor for read replicas.", "stability": "stable", "summary": "The engine of this database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1163 }, "name": "engine", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 635 }, "name": "vpcPlacement", "optional": true, "protected": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/instance.ts", "line": 645 }, "name": "enableIamAuthentication", "optional": true, "overrides": "@aws-cdk/aws-rds.DatabaseInstanceBase", "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance:DatabaseInstanceReadReplica" }, "@aws-cdk/aws-rds.DatabaseInstanceReadReplicaProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseInstanceReadReplica.", "example": "declare const vpc: ec2.Vpc;\nnew rds.DatabaseInstanceFromSnapshot(this, 'Instance', {\n snapshotIdentifier: 'my-snapshot',\n engine: rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});\n\ndeclare const sourceInstance: rds.DatabaseInstance;\nnew rds.DatabaseInstanceReadReplica(this, 'ReadReplica', {\n sourceDatabaseInstance: sourceInstance,\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE2, ec2.InstanceSize.LARGE),\n vpc,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceReadReplicaProps", "interfaces": [ "@aws-cdk/aws-rds.DatabaseInstanceNewProps" ], "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 1123 }, "name": "DatabaseInstanceReadReplicaProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the compute and memory capacity classes." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1127 }, "name": "instanceType", "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "abstract": true, "docs": { "remarks": "Each DB instance can have a limited number of read replicas. For more\ninformation, see https://docs.aws.amazon.com/AmazonRDS/latest/DeveloperGuide/USER_ReadRepl.html.", "stability": "stable", "summary": "The source database instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1136 }, "name": "sourceDatabaseInstance", "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseInstance" } }, { "abstract": true, "docs": { "default": "- true if storageEncryptionKey has been provided, false otherwise", "stability": "stable", "summary": "Indicates whether the DB instance is encrypted." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1143 }, "name": "storageEncrypted", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default master key if storageEncrypted is true, no key otherwise", "stability": "stable", "summary": "The KMS key that's used to encrypt the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 1150 }, "name": "storageEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } } ], "symbolId": "lib/instance:DatabaseInstanceReadReplicaProps" }, "@aws-cdk/aws-rds.DatabaseInstanceSourceProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseInstanceSource.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as kms from '@aws-cdk/aws-kms';\nimport * as logs from '@aws-cdk/aws-logs';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as s3 from '@aws-cdk/aws-s3';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const bucket: s3.Bucket;\ndeclare const instanceEngine: rds.IInstanceEngine;\ndeclare const instanceType: ec2.InstanceType;\ndeclare const key: kms.Key;\ndeclare const optionGroup: rds.OptionGroup;\ndeclare const parameterGroup: rds.ParameterGroup;\ndeclare const role: iam.Role;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const subnetGroup: rds.SubnetGroup;\ndeclare const vpc: ec2.Vpc;\nconst databaseInstanceSourceProps: rds.DatabaseInstanceSourceProps = {\n engine: instanceEngine,\n vpc: vpc,\n\n // the properties below are optional\n allocatedStorage: 123,\n allowMajorVersionUpgrade: false,\n autoMinorVersionUpgrade: false,\n availabilityZone: 'availabilityZone',\n backupRetention: cdk.Duration.minutes(30),\n cloudwatchLogsExports: ['cloudwatchLogsExports'],\n cloudwatchLogsRetention: logs.RetentionDays.ONE_DAY,\n cloudwatchLogsRetentionRole: role,\n copyTagsToSnapshot: false,\n databaseName: 'databaseName',\n deleteAutomatedBackups: false,\n deletionProtection: false,\n domain: 'domain',\n domainRole: role,\n enablePerformanceInsights: false,\n iamAuthentication: false,\n instanceIdentifier: 'instanceIdentifier',\n instanceType: instanceType,\n iops: 123,\n licenseModel: rds.LicenseModel.LICENSE_INCLUDED,\n maxAllocatedStorage: 123,\n monitoringInterval: cdk.Duration.minutes(30),\n monitoringRole: role,\n multiAz: false,\n optionGroup: optionGroup,\n parameterGroup: parameterGroup,\n parameters: {\n parametersKey: 'parameters',\n },\n performanceInsightEncryptionKey: key,\n performanceInsightRetention: rds.PerformanceInsightRetention.DEFAULT,\n port: 123,\n preferredBackupWindow: 'preferredBackupWindow',\n preferredMaintenanceWindow: 'preferredMaintenanceWindow',\n processorFeatures: {\n coreCount: 123,\n threadsPerCore: 123,\n },\n publiclyAccessible: false,\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n s3ExportBuckets: [bucket],\n s3ExportRole: role,\n s3ImportBuckets: [bucket],\n s3ImportRole: role,\n securityGroups: [securityGroup],\n storageType: rds.StorageType.STANDARD,\n subnetGroup: subnetGroup,\n timezone: 'timezone',\n vpcPlacement: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseInstanceSourceProps", "interfaces": [ "@aws-cdk/aws-rds.DatabaseInstanceNewProps" ], "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 781 }, "name": "DatabaseInstanceSourceProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The database engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 785 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "abstract": true, "docs": { "default": "100", "stability": "stable", "summary": "The allocated storage size, specified in gigabytes (GB)." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 820 }, "name": "allocatedStorage", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to allow major version upgrades." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 806 }, "name": "allowMajorVersionUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no name", "stability": "stable", "summary": "The name of the database." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 827 }, "name": "databaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- m5.large (or, more specifically, db.m5.large)", "stability": "stable", "summary": "The name of the compute and memory capacity for the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 792 }, "name": "instanceType", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "abstract": true, "docs": { "default": "- RDS default license model", "stability": "stable", "summary": "The license model." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 799 }, "name": "licenseModel", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.LicenseModel" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "You can only specify parameterGroup or parameters but not both.\nYou need to use a versioned engine to auto-generate a DBParameterGroup.", "stability": "stable", "summary": "The parameters in the DBParameterGroup to create automatically." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 837 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- RDS default timezone", "remarks": "This is currently supported only by Microsoft Sql Server.", "stability": "stable", "summary": "The time zone of the instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 813 }, "name": "timezone", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/instance:DatabaseInstanceSourceProps" }, "@aws-cdk/aws-rds.DatabaseProxy": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::RDS::DBProxy", "exampleMetadata": "infused" }, "stability": "stable", "summary": "RDS Database Proxy.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'." }, "fqn": "@aws-cdk/aws-rds.DatabaseProxy", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/proxy.ts", "line": 416 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyProps" } } ] }, "interfaces": [ "@aws-cdk/aws-ec2.IConnectable", "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "@aws-cdk/aws-rds.IDatabaseProxy" ], "kind": "class", "locationInModule": { "filename": "lib/proxy.ts", "line": 369 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing database proxy." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 374 }, "name": "fromDatabaseProxyAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseProxy" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Renders the secret attachment target specifications." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 493 }, "name": "asSecretAttachmentTarget", "overrides": "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretAttachmentTargetProps" } } }, { "docs": { "stability": "stable", "summary": "Grant the given identity connection access to the proxy." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 500 }, "name": "grantConnect", "overrides": "@aws-cdk/aws-rds.IDatabaseProxy", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } }, { "name": "dbUser", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "DatabaseProxy", "properties": [ { "docs": { "stability": "stable", "summary": "Access to network connections." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 411 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "DB Proxy ARN." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 399 }, "name": "dbProxyArn", "overrides": "@aws-cdk/aws-rds.IDatabaseProxy", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "DB Proxy Name." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 392 }, "name": "dbProxyName", "overrides": "@aws-cdk/aws-rds.IDatabaseProxy", "type": { "primitive": "string" } }, { "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 406 }, "name": "endpoint", "overrides": "@aws-cdk/aws-rds.IDatabaseProxy", "type": { "primitive": "string" } } ], "symbolId": "lib/proxy:DatabaseProxy" }, "@aws-cdk/aws-rds.DatabaseProxyAttributes": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties that describe an existing DB Proxy.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const securityGroup: ec2.SecurityGroup;\nconst databaseProxyAttributes: rds.DatabaseProxyAttributes = {\n dbProxyArn: 'dbProxyArn',\n dbProxyName: 'dbProxyName',\n endpoint: 'endpoint',\n securityGroups: [securityGroup],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.DatabaseProxyAttributes", "kind": "interface", "locationInModule": { "filename": "lib/proxy.ts", "line": 276 }, "name": "DatabaseProxyAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "DB Proxy ARN." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 285 }, "name": "dbProxyArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "DB Proxy Name." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 280 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 290 }, "name": "endpoint", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The security groups of the instance." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 295 }, "name": "securityGroups", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } } ], "symbolId": "lib/proxy:DatabaseProxyAttributes" }, "@aws-cdk/aws-rds.DatabaseProxyOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options for a new DatabaseProxy.", "example": "declare const vpc: ec2.Vpc;\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const secrets: secretsmanager.Secret[];\ndeclare const dbInstance: rds.DatabaseInstance;\n\nconst proxy = dbInstance.addProxy('proxy', {\n borrowTimeout: Duration.seconds(30),\n maxConnectionsPercent: 50,\n secrets,\n vpc,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseProxyOptions", "kind": "interface", "locationInModule": { "filename": "lib/proxy.ts", "line": 126 }, "name": "DatabaseProxyOptions", "properties": [ { "abstract": true, "docs": { "remarks": "These secrets are stored within Amazon Secrets Manager.\nOne or more secrets are required.", "stability": "stable", "summary": "The secret that the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 241 }, "name": "secrets", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC to associate with the new proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 260 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "cdk.Duration.seconds(120)", "remarks": "Only applies when the proxy has opened its maximum number of connections and all connections are busy with client\nsessions.\n\nValue must be between 1 second and 1 hour, or `Duration.seconds(0)` to represent unlimited.", "stability": "stable", "summary": "The duration for a proxy to wait for a connection to become available in the connection pool." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 146 }, "name": "borrowTimeout", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- Generated by CloudFormation (recommended)", "remarks": "This name must be unique for all proxies owned by your AWS account in the specified AWS Region.\nAn identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens;\nit can't end with a hyphen or contain two consecutive hyphens.", "stability": "stable", "summary": "The identifier for the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 135 }, "name": "dbProxyName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "false", "remarks": "This information helps you to debug issues involving SQL behavior or the performance and scalability of the proxy connections.\nThe debug information includes the text of SQL statements that you submit through the proxy.\nThus, only enable this setting when needed for debugging, and only when you have security measures in place to safeguard any sensitive\ninformation that appears in the logs.", "stability": "stable", "summary": "Whether the proxy includes detailed information about SQL statements in its logs." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 204 }, "name": "debugLogging", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 211 }, "name": "iamAuth", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "cdk.Duration.minutes(30)", "remarks": "You can set this value higher or lower than the connection timeout limit for the associated database.", "stability": "stable", "summary": "The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 219 }, "name": "idleClientTimeout", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- no initialization query", "remarks": "Typically used with SET statements to make sure that each connection has identical settings such as time zone\nand character set.\nFor multiple statements, use semicolons as the separator.\nYou can also include multiple variables in a single SET statement, such as SET x=1, y=2.\n\nnot currently supported for PostgreSQL.", "stability": "stable", "summary": "One or more SQL statements for the proxy to run when opening each new database connection." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 159 }, "name": "initQuery", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "100", "remarks": "For Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance or Aurora DB\ncluster used by the target group.\n\n1-100", "stability": "stable", "summary": "The maximum size of the connection pool for each target in a target group." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 170 }, "name": "maxConnectionsPercent", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "50", "remarks": "A high value enables the proxy to leave a high percentage of idle connections open.\nA low value causes the proxy to close idle client connections and return the underlying database connections\nto the connection pool.\nFor Aurora MySQL, it is expressed as a percentage of the max_connections setting for the RDS DB instance\nor Aurora DB cluster used by the target group.\n\nbetween 0 and MaxConnectionsPercent", "stability": "stable", "summary": "Controls how actively the proxy closes idle database connections in the connection pool." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 184 }, "name": "maxIdleConnectionsPercent", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "true", "remarks": "By enabling this setting, you can enforce encrypted TLS connections to the proxy.", "stability": "stable", "summary": "A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 227 }, "name": "requireTLS", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- A role will automatically be created", "stability": "stable", "summary": "IAM role that the proxy uses to access secrets in AWS Secrets Manager." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 234 }, "name": "role", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- No security groups", "stability": "stable", "summary": "One or more VPC security groups to associate with the new proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 248 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no session pinning filters", "remarks": "Including an item in the list exempts that class of SQL operations from the pinning behavior.", "stability": "stable", "summary": "Each item in the list represents a class of SQL operations that normally cause all later statements in a session using a proxy to be pinned to the same underlying database connection." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 193 }, "name": "sessionPinningFilters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.SessionPinningFilter" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the VPC default strategy if not specified.", "stability": "stable", "summary": "The subnets used by the proxy." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 255 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/proxy:DatabaseProxyOptions" }, "@aws-cdk/aws-rds.DatabaseProxyProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseProxy.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseProxyProps", "interfaces": [ "@aws-cdk/aws-rds.DatabaseProxyOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/proxy.ts", "line": 266 }, "name": "DatabaseProxyProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "DB proxy target: Instance or Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 270 }, "name": "proxyTarget", "type": { "fqn": "@aws-cdk/aws-rds.ProxyTarget" } } ], "symbolId": "lib/proxy:DatabaseProxyProps" }, "@aws-cdk/aws-rds.DatabaseSecret": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/aws-secretsmanager.Secret", "docs": { "custom": { "resource": "AWS::SecretsManager::Secret", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A database secret.", "example": "declare const instance: rds.DatabaseInstance;\nconst myUserSecret = new rds.DatabaseSecret(this, 'MyUserSecret', {\n username: 'myuser',\n secretName: 'my-user-secret', // optional, defaults to a CloudFormation-generated name\n masterSecret: instance.secret,\n excludeCharacters: '{}[]()\\'\"/\\\\', // defaults to the set \" %+~`#$&*()|[]{}:;<>?!'/@\\\"\\\\\"\n});\nconst myUserSecretAttached = myUserSecret.attach(instance); // Adds DB connections information in the secret\n\ninstance.addRotationMultiUser('MyUser', { // Add rotation using the multi user scheme\n secret: myUserSecretAttached,\n});" }, "fqn": "@aws-cdk/aws-rds.DatabaseSecret", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/database-secret.ts", "line": 71 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseSecretProps" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/database-secret.ts", "line": 70 }, "name": "DatabaseSecret", "symbolId": "lib/database-secret:DatabaseSecret" }, "@aws-cdk/aws-rds.DatabaseSecretProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for a DatabaseSecret.", "example": "declare const instance: rds.DatabaseInstance;\nconst myUserSecret = new rds.DatabaseSecret(this, 'MyUserSecret', {\n username: 'myuser',\n secretName: 'my-user-secret', // optional, defaults to a CloudFormation-generated name\n masterSecret: instance.secret,\n excludeCharacters: '{}[]()\\'\"/\\\\', // defaults to the set \" %+~`#$&*()|[]{}:;<>?!'/@\\\"\\\\\"\n});\nconst myUserSecretAttached = myUserSecret.attach(instance); // Adds DB connections information in the secret\n\ninstance.addRotationMultiUser('MyUser', { // Add rotation using the multi user scheme\n secret: myUserSecretAttached,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.DatabaseSecretProps", "kind": "interface", "locationInModule": { "filename": "lib/database-secret.ts", "line": 11 }, "name": "DatabaseSecretProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The username." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 15 }, "name": "username", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "default master key", "stability": "stable", "summary": "The KMS key to use to encrypt the secret." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 29 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\"" }, "default": "\" %+~`#$&*()|[]{}:;<>?!'/", "stability": "stable", "summary": "Characters to not include in the generated password." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 43 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no master secret information will be included", "stability": "stable", "summary": "The master secret which will be used to rotate this secret." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 36 }, "name": "masterSecret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "abstract": true, "docs": { "default": "false", "remarks": "This is achieved by overriding the logical id of the AWS::SecretsManager::Secret\nwith a hash of the options that influence the password generation. This\nway a new secret will be created when the password is regenerated and the\ncluster or instance consuming this secret will have its credentials updated.", "stability": "stable", "summary": "Whether to replace this secret when the criteria for the password change." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 55 }, "name": "replaceOnPasswordCriteriaChanges", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Secret is not replicated", "stability": "stable", "summary": "A list of regions where to replicate this secret." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 62 }, "name": "replicaRegions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ReplicaRegion" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- A name is generated by CloudFormation.", "stability": "stable", "summary": "A name for the secret." }, "immutable": true, "locationInModule": { "filename": "lib/database-secret.ts", "line": 22 }, "name": "secretName", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/database-secret:DatabaseSecretProps" }, "@aws-cdk/aws-rds.Endpoint": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Consists of a combination of hostname and port.", "stability": "stable", "summary": "Connection endpoint of a database cluster or instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst endpoint = new rds.Endpoint('address', 123);", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.Endpoint", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/endpoint.ts", "line": 24 }, "parameters": [ { "name": "address", "type": { "primitive": "string" } }, { "name": "port", "type": { "primitive": "number" } } ] }, "kind": "class", "locationInModule": { "filename": "lib/endpoint.ts", "line": 8 }, "name": "Endpoint", "properties": [ { "docs": { "stability": "stable", "summary": "The hostname of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/endpoint.ts", "line": 12 }, "name": "hostname", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The port of the endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/endpoint.ts", "line": 17 }, "name": "port", "type": { "primitive": "number" } }, { "docs": { "stability": "stable", "summary": "The combination of \"HOSTNAME:PORT\" for this endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/endpoint.ts", "line": 22 }, "name": "socketAddress", "type": { "primitive": "string" } } ], "symbolId": "lib/endpoint:Endpoint" }, "@aws-cdk/aws-rds.EngineVersion": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "A version of an engine - for either a cluster, or instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst engineVersion: rds.EngineVersion = {\n majorVersion: 'majorVersion',\n\n // the properties below are optional\n fullVersion: 'fullVersion',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.EngineVersion", "kind": "interface", "locationInModule": { "filename": "lib/engine-version.ts", "line": 5 }, "name": "EngineVersion", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"5.6\". Used in specifying the ParameterGroup family and OptionGroup version for this engine." }, "immutable": true, "locationInModule": { "filename": "lib/engine-version.ts", "line": 22 }, "name": "majorVersion", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no version specified", "stability": "stable", "summary": "The full version string of the engine, for example, \"5.6.mysql_aurora.1.22.1\". It can be undefined, which means RDS should use whatever version it deems appropriate for the given engine type." }, "immutable": true, "locationInModule": { "filename": "lib/engine-version.ts", "line": 14 }, "name": "fullVersion", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/engine-version:EngineVersion" }, "@aws-cdk/aws-rds.IClusterEngine": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The interface representing a database cluster (as opposed to instance) engine." }, "fqn": "@aws-cdk/aws-rds.IClusterEngine", "interfaces": [ "@aws-cdk/aws-rds.IEngine" ], "kind": "interface", "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 90 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Method called when the engine is used to create a new cluster." }, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 111 }, "name": "bindToCluster", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.ClusterEngineBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ClusterEngineConfig" } } } ], "name": "IClusterEngine", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The application used by this engine to perform rotation for a multi-user scenario." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 95 }, "name": "multiUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The application used by this engine to perform rotation for a single-user scenario." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 92 }, "name": "singleUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The log types that are available with this engine type." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 98 }, "name": "supportedLogTypes", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether the IAM Roles used for data importing and exporting need to be combined for this Engine, or can they be kept separate." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-engine.ts", "line": 106 }, "name": "combineImportAndExportRoles", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/cluster-engine:IClusterEngine" }, "@aws-cdk/aws-rds.IDatabaseCluster": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Create a clustered database with a given number of instances." }, "fqn": "@aws-cdk/aws-rds.IDatabaseCluster", "interfaces": [ "@aws-cdk/core.IResource", "@aws-cdk/aws-ec2.IConnectable", "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget" ], "kind": "interface", "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 11 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Add a new db proxy to this cluster." }, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 48 }, "name": "addProxy", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxy" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Return the given named metric for this DBCluster." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 11 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The percentage of CPU utilization." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 17 }, "name": "metricCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of database connections in use." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 23 }, "name": "metricDatabaseConnections", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of deadlocks in the database per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 29 }, "name": "metricDeadlocks", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of time that the instance has been running, in seconds." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 35 }, "name": "metricEngineUptime", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available random access memory, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 41 }, "name": "metricFreeableMemory", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of local storage available, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 47 }, "name": "metricFreeLocalStorage", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput received from clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 53 }, "name": "metricNetworkReceiveThroughput", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput both received from and transmitted to clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 59 }, "name": "metricNetworkThroughput", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of network throughput sent to clients by each instance, in bytes per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 65 }, "name": "metricNetworkTransmitThroughput", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The total amount of backup storage in bytes consumed by all Aurora snapshots outside its backup retention window." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 71 }, "name": "metricSnapshotStorageUsed", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The total amount of backup storage in bytes for which you are billed." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 77 }, "name": "metricTotalBackupStorageBilled", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of storage used by your Aurora DB instance, in bytes." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 83 }, "name": "metricVolumeBytesUsed", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 89 }, "name": "metricVolumeReadIOPs", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 95 }, "name": "metricVolumeWriteIOPs", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } } ], "name": "IDatabaseCluster", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "EndpointAddress,EndpointPort" }, "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 26 }, "name": "clusterEndpoint", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 15 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "ReadEndpointAddress" }, "stability": "stable", "summary": "Endpoint to use for load-balanced read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 32 }, "name": "clusterReadEndpoint", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Endpoints which address each individual replica." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 37 }, "name": "instanceEndpoints", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.Endpoint" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Identifiers of the replicas." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 20 }, "name": "instanceIdentifiers", "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "array" } } }, { "abstract": true, "docs": { "remarks": "May be not known for imported Clusters if it wasn't provided explicitly.", "stability": "stable", "summary": "The engine of this Cluster." }, "immutable": true, "locationInModule": { "filename": "lib/cluster-ref.ts", "line": 43 }, "name": "engine", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } } ], "symbolId": "lib/cluster-ref:IDatabaseCluster" }, "@aws-cdk/aws-rds.IDatabaseInstance": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "A database instance." }, "fqn": "@aws-cdk/aws-rds.IDatabaseInstance", "interfaces": [ "@aws-cdk/core.IResource", "@aws-cdk/aws-ec2.IConnectable", "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget" ], "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 25 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Add a new db proxy to this instance." }, "locationInModule": { "filename": "lib/instance.ts", "line": 65 }, "name": "addProxy", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxyOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxy" } } }, { "abstract": true, "docs": { "remarks": "**Note**: this method does not currently work, see https://github.com/aws/aws-cdk/issues/11851 for details.", "see": "https://github.com/aws/aws-cdk/issues/11851", "stability": "stable", "summary": "Grant the given identity connection access to the database." }, "locationInModule": { "filename": "lib/instance.ts", "line": 72 }, "name": "grantConnect", "parameters": [ { "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Return the given named metric for this DBInstance." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 246 }, "name": "metric", "parameters": [ { "name": "metricName", "type": { "primitive": "string" } }, { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The percentage of CPU utilization." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 252 }, "name": "metricCPUUtilization", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The number of database connections in use." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 258 }, "name": "metricDatabaseConnections", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available random access memory." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 270 }, "name": "metricFreeableMemory", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The amount of available storage space." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 264 }, "name": "metricFreeStorageSpace", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of disk write I/O operations per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 282 }, "name": "metricReadIOPS", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Average over 5 minutes", "stability": "stable", "summary": "The average number of disk read I/O operations per second." }, "locationInModule": { "filename": "lib/rds-augmentations.generated.ts", "line": 276 }, "name": "metricWriteIOPS", "parameters": [ { "name": "props", "optional": true, "type": { "fqn": "@aws-cdk/aws-cloudwatch.MetricOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-cloudwatch.Metric" } } }, { "abstract": true, "docs": { "remarks": "Use\n`rule.addEventPattern(pattern)` to specify a filter.", "stability": "stable", "summary": "Defines a CloudWatch event rule which triggers for instance events." }, "locationInModule": { "filename": "lib/instance.ts", "line": 78 }, "name": "onEvent", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-events.OnEventOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-events.Rule" } } } ], "name": "IDatabaseInstance", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "EndpointAddress" }, "stability": "stable", "summary": "The instance endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 41 }, "name": "dbInstanceEndpointAddress", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "EndpointPort" }, "stability": "stable", "summary": "The instance endpoint port." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 48 }, "name": "dbInstanceEndpointPort", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance arn." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 34 }, "name": "instanceArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 53 }, "name": "instanceEndpoint", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The instance identifier." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 29 }, "name": "instanceIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "May be not known for imported Instances if it wasn't provided explicitly,\nor for read replicas.", "stability": "stable", "summary": "The engine of this database Instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 60 }, "name": "engine", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } } ], "symbolId": "lib/instance:IDatabaseInstance" }, "@aws-cdk/aws-rds.IDatabaseProxy": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "DB Proxy." }, "fqn": "@aws-cdk/aws-rds.IDatabaseProxy", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/proxy.ts", "line": 301 }, "methods": [ { "abstract": true, "docs": { "default": "- if the Proxy had been provided a single Secret value,\nthe user will be taken from that Secret", "stability": "stable", "summary": "Grant the given identity connection access to the proxy." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 332 }, "name": "grantConnect", "parameters": [ { "docs": { "summary": "the Principal to grant the permissions to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } }, { "docs": { "summary": "the name of the database user to allow connecting as to the proxy." }, "name": "dbUser", "optional": true, "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "IDatabaseProxy", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "DB Proxy ARN." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 314 }, "name": "dbProxyArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "DB Proxy Name." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 307 }, "name": "dbProxyName", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "Endpoint." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 321 }, "name": "endpoint", "type": { "primitive": "string" } } ], "symbolId": "lib/proxy:IDatabaseProxy" }, "@aws-cdk/aws-rds.IEngine": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Don't implement this interface directly,\ninstead implement one of the known sub-interfaces,\nlike IClusterEngine and IInstanceEngine.", "stability": "stable", "summary": "A common interface for database engines." }, "fqn": "@aws-cdk/aws-rds.IEngine", "kind": "interface", "locationInModule": { "filename": "lib/engine.ts", "line": 9 }, "name": "IEngine", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The type of the engine, for example \"mysql\"." }, "immutable": true, "locationInModule": { "filename": "lib/engine.ts", "line": 11 }, "name": "engineType", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "remarks": "The global default of 'admin' will be used if this is `undefined`.\nNote that 'admin' is a reserved word in PostgreSQL and cannot be used.", "stability": "stable", "summary": "The default name of the master database user if one was not provided explicitly." }, "immutable": true, "locationInModule": { "filename": "lib/engine.ts", "line": 48 }, "name": "defaultUsername", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- the engine doesn't belong to any family", "remarks": "This property is used when creating a Database Proxy.\nMost engines don't belong to any family\n(and because of that, you can't create Database Proxies for their Clusters or Instances).", "stability": "stable", "summary": "The family this engine belongs to, like \"MYSQL\", or \"POSTGRESQL\"." }, "immutable": true, "locationInModule": { "filename": "lib/engine.ts", "line": 41 }, "name": "engineFamily", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- use the default version for this engine type", "stability": "stable", "summary": "The exact version of the engine that is used, for example \"5.1.42\"." }, "immutable": true, "locationInModule": { "filename": "lib/engine.ts", "line": 19 }, "name": "engineVersion", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.EngineVersion" } }, { "abstract": true, "docs": { "default": "- the ParameterGroup family is not known\n(which means the major version of the engine is also not known)", "remarks": "This is usually equal to \"\",\nbut can sometimes be a variation of that.\nYou can pass this property when creating new ParameterGroup.", "stability": "stable", "summary": "The family to use for ParameterGroups using this engine." }, "immutable": true, "locationInModule": { "filename": "lib/engine.ts", "line": 30 }, "name": "parameterGroupFamily", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/engine:IEngine" }, "@aws-cdk/aws-rds.IInstanceEngine": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Interface representing a database instance (as opposed to cluster) engine." }, "fqn": "@aws-cdk/aws-rds.IInstanceEngine", "interfaces": [ "@aws-cdk/aws-rds.IEngine" ], "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 96 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Method called when the engine is used to create a new instance." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 113 }, "name": "bindToInstance", "parameters": [ { "name": "scope", "type": { "fqn": "@aws-cdk/core.Construct" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.InstanceEngineBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.InstanceEngineConfig" } } } ], "name": "IInstanceEngine", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The application used by this engine to perform rotation for a multi-user scenario." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 101 }, "name": "multiUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The application used by this engine to perform rotation for a single-user scenario." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 98 }, "name": "singleUserRotationApplication", "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotationApplication" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this engine supports automatic backups of a read replica instance." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 108 }, "name": "supportsReadReplicaBackups", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance-engine:IInstanceEngine" }, "@aws-cdk/aws-rds.IOptionGroup": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "An option group." }, "fqn": "@aws-cdk/aws-rds.IOptionGroup", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/option-group.ts", "line": 10 }, "methods": [ { "abstract": true, "docs": { "remarks": "This method is a no-op for an imported OptionGroup.", "returns": "true if the OptionConfiguration was successfully added.", "stability": "stable", "summary": "Adds a configuration to this OptionGroup." }, "locationInModule": { "filename": "lib/option-group.ts", "line": 24 }, "name": "addConfiguration", "parameters": [ { "name": "configuration", "type": { "fqn": "@aws-cdk/aws-rds.OptionConfiguration" } } ], "returns": { "type": { "primitive": "boolean" } } } ], "name": "IOptionGroup", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the option group." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 16 }, "name": "optionGroupName", "type": { "primitive": "string" } } ], "symbolId": "lib/option-group:IOptionGroup" }, "@aws-cdk/aws-rds.IParameterGroup": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "Represents both a cluster parameter group,\nand an instance parameter group.", "stability": "stable", "summary": "A parameter group." }, "fqn": "@aws-cdk/aws-rds.IParameterGroup", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 41 }, "methods": [ { "abstract": true, "docs": { "remarks": "If this is an imported parameter group,\nthis method does nothing.", "returns": "true if the parameter was actually added\n(i.e., this ParameterGroup is not imported),\nfalse otherwise", "stability": "stable", "summary": "Adds a parameter to this group." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 61 }, "name": "addParameter", "parameters": [ { "name": "key", "type": { "primitive": "string" } }, { "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "boolean" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Method called when this Parameter Group is used when defining a database cluster." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 45 }, "name": "bindToCluster", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterConfig" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Method called when this Parameter Group is used when defining a database instance." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 50 }, "name": "bindToInstance", "parameters": [ { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceConfig" } } } ], "name": "IParameterGroup", "symbolId": "lib/parameter-group:IParameterGroup" }, "@aws-cdk/aws-rds.IServerlessCluster": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Interface representing a serverless database cluster." }, "fqn": "@aws-cdk/aws-rds.IServerlessCluster", "interfaces": [ "@aws-cdk/core.IResource", "@aws-cdk/aws-ec2.IConnectable", "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget" ], "kind": "interface", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 22 }, "methods": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Grant the given identity to access to the Data API." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 50 }, "name": "grantDataApiAccess", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "IServerlessCluster", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The ARN of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 31 }, "name": "clusterArn", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "EndpointAddress,EndpointPort" }, "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 37 }, "name": "clusterEndpoint", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 26 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "custom": { "attribute": "ReadEndpointAddress" }, "stability": "stable", "summary": "Endpoint to use for load-balanced read-only operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 43 }, "name": "clusterReadEndpoint", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } } ], "symbolId": "lib/serverless-cluster:IServerlessCluster" }, "@aws-cdk/aws-rds.ISubnetGroup": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Interface for a subnet group." }, "fqn": "@aws-cdk/aws-rds.ISubnetGroup", "interfaces": [ "@aws-cdk/core.IResource" ], "kind": "interface", "locationInModule": { "filename": "lib/subnet-group.ts", "line": 9 }, "name": "ISubnetGroup", "properties": [ { "abstract": true, "docs": { "custom": { "attribute": "true" }, "stability": "stable", "summary": "The name of the subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 14 }, "name": "subnetGroupName", "type": { "primitive": "string" } } ], "symbolId": "lib/subnet-group:ISubnetGroup" }, "@aws-cdk/aws-rds.InstanceEngineBindOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The options passed to {@link IInstanceEngine.bind}.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as iam from '@aws-cdk/aws-iam';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const optionGroup: rds.OptionGroup;\ndeclare const role: iam.Role;\nconst instanceEngineBindOptions: rds.InstanceEngineBindOptions = {\n domain: 'domain',\n optionGroup: optionGroup,\n s3ExportRole: role,\n s3ImportRole: role,\n timezone: 'timezone',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.InstanceEngineBindOptions", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 14 }, "name": "InstanceEngineBindOptions", "properties": [ { "abstract": true, "docs": { "default": "- none (it's an optional field)", "stability": "stable", "summary": "The Active Directory directory ID to create the DB instance in." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 20 }, "name": "domain", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The option group of the database." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 48 }, "name": "optionGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IOptionGroup" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The role used for S3 exporting." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 41 }, "name": "s3ExportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The role used for S3 importing." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 34 }, "name": "s3ImportRole", "optional": true, "type": { "fqn": "@aws-cdk/aws-iam.IRole" } }, { "abstract": true, "docs": { "default": "- none (it's an optional field)", "stability": "stable", "summary": "The timezone of the database, set by the customer." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 27 }, "name": "timezone", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:InstanceEngineBindOptions" }, "@aws-cdk/aws-rds.InstanceEngineConfig": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The type returned from the {@link IInstanceEngine.bind} method.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const optionGroup: rds.OptionGroup;\nconst instanceEngineConfig: rds.InstanceEngineConfig = {\n features: {\n s3Export: 's3Export',\n s3Import: 's3Import',\n },\n optionGroup: optionGroup,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.InstanceEngineConfig", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 54 }, "name": "InstanceEngineConfig", "properties": [ { "abstract": true, "docs": { "default": "- no features", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html", "stability": "stable", "summary": "Features supported by the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 62 }, "name": "features", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.InstanceEngineFeatures" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "Option group of the database." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 69 }, "name": "optionGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IOptionGroup" } } ], "symbolId": "lib/instance-engine:InstanceEngineConfig" }, "@aws-cdk/aws-rds.InstanceEngineFeatures": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Represents Database Engine features.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst instanceEngineFeatures: rds.InstanceEngineFeatures = {\n s3Export: 's3Export',\n s3Import: 's3Import',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.InstanceEngineFeatures", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 75 }, "name": "InstanceEngineFeatures", "properties": [ { "abstract": true, "docs": { "default": "- no s3Export feature name", "stability": "stable", "summary": "Feature name for the DB instance that the IAM role to export to S3 bucket is to be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 90 }, "name": "s3Export", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no s3Import feature name", "stability": "stable", "summary": "Feature name for the DB instance that the IAM role to access the S3 bucket for import is to be associated with." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 82 }, "name": "s3Import", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:InstanceEngineFeatures" }, "@aws-cdk/aws-rds.InstanceProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Instance properties for database instances.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.InstanceProps", "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 10 }, "name": "InstanceProps", "properties": [ { "abstract": true, "docs": { "remarks": "Must be at least 2 subnets in two different AZs.", "stability": "stable", "summary": "What subnets to run the RDS instances in." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 23 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- false", "stability": "stable", "summary": "Whether to allow upgrade of major version for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 89 }, "name": "allowMajorVersionUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "stable", "summary": "Whether to enable automatic upgrade of minor version for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 82 }, "name": "autoMinorVersionUpgrade", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- true", "stability": "stable", "summary": "Whether to remove automated backups immediately after the DB instance is deleted for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 96 }, "name": "deleteAutomatedBackups", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- false, unless ``performanceInsightRentention`` or ``performanceInsightEncryptionKey`` is set.", "stability": "stable", "summary": "Whether to enable Performance Insights for the DB instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 61 }, "name": "enablePerformanceInsights", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- t3.medium (or, more precisely, db.t3.medium)", "stability": "stable", "summary": "What type of instance to start for the replicas." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 16 }, "name": "instanceType", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.InstanceType" } }, { "abstract": true, "docs": { "default": "no parameter group", "stability": "stable", "summary": "The DB parameter group to associate with the instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 44 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- None", "remarks": "You can only specify parameterGroup or parameters but not both.\nYou need to use a versioned engine to auto-generate a DBParameterGroup.", "stability": "stable", "summary": "The parameters in the DBParameterGroup to create automatically." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 54 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "The AWS KMS key for encryption of Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 75 }, "name": "performanceInsightEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "7", "stability": "stable", "summary": "The amount of time, in days, to retain Performance Insights data." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 68 }, "name": "performanceInsightRetention", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.PerformanceInsightRetention" } }, { "abstract": true, "docs": { "default": "- `true` if `vpcSubnets` is `subnetType: SubnetType.PUBLIC`, `false` otherwise", "stability": "stable", "summary": "Indicates whether the DB instance is an internet-facing instance." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 103 }, "name": "publiclyAccessible", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "a new security group is created.", "stability": "stable", "summary": "Security group." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 37 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the Vpc default strategy if not specified.", "stability": "stable", "summary": "Where to place the instances within the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 30 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/props:InstanceProps" }, "@aws-cdk/aws-rds.LicenseModel": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The license model.", "example": " // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });", "custom": { "exampleMetadata": "lit=test/integ.instance.lit.ts infused" } }, "fqn": "@aws-cdk/aws-rds.LicenseModel", "kind": "enum", "locationInModule": { "filename": "lib/instance.ts", "line": 221 }, "members": [ { "docs": { "stability": "stable", "summary": "License included." }, "name": "LICENSE_INCLUDED" }, { "docs": { "stability": "stable", "summary": "Bring your own licencse." }, "name": "BRING_YOUR_OWN_LICENSE" }, { "docs": { "stability": "stable", "summary": "General public license." }, "name": "GENERAL_PUBLIC_LICENSE" } ], "name": "LicenseModel", "symbolId": "lib/instance:LicenseModel" }, "@aws-cdk/aws-rds.MariaDbEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the MariaDB instance engines (those returned by {@link DatabaseInstanceEngine.mariaDb}).", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst mariaDbEngineVersion = rds.MariaDbEngineVersion.VER_10_0;", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 166 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new MariaDbEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 314 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"10.5.28\"." }, "name": "mariaDbFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"10.5\"." }, "name": "mariaDbMajorVersion", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, "static": true } ], "name": "MariaDbEngineVersion", "properties": [ { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 171 }, "name": "VER_10_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 176 }, "name": "VER_10_0_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 181 }, "name": "VER_10_0_24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 186 }, "name": "VER_10_0_28", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.31\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 191 }, "name": "VER_10_0_31", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.32\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 196 }, "name": "VER_10_0_32", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.34\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 201 }, "name": "VER_10_0_34", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.0 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.0.35\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 206 }, "name": "VER_10_0_35", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 212 }, "name": "VER_10_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 217 }, "name": "VER_10_1_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 222 }, "name": "VER_10_1_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 227 }, "name": "VER_10_1_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.26\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 232 }, "name": "VER_10_1_26", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.31\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 237 }, "name": "VER_10_1_31", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "deprecated": "MariaDB 10.1 will reach end of life on May 18, 2021", "stability": "deprecated", "summary": "Version \"10.1.34\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 242 }, "name": "VER_10_1_34", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 245 }, "name": "VER_10_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 247 }, "name": "VER_10_2_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 249 }, "name": "VER_10_2_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 251 }, "name": "VER_10_2_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 253 }, "name": "VER_10_2_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.32\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 255 }, "name": "VER_10_2_32", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.37\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 257 }, "name": "VER_10_2_37", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.39\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 259 }, "name": "VER_10_2_39", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.40\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 261 }, "name": "VER_10_2_40", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.2.41\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 263 }, "name": "VER_10_2_41", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 266 }, "name": "VER_10_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 270 }, "name": "VER_10_3_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 272 }, "name": "VER_10_3_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 274 }, "name": "VER_10_3_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 276 }, "name": "VER_10_3_28", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.31\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 278 }, "name": "VER_10_3_31", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.32\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 280 }, "name": "VER_10_3_32", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 268 }, "name": "VER_10_3_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 283 }, "name": "VER_10_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 287 }, "name": "VER_10_4_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 289 }, "name": "VER_10_4_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4.21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 291 }, "name": "VER_10_4_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4.22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 293 }, "name": "VER_10_4_22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 285 }, "name": "VER_10_4_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 296 }, "name": "VER_10_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 302 }, "name": "VER_10_5_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 304 }, "name": "VER_10_5_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 298 }, "name": "VER_10_5_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 300 }, "name": "VER_10_5_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"10.5.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 319 }, "name": "mariaDbFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"10.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 321 }, "name": "mariaDbMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:MariaDbEngineVersion" }, "@aws-cdk/aws-rds.MariaDbInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.mariaDb}.", "stability": "stable", "summary": "Properties for MariaDB instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const mariaDbEngineVersion: rds.MariaDbEngineVersion;\nconst mariaDbInstanceEngineProps: rds.MariaDbInstanceEngineProps = {\n version: mariaDbEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.MariaDbInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 333 }, "name": "MariaDbInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 335 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.MariaDbEngineVersion" } } ], "symbolId": "lib/instance-engine:MariaDbInstanceEngineProps" }, "@aws-cdk/aws-rds.MySqlInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.mysql}.", "stability": "stable", "summary": "Properties for MySQL instance engines.", "example": "declare const vpc: ec2.Vpc;\nconst role = new iam.Role(this, 'RDSDirectoryServicesRole', {\n assumedBy: new iam.ServicePrincipal('rds.amazonaws.com'),\n managedPolicies: [\n iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AmazonRDSDirectoryServiceAccess'),\n ],\n});\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),\n vpc,\n domain: 'd-????????', // The ID of the domain for the instance to join.\n domainRole: role, // Optional - will be create automatically if not provided.\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.MySqlInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 558 }, "name": "MySqlInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 560 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } } ], "symbolId": "lib/instance-engine:MySqlInstanceEngineProps" }, "@aws-cdk/aws-rds.MysqlEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the MySQL instance engines (those returned by {@link DatabaseInstanceEngine.mysql}).", "example": "declare const vpc: ec2.Vpc;\nconst role = new iam.Role(this, 'RDSDirectoryServicesRole', {\n assumedBy: new iam.ServicePrincipal('rds.amazonaws.com'),\n managedPolicies: [\n iam.ManagedPolicy.fromAwsManagedPolicyName('service-role/AmazonRDSDirectoryServiceAccess'),\n ],\n});\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.mysql({ version: rds.MysqlEngineVersion.VER_8_0_19 }),\n vpc,\n domain: 'd-????????', // The ID of the domain for the instance to join.\n domainRole: role, // Optional - will be create automatically if not provided.\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 367 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new MysqlEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 539 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"8.1.43\"." }, "name": "mysqlFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"8.1\"." }, "name": "mysqlMajorVersion", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, "static": true } ], "name": "MysqlEngineVersion", "properties": [ { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 372 }, "name": "VER_5_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5.46\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 377 }, "name": "VER_5_5_46", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5.53\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 382 }, "name": "VER_5_5_53", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5.57\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 387 }, "name": "VER_5_5_57", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5.59\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 392 }, "name": "VER_5_5_59", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.5 will reach end of life on May 25, 2021", "stability": "deprecated", "summary": "Version \"5.5.61\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 397 }, "name": "VER_5_5_61", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 403 }, "name": "VER_5_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.34\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 408 }, "name": "VER_5_6_34", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.35\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 413 }, "name": "VER_5_6_35", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.37\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 418 }, "name": "VER_5_6_37", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.39\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 423 }, "name": "VER_5_6_39", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.40\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 428 }, "name": "VER_5_6_40", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.41\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 433 }, "name": "VER_5_6_41", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.43\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 438 }, "name": "VER_5_6_43", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.44\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 443 }, "name": "VER_5_6_44", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.46\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 448 }, "name": "VER_5_6_46", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.48\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 453 }, "name": "VER_5_6_48", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.49\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 458 }, "name": "VER_5_6_49", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "deprecated": "MySQL 5.6 will reach end of life on August 3, 2021", "stability": "deprecated", "summary": "Version \"5.6.51\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 463 }, "name": "VER_5_6_51", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 466 }, "name": "VER_5_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 468 }, "name": "VER_5_7_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 470 }, "name": "VER_5_7_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 472 }, "name": "VER_5_7_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 474 }, "name": "VER_5_7_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 476 }, "name": "VER_5_7_22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 478 }, "name": "VER_5_7_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 480 }, "name": "VER_5_7_24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.25\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 482 }, "name": "VER_5_7_25", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.26\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 484 }, "name": "VER_5_7_26", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 486 }, "name": "VER_5_7_28", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.30\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 488 }, "name": "VER_5_7_30", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.31\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 490 }, "name": "VER_5_7_31", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.33\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 492 }, "name": "VER_5_7_33", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.34\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 494 }, "name": "VER_5_7_34", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.35\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 496 }, "name": "VER_5_7_35", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.36\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 498 }, "name": "VER_5_7_36", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"5.7.37\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 500 }, "name": "VER_5_7_37", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 503 }, "name": "VER_8_0", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 505 }, "name": "VER_8_0_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 507 }, "name": "VER_8_0_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 509 }, "name": "VER_8_0_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 511 }, "name": "VER_8_0_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 513 }, "name": "VER_8_0_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 515 }, "name": "VER_8_0_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.20 \"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 517 }, "name": "VER_8_0_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.21 \"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 519 }, "name": "VER_8_0_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 521 }, "name": "VER_8_0_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.25\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 523 }, "name": "VER_8_0_25", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.26\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 525 }, "name": "VER_8_0_26", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.27\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 527 }, "name": "VER_8_0_27", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"8.0.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 529 }, "name": "VER_8_0_28", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.MysqlEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"10.5.28\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 544 }, "name": "mysqlFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"10.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 546 }, "name": "mysqlMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:MysqlEngineVersion" }, "@aws-cdk/aws-rds.OptionConfiguration": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Configuration properties for an option.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const securityGroup: ec2.SecurityGroup;\ndeclare const vpc: ec2.Vpc;\nconst optionConfiguration: rds.OptionConfiguration = {\n name: 'name',\n\n // the properties below are optional\n port: 123,\n securityGroups: [securityGroup],\n settings: {\n settingsKey: 'settings',\n },\n version: 'version',\n vpc: vpc,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.OptionConfiguration", "kind": "interface", "locationInModule": { "filename": "lib/option-group.ts", "line": 30 }, "name": "OptionConfiguration", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of the option." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 34 }, "name": "name", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no port", "remarks": "If `port` is specified then `vpc`\nmust also be specified.", "stability": "stable", "summary": "The port number that this option uses." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 56 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- a default group will be created if `port` or `vpc` are specified.", "remarks": "If no groups are provided, a default one will be created.", "stability": "stable", "summary": "Optional list of security groups to use for this option, if `vpc` is specified." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 72 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- no settings", "stability": "stable", "summary": "The settings for the option." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 41 }, "name": "settings", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } }, { "abstract": true, "docs": { "default": "- no version", "stability": "stable", "summary": "The version for the option." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 48 }, "name": "version", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no VPC", "remarks": "If `vpc`\nis specified then `port` must also be specified.", "stability": "stable", "summary": "The VPC where a security group should be created for this option." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 64 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } } ], "symbolId": "lib/option-group:OptionConfiguration" }, "@aws-cdk/aws-rds.OptionGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "stability": "stable", "summary": "An option group.", "example": " // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });", "custom": { "exampleMetadata": "lit=test/integ.instance.lit.ts infused" } }, "fqn": "@aws-cdk/aws-rds.OptionGroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/option-group.ts", "line": 124 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.OptionGroupProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IOptionGroup" ], "kind": "class", "locationInModule": { "filename": "lib/option-group.ts", "line": 100 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing option group." }, "locationInModule": { "filename": "lib/option-group.ts", "line": 104 }, "name": "fromOptionGroupName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "optionGroupName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IOptionGroup" } }, "static": true }, { "docs": { "remarks": "This method is a no-op for an imported OptionGroup.", "stability": "stable", "summary": "Adds a configuration to this OptionGroup." }, "locationInModule": { "filename": "lib/option-group.ts", "line": 144 }, "name": "addConfiguration", "overrides": "@aws-cdk/aws-rds.IOptionGroup", "parameters": [ { "name": "configuration", "type": { "fqn": "@aws-cdk/aws-rds.OptionConfiguration" } } ], "returns": { "type": { "primitive": "boolean" } } } ], "name": "OptionGroup", "properties": [ { "docs": { "stability": "stable", "summary": "The connections object for the options." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 120 }, "name": "optionConnections", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.Connections" }, "kind": "map" } } }, { "docs": { "stability": "stable", "summary": "The name of the option group." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 115 }, "name": "optionGroupName", "overrides": "@aws-cdk/aws-rds.IOptionGroup", "type": { "primitive": "string" } } ], "symbolId": "lib/option-group:OptionGroup" }, "@aws-cdk/aws-rds.OptionGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Construction properties for an OptionGroup.", "example": " // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });", "custom": { "exampleMetadata": "lit=test/integ.instance.lit.ts infused" } }, "fqn": "@aws-cdk/aws-rds.OptionGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/option-group.ts", "line": 78 }, "name": "OptionGroupProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The configurations for this option group." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 94 }, "name": "configurations", "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.OptionConfiguration" }, "kind": "array" } } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The database engine that this option group is associated with." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 82 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IInstanceEngine" } }, { "abstract": true, "docs": { "default": "a CDK generated description", "stability": "stable", "summary": "A description of the option group." }, "immutable": true, "locationInModule": { "filename": "lib/option-group.ts", "line": 89 }, "name": "description", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/option-group:OptionGroupProps" }, "@aws-cdk/aws-rds.OracleEeInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.oracleEe}.", "stability": "stable", "summary": "Properties for Oracle Enterprise Edition instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const oracleEngineVersion: rds.OracleEngineVersion;\nconst oracleEeInstanceEngineProps: rds.OracleEeInstanceEngineProps = {\n version: oracleEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.OracleEeInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1344 }, "name": "OracleEeInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1260 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } } ], "symbolId": "lib/instance-engine:OracleEeInstanceEngineProps" }, "@aws-cdk/aws-rds.OracleEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the Oracle instance engines (those returned by {@link DatabaseInstanceEngine.oracleSe2} and {@link DatabaseInstanceEngine.oracleEe}).", "example": "declare const vpc: ec2.Vpc;\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),\n credentials: rds.Credentials.fromGeneratedSecret('syscdk'), // Optional - will default to 'admin' username and generated password\n vpc,\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.OracleEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1078 }, "methods": [ { "docs": { "stability": "stable", "summary": "Creates a new OracleEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1199 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"19.0.0.0.ru-2019-10.rur-2019-10.r1\"." }, "name": "oracleFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"19\"." }, "name": "oracleMajorVersion", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, "static": true } ], "name": "OracleEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1080 }, "name": "VER_12_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1082 }, "name": "VER_12_1_0_2_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1100 }, "name": "VER_12_1_0_2_V10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1102 }, "name": "VER_12_1_0_2_V11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1104 }, "name": "VER_12_1_0_2_V12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1106 }, "name": "VER_12_1_0_2_V13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1108 }, "name": "VER_12_1_0_2_V14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1110 }, "name": "VER_12_1_0_2_V15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1112 }, "name": "VER_12_1_0_2_V16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1114 }, "name": "VER_12_1_0_2_V17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1116 }, "name": "VER_12_1_0_2_V18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1118 }, "name": "VER_12_1_0_2_V19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1084 }, "name": "VER_12_1_0_2_V2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1120 }, "name": "VER_12_1_0_2_V20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1122 }, "name": "VER_12_1_0_2_V21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1124 }, "name": "VER_12_1_0_2_V22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1126 }, "name": "VER_12_1_0_2_V23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1128 }, "name": "VER_12_1_0_2_V24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1086 }, "name": "VER_12_1_0_2_V3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1088 }, "name": "VER_12_1_0_2_V4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1090 }, "name": "VER_12_1_0_2_V5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1092 }, "name": "VER_12_1_0_2_V6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1094 }, "name": "VER_12_1_0_2_V7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1096 }, "name": "VER_12_1_0_2_V8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.1.0.2.v9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1098 }, "name": "VER_12_1_0_2_V9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1131 }, "name": "VER_12_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2018-10.rur-2018-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1133 }, "name": "VER_12_2_0_1_2018_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2019-01.rur-2019-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1135 }, "name": "VER_12_2_0_1_2019_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2019-04.rur-2019-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1137 }, "name": "VER_12_2_0_1_2019_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2019-07.rur-2019-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1139 }, "name": "VER_12_2_0_1_2019_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2019-10.rur-2019-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1141 }, "name": "VER_12_2_0_1_2019_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2020-01.rur-2020-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1143 }, "name": "VER_12_2_0_1_2020_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2020-04.rur-2020-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1145 }, "name": "VER_12_2_0_1_2020_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2020-07.rur-2020-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1147 }, "name": "VER_12_2_0_1_2020_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2021-10.rur-2020-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1149 }, "name": "VER_12_2_0_1_2020_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2021-01.rur-2021-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1151 }, "name": "VER_12_2_0_1_2021_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2.0.1.ru-2021-04.rur-2021-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1153 }, "name": "VER_12_2_0_1_2021_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1157 }, "name": "VER_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18.0.0.0.ru-2019-07.rur-2019-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1159 }, "name": "VER_18_0_0_0_2019_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18.0.0.0.ru-2019-10.rur-2019-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1161 }, "name": "VER_18_0_0_0_2019_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18.0.0.0.ru-2020-01.rur-2020-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1163 }, "name": "VER_18_0_0_0_2020_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18.0.0.0.ru-2020-04.rur-2020-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1165 }, "name": "VER_18_0_0_0_2020_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"18.0.0.0.ru-2020-07.rur-2020-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1167 }, "name": "VER_18_0_0_0_2020_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1170 }, "name": "VER_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2019-07.rur-2019-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1172 }, "name": "VER_19_0_0_0_2019_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2019-10.rur-2019-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1174 }, "name": "VER_19_0_0_0_2019_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2020-01.rur-2020-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1176 }, "name": "VER_19_0_0_0_2020_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2020-04.rur-2020-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1178 }, "name": "VER_19_0_0_0_2020_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2020-07.rur-2020-07.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1180 }, "name": "VER_19_0_0_0_2020_07_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2020-07.rur-2020-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1182 }, "name": "VER_19_0_0_0_2020_10_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2021-01.rur-2021-01.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1184 }, "name": "VER_19_0_0_0_2021_01_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2021-01.rur-2021-01.r2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1186 }, "name": "VER_19_0_0_0_2021_01_R2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"19.0.0.0.ru-2021-01.rur-2021-04.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1188 }, "name": "VER_19_0_0_0_2021_04_R1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"19.0.0.0.ru-2019-10.rur-2019-10.r1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1204 }, "name": "oracleFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1206 }, "name": "oracleMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:OracleEngineVersion" }, "@aws-cdk/aws-rds.OracleLegacyEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "deprecated": "instances can no longer be created with these engine versions. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "stability": "deprecated", "summary": "The versions for the legacy Oracle instance engines (those returned by {@link DatabaseInstanceEngine.oracleSe} and {@link DatabaseInstanceEngine.oracleSe1}). Note: RDS will stop allowing creating new databases with this version in August 2020.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst oracleLegacyEngineVersion = rds.OracleLegacyEngineVersion.VER_11_2;", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1004 }, "name": "OracleLegacyEngineVersion", "properties": [ { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1006 }, "name": "VER_11_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.2.v2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1008 }, "name": "VER_11_2_0_2_V2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1010 }, "name": "VER_11_2_0_4_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1026 }, "name": "VER_11_2_0_4_V10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1028 }, "name": "VER_11_2_0_4_V11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1030 }, "name": "VER_11_2_0_4_V12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1032 }, "name": "VER_11_2_0_4_V13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1034 }, "name": "VER_11_2_0_4_V14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1036 }, "name": "VER_11_2_0_4_V15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1038 }, "name": "VER_11_2_0_4_V16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1040 }, "name": "VER_11_2_0_4_V17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1042 }, "name": "VER_11_2_0_4_V18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1044 }, "name": "VER_11_2_0_4_V19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1046 }, "name": "VER_11_2_0_4_V20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1048 }, "name": "VER_11_2_0_4_V21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1050 }, "name": "VER_11_2_0_4_V22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1052 }, "name": "VER_11_2_0_4_V23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1054 }, "name": "VER_11_2_0_4_V24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v25\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1056 }, "name": "VER_11_2_0_4_V25", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1012 }, "name": "VER_11_2_0_4_V3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1014 }, "name": "VER_11_2_0_4_V4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1016 }, "name": "VER_11_2_0_4_V5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1018 }, "name": "VER_11_2_0_4_V6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1020 }, "name": "VER_11_2_0_4_V7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1022 }, "name": "VER_11_2_0_4_V8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "const": true, "docs": { "stability": "deprecated", "summary": "Version \"11.2.0.4.v9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1024 }, "name": "VER_11_2_0_4_V9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } }, { "docs": { "stability": "deprecated", "summary": "The full version string, for example, \"11.2.0.4.v24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1063 }, "name": "oracleLegacyFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "deprecated", "summary": "The major version of the engine, for example, \"11.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1065 }, "name": "oracleLegacyMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:OracleLegacyEngineVersion" }, "@aws-cdk/aws-rds.OracleSe1InstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "remarks": "Used in {@link DatabaseInstanceEngine.oracleSe1}.", "stability": "deprecated", "summary": "Properties for Oracle Standard Edition 1 instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const oracleLegacyEngineVersion: rds.OracleLegacyEngineVersion;\nconst oracleSe1InstanceEngineProps: rds.OracleSe1InstanceEngineProps = {\n version: oracleLegacyEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.OracleSe1InstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1297 }, "name": "OracleSe1InstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1299 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } } ], "symbolId": "lib/instance-engine:OracleSe1InstanceEngineProps" }, "@aws-cdk/aws-rds.OracleSe2InstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.oracleSe2}.", "stability": "stable", "summary": "Properties for Oracle Standard Edition 2 instance engines.", "example": "declare const vpc: ec2.Vpc;\nconst instance = new rds.DatabaseInstance(this, 'Instance', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n // optional, defaults to m5.large\n instanceType: ec2.InstanceType.of(ec2.InstanceClass.BURSTABLE3, ec2.InstanceSize.SMALL),\n credentials: rds.Credentials.fromGeneratedSecret('syscdk'), // Optional - will default to 'admin' username and generated password\n vpc,\n vpcSubnets: {\n subnetType: ec2.SubnetType.PRIVATE_WITH_NAT,\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.OracleSe2InstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1323 }, "name": "OracleSe2InstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1260 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.OracleEngineVersion" } } ], "symbolId": "lib/instance-engine:OracleSe2InstanceEngineProps" }, "@aws-cdk/aws-rds.OracleSeInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "deprecated": "instances can no longer be created with this engine. See https://forums.aws.amazon.com/ann.jspa?annID=7341", "remarks": "Used in {@link DatabaseInstanceEngine.oracleSe}.", "stability": "deprecated", "summary": "Properties for Oracle Standard Edition instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const oracleLegacyEngineVersion: rds.OracleLegacyEngineVersion;\nconst oracleSeInstanceEngineProps: rds.OracleSeInstanceEngineProps = {\n version: oracleLegacyEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.OracleSeInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1269 }, "name": "OracleSeInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "deprecated", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1271 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.OracleLegacyEngineVersion" } } ], "symbolId": "lib/instance-engine:OracleSeInstanceEngineProps" }, "@aws-cdk/aws-rds.ParameterGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::RDS::DBParameterGroup", "exampleMetadata": "infused" }, "remarks": "Represents both a cluster parameter group,\nand an instance parameter group.", "stability": "stable", "summary": "A parameter group.", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),\n vpc,\n scaling: {\n autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time\n minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)\n maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)\n }\n});" }, "fqn": "@aws-cdk/aws-rds.ParameterGroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 124 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IParameterGroup" ], "kind": "class", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 95 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports a parameter group." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 99 }, "name": "fromParameterGroupName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "parameterGroupName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Add a parameter to this parameter group." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 170 }, "name": "addParameter", "overrides": "@aws-cdk/aws-rds.IParameterGroup", "parameters": [ { "docs": { "summary": "The key of the parameter to be added." }, "name": "key", "type": { "primitive": "string" } }, { "docs": { "summary": "The value of the parameter to be added." }, "name": "value", "type": { "primitive": "string" } } ], "returns": { "type": { "primitive": "boolean" } } }, { "docs": { "stability": "stable", "summary": "Method called when this Parameter Group is used when defining a database cluster." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 136 }, "name": "bindToCluster", "overrides": "@aws-cdk/aws-rds.IParameterGroup", "parameters": [ { "name": "_options", "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterConfig" } } }, { "docs": { "stability": "stable", "summary": "Method called when this Parameter Group is used when defining a database instance." }, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 150 }, "name": "bindToInstance", "overrides": "@aws-cdk/aws-rds.IParameterGroup", "parameters": [ { "name": "_options", "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceBindOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceConfig" } } } ], "name": "ParameterGroup", "symbolId": "lib/parameter-group:ParameterGroup" }, "@aws-cdk/aws-rds.ParameterGroupClusterBindOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options for {@link IParameterGroup.bindToCluster}. Empty for now, but can be extended later.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst parameterGroupClusterBindOptions: rds.ParameterGroupClusterBindOptions = { };", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterBindOptions", "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 10 }, "name": "ParameterGroupClusterBindOptions", "symbolId": "lib/parameter-group:ParameterGroupClusterBindOptions" }, "@aws-cdk/aws-rds.ParameterGroupClusterConfig": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The type returned from {@link IParameterGroup.bindToCluster}.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst parameterGroupClusterConfig: rds.ParameterGroupClusterConfig = {\n parameterGroupName: 'parameterGroupName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ParameterGroupClusterConfig", "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 16 }, "name": "ParameterGroupClusterConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of this parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 18 }, "name": "parameterGroupName", "type": { "primitive": "string" } } ], "symbolId": "lib/parameter-group:ParameterGroupClusterConfig" }, "@aws-cdk/aws-rds.ParameterGroupInstanceBindOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options for {@link IParameterGroup.bindToInstance}. Empty for now, but can be extended later.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst parameterGroupInstanceBindOptions: rds.ParameterGroupInstanceBindOptions = { };", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceBindOptions", "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 25 }, "name": "ParameterGroupInstanceBindOptions", "symbolId": "lib/parameter-group:ParameterGroupInstanceBindOptions" }, "@aws-cdk/aws-rds.ParameterGroupInstanceConfig": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The type returned from {@link IParameterGroup.bindToInstance}.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst parameterGroupInstanceConfig: rds.ParameterGroupInstanceConfig = {\n parameterGroupName: 'parameterGroupName',\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ParameterGroupInstanceConfig", "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 31 }, "name": "ParameterGroupInstanceConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The name of this parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 33 }, "name": "parameterGroupName", "type": { "primitive": "string" } } ], "symbolId": "lib/parameter-group:ParameterGroupInstanceConfig" }, "@aws-cdk/aws-rds.ParameterGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a parameter group.", "example": " // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });", "custom": { "exampleMetadata": "lit=test/integ.instance.lit.ts infused" } }, "fqn": "@aws-cdk/aws-rds.ParameterGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/parameter-group.ts", "line": 67 }, "name": "ParameterGroupProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The database engine for this parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 71 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IEngine" } }, { "abstract": true, "docs": { "default": "a CDK generated description", "stability": "stable", "summary": "Description for this parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 78 }, "name": "description", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- None", "stability": "stable", "summary": "The parameters in this parameter group." }, "immutable": true, "locationInModule": { "filename": "lib/parameter-group.ts", "line": 85 }, "name": "parameters", "optional": true, "type": { "collection": { "elementtype": { "primitive": "string" }, "kind": "map" } } } ], "symbolId": "lib/parameter-group:ParameterGroupProps" }, "@aws-cdk/aws-rds.PerformanceInsightRetention": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The retention period for Performance Insight." }, "fqn": "@aws-cdk/aws-rds.PerformanceInsightRetention", "kind": "enum", "locationInModule": { "filename": "lib/props.ts", "line": 527 }, "members": [ { "docs": { "stability": "stable", "summary": "Default retention period of 7 days." }, "name": "DEFAULT" }, { "docs": { "stability": "stable", "summary": "Long term retention period of 2 years." }, "name": "LONG_TERM" } ], "name": "PerformanceInsightRetention", "symbolId": "lib/props:PerformanceInsightRetention" }, "@aws-cdk/aws-rds.PostgresEngineFeatures": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Features supported by the Postgres database engine.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst postgresEngineFeatures: rds.PostgresEngineFeatures = {\n s3Export: false,\n s3Import: false,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.PostgresEngineFeatures", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 585 }, "name": "PostgresEngineFeatures", "properties": [ { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this version of the Postgres engine supports the S3 data export feature." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 598 }, "name": "s3Export", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether this version of the Postgres engine supports the S3 data import feature." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 591 }, "name": "s3Import", "optional": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/instance-engine:PostgresEngineFeatures" }, "@aws-cdk/aws-rds.PostgresEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the PostgreSQL instance engines (those returned by {@link DatabaseInstanceEngine.postgres}).", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstance(this, 'InstanceWithCustomizedSecret', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres', {\n secretName: 'my-cool-name',\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 605 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new PostgresEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 939 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"13.11\"." }, "name": "postgresFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"13\"." }, "name": "postgresMajorVersion", "type": { "primitive": "string" } }, { "name": "postgresFeatures", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineFeatures" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, "static": true } ], "name": "PostgresEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"10\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 819 }, "name": "VER_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 821 }, "name": "VER_10_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 835 }, "name": "VER_10_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 837 }, "name": "VER_10_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 839 }, "name": "VER_10_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 841 }, "name": "VER_10_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 843 }, "name": "VER_10_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 845 }, "name": "VER_10_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 847 }, "name": "VER_10_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 849 }, "name": "VER_10_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 851 }, "name": "VER_10_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 853 }, "name": "VER_10_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 855 }, "name": "VER_10_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 823 }, "name": "VER_10_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 825 }, "name": "VER_10_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 827 }, "name": "VER_10_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 829 }, "name": "VER_10_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 831 }, "name": "VER_10_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"10.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 833 }, "name": "VER_10_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 858 }, "name": "VER_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 860 }, "name": "VER_11_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 876 }, "name": "VER_11_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 878 }, "name": "VER_11_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 880 }, "name": "VER_11_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 882 }, "name": "VER_11_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 884 }, "name": "VER_11_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 886 }, "name": "VER_11_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 862 }, "name": "VER_11_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 864 }, "name": "VER_11_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 866 }, "name": "VER_11_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 868 }, "name": "VER_11_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 870 }, "name": "VER_11_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 872 }, "name": "VER_11_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 874 }, "name": "VER_11_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 889 }, "name": "VER_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 907 }, "name": "VER_12_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 891 }, "name": "VER_12_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 893 }, "name": "VER_12_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 895 }, "name": "VER_12_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 897 }, "name": "VER_12_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 899 }, "name": "VER_12_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 901 }, "name": "VER_12_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 903 }, "name": "VER_12_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 905 }, "name": "VER_12_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 910 }, "name": "VER_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 912 }, "name": "VER_13_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 914 }, "name": "VER_13_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 916 }, "name": "VER_13_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 918 }, "name": "VER_13_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 920 }, "name": "VER_13_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 922 }, "name": "VER_13_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 925 }, "name": "VER_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 927 }, "name": "VER_14_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 929 }, "name": "VER_14_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 610 }, "name": "VER_9_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 640 }, "name": "VER_9_5_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 645 }, "name": "VER_9_5_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 650 }, "name": "VER_9_5_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 655 }, "name": "VER_9_5_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 660 }, "name": "VER_9_5_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 665 }, "name": "VER_9_5_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 670 }, "name": "VER_9_5_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 675 }, "name": "VER_9_5_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 615 }, "name": "VER_9_5_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 680 }, "name": "VER_9_5_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 685 }, "name": "VER_9_5_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 690 }, "name": "VER_9_5_22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 695 }, "name": "VER_9_5_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 700 }, "name": "VER_9_5_24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.25\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 705 }, "name": "VER_9_5_25", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.4\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 620 }, "name": "VER_9_5_4", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 625 }, "name": "VER_9_5_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.7\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 630 }, "name": "VER_9_5_7", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.5 will reach end of life on February 16, 2021", "stability": "deprecated", "summary": "Version \"9.5.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 635 }, "name": "VER_9_5_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 711 }, "name": "VER_9_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 716 }, "name": "VER_9_6_1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.10\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 751 }, "name": "VER_9_6_10", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 756 }, "name": "VER_9_6_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.12\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 761 }, "name": "VER_9_6_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.14\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 766 }, "name": "VER_9_6_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.15\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 771 }, "name": "VER_9_6_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.16\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 776 }, "name": "VER_9_6_16", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.17\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 781 }, "name": "VER_9_6_17", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.18\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 786 }, "name": "VER_9_6_18", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.19\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 791 }, "name": "VER_9_6_19", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.2\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 721 }, "name": "VER_9_6_2", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.20\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 796 }, "name": "VER_9_6_20", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.21\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 801 }, "name": "VER_9_6_21", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.22\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 806 }, "name": "VER_9_6_22", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.23\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 811 }, "name": "VER_9_6_23", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.24\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 816 }, "name": "VER_9_6_24", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.3\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 726 }, "name": "VER_9_6_3", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.5\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 731 }, "name": "VER_9_6_5", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.6\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 736 }, "name": "VER_9_6_6", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.8\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 741 }, "name": "VER_9_6_8", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "const": true, "docs": { "deprecated": "PostgreSQL 9.6 will reach end of life in November 2021", "stability": "deprecated", "summary": "Version \"9.6.9\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 746 }, "name": "VER_9_6_9", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"13.11\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 944 }, "name": "postgresFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"13\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 946 }, "name": "postgresMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:PostgresEngineVersion" }, "@aws-cdk/aws-rds.PostgresInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.postgres}.", "stability": "stable", "summary": "Properties for PostgreSQL instance engines.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstance(this, 'InstanceWithCustomizedSecret', {\n engine,\n vpc,\n credentials: rds.Credentials.fromGeneratedSecret('postgres', {\n secretName: 'my-cool-name',\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.PostgresInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 968 }, "name": "PostgresInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 970 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.PostgresEngineVersion" } } ], "symbolId": "lib/instance-engine:PostgresInstanceEngineProps" }, "@aws-cdk/aws-rds.ProcessorFeatures": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The processor features.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst processorFeatures: rds.ProcessorFeatures = {\n coreCount: 123,\n threadsPerCore: 123,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ProcessorFeatures", "kind": "interface", "locationInModule": { "filename": "lib/instance.ts", "line": 241 }, "name": "ProcessorFeatures", "properties": [ { "abstract": true, "docs": { "default": "- the default number of CPU cores for the chosen instance class.", "stability": "stable", "summary": "The number of CPU core." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 247 }, "name": "coreCount", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- the default number of threads per core for the chosen instance class.", "stability": "stable", "summary": "The number of threads per core." }, "immutable": true, "locationInModule": { "filename": "lib/instance.ts", "line": 254 }, "name": "threadsPerCore", "optional": true, "type": { "primitive": "number" } } ], "symbolId": "lib/instance:ProcessorFeatures" }, "@aws-cdk/aws-rds.ProxyTarget": { "assembly": "@aws-cdk/aws-rds", "docs": { "remarks": "A target group is a collection of databases that the proxy can connect to.\nCurrently, you can specify only one RDS DB instance or Aurora DB cluster.", "stability": "stable", "summary": "Proxy target: Instance or Cluster.", "example": "declare const vpc: ec2.Vpc;\nconst cluster = new rds.DatabaseCluster(this, 'Database', {\n engine: rds.DatabaseClusterEngine.AURORA,\n instanceProps: { vpc },\n});\n\nconst proxy = new rds.DatabaseProxy(this, 'Proxy', {\n proxyTarget: rds.ProxyTarget.fromCluster(cluster),\n secrets: [cluster.secret!],\n vpc,\n});\n\nconst role = new iam.Role(this, 'DBProxyRole', { assumedBy: new iam.AccountPrincipal(this.account) });\nproxy.grantConnect(role, 'admin'); // Grant the role connection access to the DB Proxy for database user 'admin'.", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.ProxyTarget", "kind": "class", "locationInModule": { "filename": "lib/proxy.ts", "line": 46 }, "methods": [ { "docs": { "stability": "stable", "summary": "From cluster." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 61 }, "name": "fromCluster", "parameters": [ { "docs": { "summary": "RDS database cluster." }, "name": "cluster", "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseCluster" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ProxyTarget" } }, "static": true }, { "docs": { "stability": "stable", "summary": "From instance." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 52 }, "name": "fromInstance", "parameters": [ { "docs": { "summary": "RDS database instance." }, "name": "instance", "type": { "fqn": "@aws-cdk/aws-rds.IDatabaseInstance" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ProxyTarget" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Bind this target to the specified database proxy." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 73 }, "name": "bind", "parameters": [ { "name": "proxy", "type": { "fqn": "@aws-cdk/aws-rds.DatabaseProxy" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ProxyTargetConfig" } } } ], "name": "ProxyTarget", "symbolId": "lib/proxy:ProxyTarget" }, "@aws-cdk/aws-rds.ProxyTargetConfig": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "The result of binding a `ProxyTarget` to a `DatabaseProxy`.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const databaseCluster: rds.DatabaseCluster;\ndeclare const databaseInstance: rds.DatabaseInstance;\nconst proxyTargetConfig: rds.ProxyTargetConfig = {\n engineFamily: 'engineFamily',\n\n // the properties below are optional\n dbClusters: [databaseCluster],\n dbInstances: [databaseInstance],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ProxyTargetConfig", "kind": "interface", "locationInModule": { "filename": "lib/proxy.ts", "line": 102 }, "name": "ProxyTargetConfig", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The engine family of the database instance or cluster this proxy connects with." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 106 }, "name": "engineFamily", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- `undefined` if `dbInstances` is set.", "remarks": "Either this or `dbInstances` will be set and the other `undefined`.", "stability": "stable", "summary": "The database clusters to which this proxy connects." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 120 }, "name": "dbClusters", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.IDatabaseCluster" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- `undefined` if `dbClusters` is set.", "remarks": "Either this or `dbClusters` will be set and the other `undefined`.", "stability": "stable", "summary": "The database instances to which this proxy connects." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 113 }, "name": "dbInstances", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-rds.IDatabaseInstance" }, "kind": "array" } } } ], "symbolId": "lib/proxy:ProxyTargetConfig" }, "@aws-cdk/aws-rds.RotationMultiUserOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options to add the multi user rotation.", "example": "declare const instance: rds.DatabaseInstance;\ndeclare const myImportedSecret: rds.DatabaseSecret;\ninstance.addRotationMultiUser('MyUser', {\n secret: myImportedSecret, // This secret must have the `masterarn` key\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions", "interfaces": [ "@aws-cdk/aws-rds.CommonRotationUserOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 506 }, "name": "RotationMultiUserOptions", "properties": [ { "abstract": true, "docs": { "remarks": "It must be a JSON string with the following format:\n```\n{\n \"engine\": ,\n \"host\": ,\n \"username\": ,\n \"password\": ,\n \"dbname\": ,\n \"port\": ,\n \"masterarn\": \n}\n```", "stability": "stable", "summary": "The secret to rotate." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 521 }, "name": "secret", "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } } ], "symbolId": "lib/props:RotationMultiUserOptions" }, "@aws-cdk/aws-rds.RotationSingleUserOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options to add the multi user rotation.", "example": "import * as cdk from '@aws-cdk/core';\n\ndeclare const instance: rds.DatabaseInstance;\ninstance.addRotationSingleUser({\n automaticallyAfter: cdk.Duration.days(7), // defaults to 30 days\n excludeCharacters: '!@#$%^&*', // defaults to the set \" %+~`#$&*()|[]{}:;<>?!'/@\\\"\\\\\"\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions", "interfaces": [ "@aws-cdk/aws-rds.CommonRotationUserOptions" ], "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 500 }, "name": "RotationSingleUserOptions", "symbolId": "lib/props:RotationSingleUserOptions" }, "@aws-cdk/aws-rds.ServerlessCluster": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::RDS::DBCluster", "exampleMetadata": "infused" }, "stability": "stable", "summary": "Create an Aurora Serverless Cluster.", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc, // this parameter is optional for serverless Clusters\n enableDataApi: true, // Optional - will be automatically set if you call grantDataApiAccess()\n});\n\ndeclare const code: lambda.Code;\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code,\n environment: {\n CLUSTER_ARN: cluster.clusterArn,\n SECRET_ARN: cluster.secret!.secretArn,\n },\n});\ncluster.grantDataApiAccess(fn);" }, "fqn": "@aws-cdk/aws-rds.ServerlessCluster", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 507 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.ServerlessClusterProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IServerlessCluster" ], "kind": "class", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 484 }, "methods": [ { "docs": { "stability": "stable", "summary": "Import an existing DatabaseCluster from properties." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 488 }, "name": "fromServerlessClusterAttributes", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "attrs", "type": { "fqn": "@aws-cdk/aws-rds.ServerlessClusterAttributes" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.IServerlessCluster" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Adds the multi user rotation to this cluster." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 572 }, "name": "addRotationMultiUser", "parameters": [ { "name": "id", "type": { "primitive": "string" } }, { "name": "options", "type": { "fqn": "@aws-cdk/aws-rds.RotationMultiUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Adds the single user rotation of the master password to this cluster." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 545 }, "name": "addRotationSingleUser", "parameters": [ { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.RotationSingleUserOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretRotation" } } }, { "docs": { "stability": "stable", "summary": "Renders the secret attachment target specifications." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 337 }, "name": "asSecretAttachmentTarget", "overrides": "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretAttachmentTargetProps" } } }, { "docs": { "stability": "stable", "summary": "Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 318 }, "name": "grantDataApiAccess", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "ServerlessCluster", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 304 }, "name": "clusterArn", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 496 }, "name": "clusterEndpoint", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 495 }, "name": "clusterIdentifier", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 497 }, "name": "clusterReadEndpoint", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Access to the network connections." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 351 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 352 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 353 }, "name": "securityGroups", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The secret attached to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 499 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 354 }, "name": "enableDataApi", "optional": true, "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/serverless-cluster:ServerlessCluster" }, "@aws-cdk/aws-rds.ServerlessClusterAttributes": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties that describe an existing cluster instance.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as secretsmanager from '@aws-cdk/aws-secretsmanager';\n\ndeclare const secret: secretsmanager.Secret;\ndeclare const securityGroup: ec2.SecurityGroup;\nconst serverlessClusterAttributes: rds.ServerlessClusterAttributes = {\n clusterIdentifier: 'clusterIdentifier',\n\n // the properties below are optional\n clusterEndpointAddress: 'clusterEndpointAddress',\n port: 123,\n readerEndpointAddress: 'readerEndpointAddress',\n secret: secret,\n securityGroups: [securityGroup],\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.ServerlessClusterAttributes", "kind": "interface", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 160 }, "name": "ServerlessClusterAttributes", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 164 }, "name": "clusterIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no endpoint address", "stability": "stable", "summary": "Cluster endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 185 }, "name": "clusterEndpointAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "The database port." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 171 }, "name": "port", "optional": true, "type": { "primitive": "number" } }, { "abstract": true, "docs": { "default": "- no reader address", "stability": "stable", "summary": "Reader endpoint address." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 192 }, "name": "readerEndpointAddress", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- no secret", "stability": "stable", "summary": "The secret attached to the database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 199 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "abstract": true, "docs": { "default": "- no security groups", "stability": "stable", "summary": "The security groups of the database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 178 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } } ], "symbolId": "lib/serverless-cluster:ServerlessClusterAttributes" }, "@aws-cdk/aws-rds.ServerlessClusterFromSnapshot": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::RDS::DBCluster", "exampleMetadata": "infused" }, "stability": "stable", "summary": "A Aurora Serverless Cluster restored from a snapshot.", "example": "declare const vpc: ec2.Vpc;\nnew rds.ServerlessClusterFromSnapshot(this, 'Cluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n});" }, "fqn": "@aws-cdk/aws-rds.ServerlessClusterFromSnapshot", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 671 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.ServerlessClusterFromSnapshotProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.IServerlessCluster" ], "kind": "class", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 665 }, "methods": [ { "docs": { "stability": "stable", "summary": "Renders the secret attachment target specifications." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 337 }, "name": "asSecretAttachmentTarget", "overrides": "@aws-cdk/aws-secretsmanager.ISecretAttachmentTarget", "returns": { "type": { "fqn": "@aws-cdk/aws-secretsmanager.SecretAttachmentTargetProps" } } }, { "docs": { "stability": "stable", "summary": "Grant the given identity to access to the Data API, including read access to the secret attached to the cluster if present." }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 318 }, "name": "grantDataApiAccess", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "parameters": [ { "docs": { "summary": "The principal to grant access to." }, "name": "grantee", "type": { "fqn": "@aws-cdk/aws-iam.IGrantable" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-iam.Grant" } } } ], "name": "ServerlessClusterFromSnapshot", "properties": [ { "docs": { "stability": "stable", "summary": "The ARN of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 304 }, "name": "clusterArn", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 667 }, "name": "clusterEndpoint", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Identifier of the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 666 }, "name": "clusterIdentifier", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The endpoint to use for read/write operations." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 668 }, "name": "clusterReadEndpoint", "overrides": "@aws-cdk/aws-rds.IServerlessCluster", "type": { "fqn": "@aws-cdk/aws-rds.Endpoint" } }, { "docs": { "stability": "stable", "summary": "Access to the network connections." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 351 }, "name": "connections", "overrides": "@aws-cdk/aws-ec2.IConnectable", "type": { "fqn": "@aws-cdk/aws-ec2.Connections" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 352 }, "name": "newCfnProps", "protected": true, "type": { "fqn": "@aws-cdk/aws-rds.CfnDBClusterProps" } }, { "docs": { "stability": "stable" }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 353 }, "name": "securityGroups", "protected": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "docs": { "stability": "stable", "summary": "The secret attached to this cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 669 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 354 }, "name": "enableDataApi", "optional": true, "protected": true, "type": { "primitive": "boolean" } } ], "symbolId": "lib/serverless-cluster:ServerlessClusterFromSnapshot" }, "@aws-cdk/aws-rds.ServerlessClusterFromSnapshotProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for ``ServerlessClusterFromSnapshot``.", "example": "declare const vpc: ec2.Vpc;\nnew rds.ServerlessClusterFromSnapshot(this, 'Cluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.ServerlessClusterFromSnapshotProps", "kind": "interface", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 641 }, "name": "ServerlessClusterFromSnapshotProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "What kind of database to start." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 59 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "abstract": true, "docs": { "remarks": "You can use either the name or the Amazon Resource Name (ARN) to specify a DB cluster snapshot.\nHowever, you can use only the ARN to specify a DB instance snapshot.", "stability": "stable", "summary": "The identifier for the DB instance snapshot or DB cluster snapshot to restore from." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 647 }, "name": "snapshotIdentifier", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "Duration.days(1)", "remarks": "Automatic backup retention cannot be disabled on serverless clusters.\nMust be a value from 1 day to 35 days.", "stability": "stable", "summary": "The number of days during which automatic DB snapshots are retained." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 75 }, "name": "backupRetention", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A name is automatically generated.", "stability": "stable", "summary": "An optional identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 66 }, "name": "clusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- The existing username and password from the snapshot will be used.", "remarks": "Note - It is not possible to change the master username for a snapshot;\nhowever, it is possible to provide (or generate) a new password.", "stability": "stable", "summary": "Master user credentials." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 657 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } }, { "abstract": true, "docs": { "default": "- Database is not created in cluster.", "stability": "stable", "summary": "Name of a database which is automatically created inside the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 82 }, "name": "defaultDatabaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if removalPolicy is RETAIN, false otherwise", "stability": "stable", "summary": "Indicates whether the DB cluster should have deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 89 }, "name": "deletionProtection", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html", "stability": "stable", "summary": "Whether to enable the Data API." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 98 }, "name": "enableDataApi", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no parameter group.", "stability": "stable", "summary": "Additional parameters to pass to the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 145 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)", "stability": "stable", "summary": "The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 130 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- Serverless cluster is automatically paused after 5 minutes of being idle.\nminimum capacity: 2 ACU\nmaximum capacity: 16 ACU", "stability": "stable", "summary": "Scaling configuration of an Aurora Serverless database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 122 }, "name": "scaling", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ServerlessScalingOptions" } }, { "abstract": true, "docs": { "default": "- a new security group is created if `vpc` was provided.\nIf the `vpc` property was not provided, no VPC security groups will be associated with the DB cluster.", "stability": "stable", "summary": "Security group." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 138 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- a new subnet group is created if `vpc` was provided.\nIf the `vpc` property was not provided, no subnet group will be associated with the DB cluster", "stability": "stable", "summary": "Existing subnet group for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 153 }, "name": "subnetGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, { "abstract": true, "docs": { "default": "- the default VPC in the account and region will be used", "stability": "stable", "summary": "The VPC that this Aurora Serverless cluster has been created in." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 105 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- the VPC default strategy if not specified.", "remarks": "If provided, the `vpc` property must also be specified.", "stability": "stable", "summary": "Where to place the instances within the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 113 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/serverless-cluster:ServerlessClusterFromSnapshotProps" }, "@aws-cdk/aws-rds.ServerlessClusterProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for a new Aurora Serverless Cluster.", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_MYSQL,\n vpc, // this parameter is optional for serverless Clusters\n enableDataApi: true, // Optional - will be automatically set if you call grantDataApiAccess()\n});\n\ndeclare const code: lambda.Code;\nconst fn = new lambda.Function(this, 'MyFunction', {\n runtime: lambda.Runtime.NODEJS_14_X,\n handler: 'index.handler',\n code,\n environment: {\n CLUSTER_ARN: cluster.clusterArn,\n SECRET_ARN: cluster.secret!.secretArn,\n },\n});\ncluster.grantDataApiAccess(fn);", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.ServerlessClusterProps", "kind": "interface", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 462 }, "name": "ServerlessClusterProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "What kind of database to start." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 59 }, "name": "engine", "type": { "fqn": "@aws-cdk/aws-rds.IClusterEngine" } }, { "abstract": true, "docs": { "default": "Duration.days(1)", "remarks": "Automatic backup retention cannot be disabled on serverless clusters.\nMust be a value from 1 day to 35 days.", "stability": "stable", "summary": "The number of days during which automatic DB snapshots are retained." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 75 }, "name": "backupRetention", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- A name is automatically generated.", "stability": "stable", "summary": "An optional identifier for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 66 }, "name": "clusterIdentifier", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- A username of 'admin' and SecretsManager-generated password", "stability": "stable", "summary": "Credentials for the administrative user." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 468 }, "name": "credentials", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.Credentials" } }, { "abstract": true, "docs": { "default": "- Database is not created in cluster.", "stability": "stable", "summary": "Name of a database which is automatically created inside the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 82 }, "name": "defaultDatabaseName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- true if removalPolicy is RETAIN, false otherwise", "stability": "stable", "summary": "Indicates whether the DB cluster should have deletion protection enabled." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 89 }, "name": "deletionProtection", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "false", "see": "https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html", "stability": "stable", "summary": "Whether to enable the Data API." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 98 }, "name": "enableDataApi", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- no parameter group.", "stability": "stable", "summary": "Additional parameters to pass to the database engine." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 145 }, "name": "parameterGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.IParameterGroup" } }, { "abstract": true, "docs": { "default": "- RemovalPolicy.SNAPSHOT (remove the cluster and instances, but retain a snapshot of the data)", "stability": "stable", "summary": "The removal policy to apply when the cluster and its instances are removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 130 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- Serverless cluster is automatically paused after 5 minutes of being idle.\nminimum capacity: 2 ACU\nmaximum capacity: 16 ACU", "stability": "stable", "summary": "Scaling configuration of an Aurora Serverless database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 122 }, "name": "scaling", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ServerlessScalingOptions" } }, { "abstract": true, "docs": { "default": "- a new security group is created if `vpc` was provided.\nIf the `vpc` property was not provided, no VPC security groups will be associated with the DB cluster.", "stability": "stable", "summary": "Security group." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 138 }, "name": "securityGroups", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-ec2.ISecurityGroup" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- the default master key will be used for storage encryption", "stability": "stable", "summary": "The KMS key for storage encryption." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 475 }, "name": "storageEncryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "default": "- a new subnet group is created if `vpc` was provided.\nIf the `vpc` property was not provided, no subnet group will be associated with the DB cluster", "stability": "stable", "summary": "Existing subnet group for the cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 153 }, "name": "subnetGroup", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, { "abstract": true, "docs": { "default": "- the default VPC in the account and region will be used", "stability": "stable", "summary": "The VPC that this Aurora Serverless cluster has been created in." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 105 }, "name": "vpc", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "- the VPC default strategy if not specified.", "remarks": "If provided, the `vpc` property must also be specified.", "stability": "stable", "summary": "Where to place the instances within the VPC." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 113 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/serverless-cluster:ServerlessClusterProps" }, "@aws-cdk/aws-rds.ServerlessScalingOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options for configuring scaling on an Aurora Serverless cluster.", "example": "declare const vpc: ec2.Vpc;\n\nconst cluster = new rds.ServerlessCluster(this, 'AnotherCluster', {\n engine: rds.DatabaseClusterEngine.AURORA_POSTGRESQL,\n parameterGroup: rds.ParameterGroup.fromParameterGroupName(this, 'ParameterGroup', 'default.aurora-postgresql10'),\n vpc,\n scaling: {\n autoPause: Duration.minutes(10), // default is to pause after 5 minutes of idle time\n minCapacity: rds.AuroraCapacityUnit.ACU_8, // default is 2 Aurora capacity units (ACUs)\n maxCapacity: rds.AuroraCapacityUnit.ACU_32, // default is 16 Aurora capacity units (ACUs)\n }\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.ServerlessScalingOptions", "kind": "interface", "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 239 }, "name": "ServerlessScalingOptions", "properties": [ { "abstract": true, "docs": { "default": "- automatic pause enabled after 5 minutes", "remarks": "A database cluster can be paused only when it is idle (it has no connections).\nAuto pause time must be between 5 minutes and 1 day.\n\nIf a DB cluster is paused for more than seven days, the DB cluster might be\nbacked up with a snapshot. In this case, the DB cluster is restored when there\nis a request to connect to it.\n\nSet to 0 to disable", "stability": "stable", "summary": "The time before an Aurora Serverless database cluster is paused." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 267 }, "name": "autoPause", "optional": true, "type": { "fqn": "@aws-cdk/core.Duration" } }, { "abstract": true, "docs": { "default": "- determined by Aurora based on database engine", "stability": "stable", "summary": "The maximum capacity for an Aurora Serverless database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 252 }, "name": "maxCapacity", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraCapacityUnit" } }, { "abstract": true, "docs": { "default": "- determined by Aurora based on database engine", "stability": "stable", "summary": "The minimum capacity for an Aurora Serverless database cluster." }, "immutable": true, "locationInModule": { "filename": "lib/serverless-cluster.ts", "line": 245 }, "name": "minCapacity", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.AuroraCapacityUnit" } } ], "symbolId": "lib/serverless-cluster:ServerlessScalingOptions" }, "@aws-cdk/aws-rds.SessionPinningFilter": { "assembly": "@aws-cdk/aws-rds", "docs": { "see": "https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-proxy.html#rds-proxy-pinning", "stability": "stable", "summary": "SessionPinningFilter.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\nconst sessionPinningFilter = rds.SessionPinningFilter.of('filterName');", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.SessionPinningFilter", "kind": "class", "locationInModule": { "filename": "lib/proxy.ts", "line": 17 }, "methods": [ { "docs": { "stability": "stable", "summary": "custom filter." }, "locationInModule": { "filename": "lib/proxy.ts", "line": 28 }, "name": "of", "parameters": [ { "name": "filterName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SessionPinningFilter" } }, "static": true } ], "name": "SessionPinningFilter", "properties": [ { "const": true, "docs": { "remarks": "- Setting session variables and configuration settings.", "stability": "stable", "summary": "You can opt out of session pinning for the following kinds of application statements:." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 23 }, "name": "EXCLUDE_VARIABLE_SETS", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SessionPinningFilter" } }, { "docs": { "stability": "stable", "summary": "Filter name." }, "immutable": true, "locationInModule": { "filename": "lib/proxy.ts", "line": 36 }, "name": "filterName", "type": { "primitive": "string" } } ], "symbolId": "lib/proxy:SessionPinningFilter" }, "@aws-cdk/aws-rds.SnapshotCredentials": { "abstract": true, "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "Credentials to update the password for a ``DatabaseInstanceFromSnapshot``.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstanceFromSnapshot(this, 'InstanceFromSnapshotWithCustomizedSecret', {\n engine,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n credentials: rds.SnapshotCredentials.fromGeneratedSecret('username', {\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.SnapshotCredentials", "initializer": { "docs": { "stability": "stable" } }, "kind": "class", "locationInModule": { "filename": "lib/props.ts", "line": 338 }, "methods": [ { "docs": { "remarks": "Note - The username must match the existing master username of the snapshot.\n\nNOTE: use `fromGeneratedSecret()` for new Clusters and Instances. Switching from\n`fromGeneratedPassword()` to `fromGeneratedSecret()` for already deployed Clusters\nor Instances will update their master password.", "stability": "stable", "summary": "Generate a new password for the snapshot, using the existing username and an optional encryption key." }, "locationInModule": { "filename": "lib/props.ts", "line": 363 }, "name": "fromGeneratedPassword", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentialsFromGeneratedPasswordOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } }, "static": true }, { "docs": { "remarks": "The new credentials are stored in Secrets Manager.\n\nNote - The username must match the existing master username of the snapshot.", "stability": "stable", "summary": "Generate a new password for the snapshot, using the existing username and an optional encryption key." }, "locationInModule": { "filename": "lib/props.ts", "line": 345 }, "name": "fromGeneratedSecret", "parameters": [ { "name": "username", "type": { "primitive": "string" } }, { "name": "options", "optional": true, "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentialsFromGeneratedPasswordOptions" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } }, "static": true }, { "docs": { "stability": "stable", "summary": "Update the snapshot login with an existing password." }, "locationInModule": { "filename": "lib/props.ts", "line": 374 }, "name": "fromPassword", "parameters": [ { "name": "password", "type": { "fqn": "@aws-cdk/core.SecretValue" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } }, "static": true }, { "docs": { "remarks": "The Secret must be a JSON string with a ``password`` field:\n```\n{\n ...\n \"password\": ,\n}\n```", "stability": "stable", "summary": "Update the snapshot login with an existing password from a Secret." }, "locationInModule": { "filename": "lib/props.ts", "line": 389 }, "name": "fromSecret", "parameters": [ { "name": "secret", "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SnapshotCredentials" } }, "static": true } ], "name": "SnapshotCredentials", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Whether a new password should be generated." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 410 }, "name": "generatePassword", "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "KMS encryption key to encrypt the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 433 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\")" }, "default": "- the DatabaseSecret default exclude character set (\" %+~`#$&*()|[]{}:;<>?!'/", "remarks": "Only used if {@link generatePassword} if true.", "stability": "stable", "summary": "The characters to exclude from the generated password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 448 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- the existing password from the snapshot", "remarks": "Do not put passwords in your CDK code directly.", "stability": "stable", "summary": "The master user password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 426 }, "name": "password", "optional": true, "type": { "fqn": "@aws-cdk/core.SecretValue" } }, { "abstract": true, "docs": { "default": "false", "stability": "stable", "summary": "Whether to replace the generated secret when the criteria for the password change." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 417 }, "name": "replaceOnPasswordCriteriaChanges", "optional": true, "type": { "primitive": "boolean" } }, { "abstract": true, "docs": { "default": "- Secret is not replicated", "stability": "stable", "summary": "A list of regions where to replicate the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 455 }, "name": "replicaRegions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ReplicaRegion" }, "kind": "array" } } }, { "abstract": true, "docs": { "default": "- none", "stability": "stable", "summary": "Secret used to instantiate this Login." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 440 }, "name": "secret", "optional": true, "type": { "fqn": "@aws-cdk/aws-secretsmanager.ISecret" } }, { "abstract": true, "docs": { "default": "- the existing username from the snapshot", "remarks": "Must be the **current** master user name of the snapshot.\nIt is not possible to change the master user name of a RDS instance.", "stability": "stable", "summary": "The master user name." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 405 }, "name": "username", "optional": true, "type": { "primitive": "string" } } ], "symbolId": "lib/props:SnapshotCredentials" }, "@aws-cdk/aws-rds.SnapshotCredentialsFromGeneratedPasswordOptions": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Options used in the {@link SnapshotCredentials.fromGeneratedPassword} method.", "example": "declare const vpc: ec2.Vpc;\nconst engine = rds.DatabaseInstanceEngine.postgres({ version: rds.PostgresEngineVersion.VER_12_3 });\nconst myKey = new kms.Key(this, 'MyKey');\n\nnew rds.DatabaseInstanceFromSnapshot(this, 'InstanceFromSnapshotWithCustomizedSecret', {\n engine,\n vpc,\n snapshotIdentifier: 'mySnapshot',\n credentials: rds.SnapshotCredentials.fromGeneratedSecret('username', {\n encryptionKey: myKey,\n excludeCharacters: '!&*^#@()',\n replicaRegions: [{ region: 'eu-west-1' }, { region: 'eu-west-2' }],\n }),\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.SnapshotCredentialsFromGeneratedPasswordOptions", "kind": "interface", "locationInModule": { "filename": "lib/props.ts", "line": 312 }, "name": "SnapshotCredentialsFromGeneratedPasswordOptions", "properties": [ { "abstract": true, "docs": { "default": "- default master key", "stability": "stable", "summary": "KMS encryption key to encrypt the generated secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 318 }, "name": "encryptionKey", "optional": true, "type": { "fqn": "@aws-cdk/aws-kms.IKey" } }, { "abstract": true, "docs": { "custom": { "": "\\\"\\\\\")" }, "default": "- the DatabaseSecret default exclude character set (\" %+~`#$&*()|[]{}:;<>?!'/", "stability": "stable", "summary": "The characters to exclude from the generated password." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 325 }, "name": "excludeCharacters", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- Secret is not replicated", "stability": "stable", "summary": "A list of regions where to replicate this secret." }, "immutable": true, "locationInModule": { "filename": "lib/props.ts", "line": 332 }, "name": "replicaRegions", "optional": true, "type": { "collection": { "elementtype": { "fqn": "@aws-cdk/aws-secretsmanager.ReplicaRegion" }, "kind": "array" } } } ], "symbolId": "lib/props:SnapshotCredentialsFromGeneratedPasswordOptions" }, "@aws-cdk/aws-rds.SqlServerEeInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.sqlServerEe}.", "stability": "stable", "summary": "Properties for SQL Server Enterprise Edition instance engines.", "example": "declare const vpc: ec2.Vpc;\n\nconst parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.sqlServerEe({\n version: rds.SqlServerEngineVersion.VER_11,\n }),\n parameters: {\n locks: '100',\n },\n});\n\nnew rds.DatabaseInstance(this, 'Database', {\n engine: rds.DatabaseInstanceEngine.SQL_SERVER_EE,\n vpc,\n parameterGroup,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.SqlServerEeInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1604 }, "name": "SqlServerEeInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1486 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } } ], "symbolId": "lib/instance-engine:SqlServerEeInstanceEngineProps" }, "@aws-cdk/aws-rds.SqlServerEngineVersion": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The versions for the SQL Server instance engines (those returned by {@link DatabaseInstanceEngine.sqlServerSe}, {@link DatabaseInstanceEngine.sqlServerEx}, {@link DatabaseInstanceEngine.sqlServerWeb} and {@link DatabaseInstanceEngine.sqlServerEe}).", "example": "declare const vpc: ec2.Vpc;\n\nconst parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.sqlServerEe({\n version: rds.SqlServerEngineVersion.VER_11,\n }),\n parameters: {\n locks: '100',\n },\n});\n\nnew rds.DatabaseInstance(this, 'Database', {\n engine: rds.DatabaseInstanceEngine.SQL_SERVER_EE,\n vpc,\n parameterGroup,\n});", "custom": { "exampleMetadata": "infused" } }, "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion", "kind": "class", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1367 }, "methods": [ { "docs": { "stability": "stable", "summary": "Create a new SqlServerEngineVersion with an arbitrary version." }, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1469 }, "name": "of", "parameters": [ { "docs": { "summary": "the full version string, for example \"15.00.3049.1.v1\"." }, "name": "sqlServerFullVersion", "type": { "primitive": "string" } }, { "docs": { "summary": "the major version of the engine, for example \"15.00\"." }, "name": "sqlServerMajorVersion", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, "static": true } ], "name": "SqlServerEngineVersion", "properties": [ { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1369 }, "name": "VER_11", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00.5058.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1371 }, "name": "VER_11_00_5058_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00.6020.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1373 }, "name": "VER_11_00_6020_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00.6594.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1375 }, "name": "VER_11_00_6594_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00.7462.6.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1377 }, "name": "VER_11_00_7462_6_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"11.00.7493.4.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1379 }, "name": "VER_11_00_7493_4_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1382 }, "name": "VER_12", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00.5000.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1384 }, "name": "VER_12_00_5000_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00.5546.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1386 }, "name": "VER_12_00_5546_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00.5571.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1388 }, "name": "VER_12_00_5571_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00.6293.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1390 }, "name": "VER_12_00_6293_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"12.00.6329.1.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1392 }, "name": "VER_12_00_6329_1_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1395 }, "name": "VER_13", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.2164.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1397 }, "name": "VER_13_00_2164_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.4422.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1399 }, "name": "VER_13_00_4422_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.4451.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1401 }, "name": "VER_13_00_4451_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.4466.4.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1403 }, "name": "VER_13_00_4466_4_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.4522.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1405 }, "name": "VER_13_00_4522_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5216.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1407 }, "name": "VER_13_00_5216_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5292.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1409 }, "name": "VER_13_00_5292_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5366.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1411 }, "name": "VER_13_00_5366_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5426.0.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1413 }, "name": "VER_13_00_5426_0_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5598.27.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1415 }, "name": "VER_13_00_5598_27_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5820.21.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1417 }, "name": "VER_13_00_5820_21_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5850.14.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1419 }, "name": "VER_13_00_5850_14_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"13.00.5882.1.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1421 }, "name": "VER_13_00_5882_1_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1424 }, "name": "VER_14", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.1000.169.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1426 }, "name": "VER_14_00_1000_169_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3015.40.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1428 }, "name": "VER_14_00_3015_40_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3035.2.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1430 }, "name": "VER_14_00_3035_2_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3049.1.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1432 }, "name": "VER_14_00_3049_1_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "deprecated": "SQL Server version 14.00.3192.2.v1 reached end of life", "stability": "deprecated", "summary": "Version \"14.00.3192.2.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1437 }, "name": "VER_14_00_3192_2_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3223.3.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1439 }, "name": "VER_14_00_3223_3_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3281.6.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1441 }, "name": "VER_14_00_3281_6_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3294.2.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1443 }, "name": "VER_14_00_3294_2_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3356.20.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1445 }, "name": "VER_14_00_3356_20_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"14.00.3381.3.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1447 }, "name": "VER_14_00_3381_3_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"15.00\" (only a major version, without a specific minor version)." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1450 }, "name": "VER_15", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"15.00.4043.16.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1452 }, "name": "VER_15_00_4043_16_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "deprecated": "This version is erroneous. You might be looking for {@link SqlServerEngineVersion.VER_15_00_4073_23_V1}, instead.", "stability": "deprecated", "summary": "Version \"15.00.4043.23.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1457 }, "name": "VER_15_00_4043_23_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "const": true, "docs": { "stability": "stable", "summary": "Version \"15.00.4073.23.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1459 }, "name": "VER_15_00_4073_23_V1", "static": true, "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } }, { "docs": { "stability": "stable", "summary": "The full version string, for example, \"15.00.3049.1.v1\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1474 }, "name": "sqlServerFullVersion", "type": { "primitive": "string" } }, { "docs": { "stability": "stable", "summary": "The major version of the engine, for example, \"15.00\"." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1476 }, "name": "sqlServerMajorVersion", "type": { "primitive": "string" } } ], "symbolId": "lib/instance-engine:SqlServerEngineVersion" }, "@aws-cdk/aws-rds.SqlServerExInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.sqlServerEx}.", "stability": "stable", "summary": "Properties for SQL Server Express Edition instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const sqlServerEngineVersion: rds.SqlServerEngineVersion;\nconst sqlServerExInstanceEngineProps: rds.SqlServerExInstanceEngineProps = {\n version: sqlServerEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.SqlServerExInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1572 }, "name": "SqlServerExInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1486 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } } ], "symbolId": "lib/instance-engine:SqlServerExInstanceEngineProps" }, "@aws-cdk/aws-rds.SqlServerSeInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.sqlServerSe}.", "stability": "stable", "summary": "Properties for SQL Server Standard Edition instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const sqlServerEngineVersion: rds.SqlServerEngineVersion;\nconst sqlServerSeInstanceEngineProps: rds.SqlServerSeInstanceEngineProps = {\n version: sqlServerEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.SqlServerSeInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1556 }, "name": "SqlServerSeInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1486 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } } ], "symbolId": "lib/instance-engine:SqlServerSeInstanceEngineProps" }, "@aws-cdk/aws-rds.SqlServerWebInstanceEngineProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "remarks": "Used in {@link DatabaseInstanceEngine.sqlServerWeb}.", "stability": "stable", "summary": "Properties for SQL Server Web Edition instance engines.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as rds from '@aws-cdk/aws-rds';\n\ndeclare const sqlServerEngineVersion: rds.SqlServerEngineVersion;\nconst sqlServerWebInstanceEngineProps: rds.SqlServerWebInstanceEngineProps = {\n version: sqlServerEngineVersion,\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.SqlServerWebInstanceEngineProps", "kind": "interface", "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1588 }, "name": "SqlServerWebInstanceEngineProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "The exact version of the engine to use." }, "immutable": true, "locationInModule": { "filename": "lib/instance-engine.ts", "line": 1486 }, "name": "version", "type": { "fqn": "@aws-cdk/aws-rds.SqlServerEngineVersion" } } ], "symbolId": "lib/instance-engine:SqlServerWebInstanceEngineProps" }, "@aws-cdk/aws-rds.StorageType": { "assembly": "@aws-cdk/aws-rds", "docs": { "stability": "stable", "summary": "The type of storage.", "example": " // Set open cursors with parameter group\n const parameterGroup = new rds.ParameterGroup(this, 'ParameterGroup', {\n engine: rds.DatabaseInstanceEngine.oracleSe2({ version: rds.OracleEngineVersion.VER_19_0_0_0_2020_04_R1 }),\n parameters: {\n open_cursors: '2500',\n },\n });", "custom": { "exampleMetadata": "lit=test/integ.instance.lit.ts infused" } }, "fqn": "@aws-cdk/aws-rds.StorageType", "kind": "enum", "locationInModule": { "filename": "lib/instance.ts", "line": 260 }, "members": [ { "docs": { "stability": "stable", "summary": "Standard." }, "name": "STANDARD" }, { "docs": { "stability": "stable", "summary": "General purpose (SSD)." }, "name": "GP2" }, { "docs": { "stability": "stable", "summary": "Provisioned IOPS (SSD)." }, "name": "IO1" } ], "name": "StorageType", "symbolId": "lib/instance:StorageType" }, "@aws-cdk/aws-rds.SubnetGroup": { "assembly": "@aws-cdk/aws-rds", "base": "@aws-cdk/core.Resource", "docs": { "custom": { "resource": "AWS::RDS::DBSubnetGroup", "exampleMetadata": "fixture=_generated" }, "stability": "stable", "summary": "Class for creating a RDS DB subnet group.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\nconst subnetGroup = new rds.SubnetGroup(this, 'MySubnetGroup', {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n subnetGroupName: 'subnetGroupName',\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n});" }, "fqn": "@aws-cdk/aws-rds.SubnetGroup", "initializer": { "docs": { "stability": "stable" }, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 72 }, "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "props", "type": { "fqn": "@aws-cdk/aws-rds.SubnetGroupProps" } } ] }, "interfaces": [ "@aws-cdk/aws-rds.ISubnetGroup" ], "kind": "class", "locationInModule": { "filename": "lib/subnet-group.ts", "line": 59 }, "methods": [ { "docs": { "stability": "stable", "summary": "Imports an existing subnet group by name." }, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 64 }, "name": "fromSubnetGroupName", "parameters": [ { "name": "scope", "type": { "fqn": "constructs.Construct" } }, { "name": "id", "type": { "primitive": "string" } }, { "name": "subnetGroupName", "type": { "primitive": "string" } } ], "returns": { "type": { "fqn": "@aws-cdk/aws-rds.ISubnetGroup" } }, "static": true } ], "name": "SubnetGroup", "properties": [ { "docs": { "stability": "stable", "summary": "The name of the subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 70 }, "name": "subnetGroupName", "overrides": "@aws-cdk/aws-rds.ISubnetGroup", "type": { "primitive": "string" } } ], "symbolId": "lib/subnet-group:SubnetGroup" }, "@aws-cdk/aws-rds.SubnetGroupProps": { "assembly": "@aws-cdk/aws-rds", "datatype": true, "docs": { "stability": "stable", "summary": "Properties for creating a SubnetGroup.", "example": "// The code below shows an example of how to instantiate this type.\n// The values are placeholders you should change.\nimport * as ec2 from '@aws-cdk/aws-ec2';\nimport * as rds from '@aws-cdk/aws-rds';\nimport * as cdk from '@aws-cdk/core';\n\ndeclare const subnet: ec2.Subnet;\ndeclare const subnetFilter: ec2.SubnetFilter;\ndeclare const vpc: ec2.Vpc;\nconst subnetGroupProps: rds.SubnetGroupProps = {\n description: 'description',\n vpc: vpc,\n\n // the properties below are optional\n removalPolicy: cdk.RemovalPolicy.DESTROY,\n subnetGroupName: 'subnetGroupName',\n vpcSubnets: {\n availabilityZones: ['availabilityZones'],\n onePerAz: false,\n subnetFilters: [subnetFilter],\n subnetGroupName: 'subnetGroupName',\n subnetName: 'subnetName',\n subnets: [subnet],\n subnetType: ec2.SubnetType.ISOLATED,\n },\n};", "custom": { "exampleMetadata": "fixture=_generated" } }, "fqn": "@aws-cdk/aws-rds.SubnetGroupProps", "kind": "interface", "locationInModule": { "filename": "lib/subnet-group.ts", "line": 20 }, "name": "SubnetGroupProps", "properties": [ { "abstract": true, "docs": { "stability": "stable", "summary": "Description of the subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 24 }, "name": "description", "type": { "primitive": "string" } }, { "abstract": true, "docs": { "stability": "stable", "summary": "The VPC to place the subnet group in." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 29 }, "name": "vpc", "type": { "fqn": "@aws-cdk/aws-ec2.IVpc" } }, { "abstract": true, "docs": { "default": "RemovalPolicy.DESTROY", "stability": "stable", "summary": "The removal policy to apply when the subnet group are removed from the stack or replaced during an update." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 51 }, "name": "removalPolicy", "optional": true, "type": { "fqn": "@aws-cdk/core.RemovalPolicy" } }, { "abstract": true, "docs": { "default": "- a name is generated", "stability": "stable", "summary": "The name of the subnet group." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 36 }, "name": "subnetGroupName", "optional": true, "type": { "primitive": "string" } }, { "abstract": true, "docs": { "default": "- private subnets", "stability": "stable", "summary": "Which subnets within the VPC to associate with this group." }, "immutable": true, "locationInModule": { "filename": "lib/subnet-group.ts", "line": 43 }, "name": "vpcSubnets", "optional": true, "type": { "fqn": "@aws-cdk/aws-ec2.SubnetSelection" } } ], "symbolId": "lib/subnet-group:SubnetGroupProps" } }, "version": "1.204.0", "fingerprint": "**********" }