Interface ICfnDatabaseProps

Properties for defining a CfnDatabase.

Namespace: Amazon.CDK.AWS.Lightsail

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnDatabaseProps

Syntax (vb)

Public Interface ICfnDatabaseProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Lightsail;

             var cfnDatabaseProps = new CfnDatabaseProps {
                 MasterDatabaseName = "masterDatabaseName",
                 MasterUsername = "masterUsername",
                 RelationalDatabaseBlueprintId = "relationalDatabaseBlueprintId",
                 RelationalDatabaseBundleId = "relationalDatabaseBundleId",
                 RelationalDatabaseName = "relationalDatabaseName",

                 // the properties below are optional
                 AvailabilityZone = "availabilityZone",
                 BackupRetention = false,
                 CaCertificateIdentifier = "caCertificateIdentifier",
                 MasterUserPassword = "masterUserPassword",
                 PreferredBackupWindow = "preferredBackupWindow",
                 PreferredMaintenanceWindow = "preferredMaintenanceWindow",
                 PubliclyAccessible = false,
                 RelationalDatabaseParameters = new [] { new RelationalDatabaseParameterProperty {
                     AllowedValues = "allowedValues",
                     ApplyMethod = "applyMethod",
                     ApplyType = "applyType",
                     DataType = "dataType",
                     Description = "description",
                     IsModifiable = false,
                     ParameterName = "parameterName",
                     ParameterValue = "parameterValue"
                 } },
                 RotateMasterUserPassword = false,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Properties

AvailabilityZone	The Availability Zone for the database.
BackupRetention	A Boolean value indicating whether automated backup retention is enabled for the database.
CaCertificateIdentifier	The certificate associated with the database.
MasterDatabaseName	The meaning of this parameter differs according to the database engine you use.
MasterUserPassword	The password for the primary user of the database.
MasterUsername	The name for the primary user.
PreferredBackupWindow	The daily time range during which automated backups are created for the database (for example, `16:00-16:30` ).
PreferredMaintenanceWindow	The weekly time range during which system maintenance can occur for the database, formatted as follows: `ddd:hh24:mi-ddd:hh24:mi` .
PubliclyAccessible	A Boolean value indicating whether the database is accessible to anyone on the internet.
RelationalDatabaseBlueprintId	The blueprint ID for the database (for example, `mysql_8_0` ).
RelationalDatabaseBundleId	The bundle ID for the database (for example, `medium_1_0` ).
RelationalDatabaseName	The name of the instance.
RelationalDatabaseParameters	An array of parameters for the database.
RotateMasterUserPassword	A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
Tags	An array of key-value pairs to apply to this resource.

Properties

AvailabilityZone

The Availability Zone for the database.

string? AvailabilityZone { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-availabilityzone

BackupRetention

A Boolean value indicating whether automated backup retention is enabled for the database.

object? BackupRetention { get; }

Property Value

object

Remarks

Data Import Mode is enabled when BackupRetention is set to false , and is disabled when BackupRetention is set to true .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-backupretention

CaCertificateIdentifier

The certificate associated with the database.

string? CaCertificateIdentifier { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-cacertificateidentifier

MasterDatabaseName

The meaning of this parameter differs according to the database engine you use.

string MasterDatabaseName { get; }

Property Value

string

Remarks

MySQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, no database is created in the database resource.

Constraints:

For more information about reserved words in MySQL, see the Keywords and Reserved Words articles for MySQL 5.6 , MySQL 5.7 , and MySQL 8.0 .

PostgreSQL

The name of the database to create when the Lightsail database resource is created. If this parameter isn't specified, a database named postgres is created in the database resource.

Constraints:

For more information about reserved words in PostgreSQL, see the SQL Key Words articles for PostgreSQL 9.6 , PostgreSQL 10 , PostgreSQL 11 , and PostgreSQL 12 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterdatabasename

MasterUserPassword

The password for the primary user of the database.

string? MasterUserPassword { get; }

Property Value

string

Remarks

The password can include any printable ASCII character except the following: /, ", or

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masteruserpassword

: . It cannot contain spaces.

The MasterUserPassword and RotateMasterUserPassword parameters cannot be used together in the same template.

MySQL

Constraints: Must contain 8-41 characters.

PostgreSQL

Constraints: Must contain 8-128 characters.

MasterUsername

The name for the primary user.

string MasterUsername { get; }

Property Value

string

Remarks

MySQL

Constraints:

For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for MySQL 5.6 , MySQL 5.7 , or MySQL 8.0 .

PostgreSQL

Constraints:

For more information about reserved words in MySQL 5.6 or 5.7, see the Keywords and Reserved Words articles for PostgreSQL 9.6 , PostgreSQL 10 , PostgreSQL 11 , and PostgreSQL 12 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-masterusername

PreferredBackupWindow

The daily time range during which automated backups are created for the database (for example, 16:00-16:30 ).

string? PreferredBackupWindow { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredbackupwindow

PreferredMaintenanceWindow

The weekly time range during which system maintenance can occur for the database, formatted as follows: ddd:hh24:mi-ddd:hh24:mi .

string? PreferredMaintenanceWindow { get; }

Property Value

string

Remarks

For example, Tue:17:00-Tue:17:30 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-preferredmaintenancewindow

PubliclyAccessible

A Boolean value indicating whether the database is accessible to anyone on the internet.

object? PubliclyAccessible { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-publiclyaccessible

RelationalDatabaseBlueprintId

The blueprint ID for the database (for example, mysql_8_0 ).

string RelationalDatabaseBlueprintId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseblueprintid

RelationalDatabaseBundleId

The bundle ID for the database (for example, medium_1_0 ).

string RelationalDatabaseBundleId { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasebundleid

RelationalDatabaseName

The name of the instance.

string RelationalDatabaseName { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabasename

RelationalDatabaseParameters

An array of parameters for the database.

object? RelationalDatabaseParameters { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-relationaldatabaseparameters

RotateMasterUserPassword

A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .

object? RotateMasterUserPassword { get; }

Property Value

object

Remarks

The <code>RotateMasterUserPassword</code> and <code>MasterUserPassword</code> parameters cannot be used together in the same template.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lightsail-database.html#cfn-lightsail-database-rotatemasteruserpassword