1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. lightsail
  5. getDatabase

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

aws-native.lightsail.getDatabase

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi

Resource Type definition for AWS::Lightsail::Database

Using getDatabase

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
Copy
def get_database(relational_database_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(relational_database_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
Copy
func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput
Copy

> Note: This function is named LookupDatabase in the Go SDK.

public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
public static Output<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:lightsail:getDatabase
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

RelationalDatabaseName This property is required. string
The name to use for your new Lightsail database resource.
RelationalDatabaseName This property is required. string
The name to use for your new Lightsail database resource.
relationalDatabaseName This property is required. String
The name to use for your new Lightsail database resource.
relationalDatabaseName This property is required. string
The name to use for your new Lightsail database resource.
relational_database_name This property is required. str
The name to use for your new Lightsail database resource.
relationalDatabaseName This property is required. String
The name to use for your new Lightsail database resource.

getDatabase Result

The following output properties are available:

BackupRetention bool
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
CaCertificateIdentifier string
Indicates the certificate that needs to be associated with the database.
DatabaseArn string
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
PreferredBackupWindow string
The daily time range during which automated backups are created for your new database if automated backups are enabled.
PreferredMaintenanceWindow string
The weekly time range during which system maintenance can occur on your new database.
PubliclyAccessible bool
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An array of key-value pairs to apply to this resource.
BackupRetention bool
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
CaCertificateIdentifier string
Indicates the certificate that needs to be associated with the database.
DatabaseArn string
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
PreferredBackupWindow string
The daily time range during which automated backups are created for your new database if automated backups are enabled.
PreferredMaintenanceWindow string
The weekly time range during which system maintenance can occur on your new database.
PubliclyAccessible bool
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
Tags Tag
An array of key-value pairs to apply to this resource.
backupRetention Boolean
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
caCertificateIdentifier String
Indicates the certificate that needs to be associated with the database.
databaseArn String
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
preferredBackupWindow String
The daily time range during which automated backups are created for your new database if automated backups are enabled.
preferredMaintenanceWindow String
The weekly time range during which system maintenance can occur on your new database.
publiclyAccessible Boolean
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
tags List<Tag>
An array of key-value pairs to apply to this resource.
backupRetention boolean
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
caCertificateIdentifier string
Indicates the certificate that needs to be associated with the database.
databaseArn string
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
preferredBackupWindow string
The daily time range during which automated backups are created for your new database if automated backups are enabled.
preferredMaintenanceWindow string
The weekly time range during which system maintenance can occur on your new database.
publiclyAccessible boolean
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
tags Tag[]
An array of key-value pairs to apply to this resource.
backup_retention bool
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
ca_certificate_identifier str
Indicates the certificate that needs to be associated with the database.
database_arn str
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
preferred_backup_window str
The daily time range during which automated backups are created for your new database if automated backups are enabled.
preferred_maintenance_window str
The weekly time range during which system maintenance can occur on your new database.
publicly_accessible bool
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
tags Sequence[root_Tag]
An array of key-value pairs to apply to this resource.
backupRetention Boolean
When true, enables automated backup retention for your database. Updates are applied during the next maintenance window because this can result in an outage.
caCertificateIdentifier String
Indicates the certificate that needs to be associated with the database.
databaseArn String
The Amazon Resource Name (ARN) of the database (for example, arn:aws:lightsail:us-east-2:123456789101:RelationalDatabase/244ad76f-8aad-4741-809f-12345EXAMPLE ).
preferredBackupWindow String
The daily time range during which automated backups are created for your new database if automated backups are enabled.
preferredMaintenanceWindow String
The weekly time range during which system maintenance can occur on your new database.
publiclyAccessible Boolean
Specifies the accessibility options for your new database. A value of true specifies a database that is available to resources outside of your Lightsail account. A value of false specifies a database that is available only to your Lightsail resources in the same region as your database.
tags List<Property Map>
An array of key-value pairs to apply to this resource.

Supporting Types

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi