Class CfnDatabase
A CloudFormation AWS::Lightsail::Database
.
Inherited Members
Namespace: Amazon.CDK.AWS.Lightsail
Assembly: Amazon.CDK.AWS.Lightsail.dll
Syntax (csharp)
public class CfnDatabase : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnDatabase
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::Lightsail::Database
resource specifies an Amazon Lightsail database.
CloudformationResource: AWS::Lightsail::Database
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 cfnDatabase = new CfnDatabase(this, "MyCfnDatabase", 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
Constructors
CfnDatabase(Construct, String, ICfnDatabaseProps) | Create a new |
CfnDatabase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDatabase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AttrDatabaseArn | The Amazon Resource Name (ARN) of the database (for example, |
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. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDatabase(Construct, String, ICfnDatabaseProps)
Create a new AWS::Lightsail::Database
.
public CfnDatabase(Construct scope, string id, ICfnDatabaseProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnDatabaseProps
- resource properties.
CfnDatabase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDatabase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDatabase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDatabase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AttrDatabaseArn
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE
).
public virtual string AttrDatabaseArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: DatabaseArn
AvailabilityZone
The Availability Zone for the database.
public virtual string AvailabilityZone { get; set; }
Property Value
System.String
Remarks
BackupRetention
A Boolean value indicating whether automated backup retention is enabled for the database.
public virtual object BackupRetention { get; set; }
Property Value
System.Object
Remarks
CaCertificateIdentifier
The certificate associated with the database.
public virtual string CaCertificateIdentifier { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
MasterDatabaseName
The meaning of this parameter differs according to the database engine you use.
public virtual string MasterDatabaseName { get; set; }
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.
public virtual string MasterUsername { get; set; }
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.
public virtual string MasterUserPassword { get; set; }
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
).
public virtual string PreferredBackupWindow { get; set; }
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
.
public virtual string PreferredMaintenanceWindow { get; set; }
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.
public virtual object PubliclyAccessible { get; set; }
Property Value
System.Object
Remarks
RelationalDatabaseBlueprintId
The blueprint ID for the database (for example, mysql_8_0
).
public virtual string RelationalDatabaseBlueprintId { get; set; }
Property Value
System.String
Remarks
RelationalDatabaseBundleId
The bundle ID for the database (for example, medium_1_0
).
public virtual string RelationalDatabaseBundleId { get; set; }
Property Value
System.String
Remarks
RelationalDatabaseName
The name of the instance.
public virtual string RelationalDatabaseName { get; set; }
Property Value
System.String
Remarks
RelationalDatabaseParameters
An array of parameters for the database.
public virtual object RelationalDatabaseParameters { get; set; }
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 .
public virtual object RotateMasterUserPassword { get; set; }
Property Value
System.Object
Remarks
The RotateMasterUserPassword
and MasterUserPassword
parameters cannot be used together in the same template.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag in the AWS CloudFormation User Guide .
The Value
of Tags
is optional for Lightsail resources.
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>