Interface ICfnDatabaseProps
Properties for defining a CfnDatabase
.
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public interface ICfnDatabaseProps
Syntax (vb)
Public Interface ICfnDatabaseProps
Remarks
Link: 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. |
MasterUsername | The name for the primary user. |
MasterUserPassword | The password for the primary user of the database. |
PreferredBackupWindow | The daily time range during which automated backups are created for the database (for example, |
PreferredMaintenanceWindow | The weekly time range during which system maintenance can occur for the database, formatted as follows: |
PubliclyAccessible | A Boolean value indicating whether the database is accessible to anyone on the internet. |
RelationalDatabaseBlueprintId | The blueprint ID for the database (for example, |
RelationalDatabaseBundleId | The bundle ID for the database (for example, |
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.
virtual string AvailabilityZone { get; }
Property Value
System.String
Remarks
BackupRetention
A Boolean value indicating whether automated backup retention is enabled for the database.
virtual object BackupRetention { get; }
Property Value
System.Object
Remarks
CaCertificateIdentifier
The certificate associated with the database.
virtual string CaCertificateIdentifier { get; }
Property Value
System.String
Remarks
MasterDatabaseName
The meaning of this parameter differs according to the database engine you use.
string MasterDatabaseName { get; }
Property Value
System.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 .
MasterUsername
The name for the primary user.
string MasterUsername { get; }
Property Value
System.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 .
MasterUserPassword
The password for the primary user of the database.
virtual string MasterUserPassword { get; }
Property Value
System.String
Remarks
The password can include any printable ASCII character except the following: /, ", or @. 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.
PreferredBackupWindow
The daily time range during which automated backups are created for the database (for example, 16:00-16:30
).
virtual string PreferredBackupWindow { get; }
Property Value
System.String
Remarks
PreferredMaintenanceWindow
The weekly time range during which system maintenance can occur for the database, formatted as follows: ddd:hh24:mi-ddd:hh24:mi
.
virtual string PreferredMaintenanceWindow { get; }
Property Value
System.String
Remarks
For example, Tue:17:00-Tue:17:30
.
PubliclyAccessible
A Boolean value indicating whether the database is accessible to anyone on the internet.
virtual object PubliclyAccessible { get; }
Property Value
System.Object
Remarks
RelationalDatabaseBlueprintId
The blueprint ID for the database (for example, mysql_8_0
).
string RelationalDatabaseBlueprintId { get; }
Property Value
System.String
Remarks
RelationalDatabaseBundleId
The bundle ID for the database (for example, medium_1_0
).
string RelationalDatabaseBundleId { get; }
Property Value
System.String
Remarks
RelationalDatabaseName
The name of the instance.
string RelationalDatabaseName { get; }
Property Value
System.String
Remarks
RelationalDatabaseParameters
An array of parameters for the database.
virtual object RelationalDatabaseParameters { get; }
Property Value
System.Object
Remarks
RotateMasterUserPassword
A Boolean value indicating whether to change the primary user password to a new, strong password generated by Lightsail .
virtual object RotateMasterUserPassword { get; }
Property Value
System.Object
Remarks
The RotateMasterUserPassword
and MasterUserPassword
parameters cannot be used together in the same template.