AWS Native v0.65.0, Jun 7 23

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.lightsail.getDatabase

Explore with Pulumi AI

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

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>

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]

func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

> 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)
}

public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: aws-native:lightsail:getDatabase
  arguments:
    # arguments dictionary

The following arguments are supported:

RelationalDatabaseName string: The name to use for your new Lightsail database resource.

RelationalDatabaseName string: The name to use for your new Lightsail database resource.

relationalDatabaseName String: The name to use for your new Lightsail database resource.

relationalDatabaseName string: The name to use for your new Lightsail database resource.

relational_database_name str: The name to use for your new Lightsail database resource.

relationalDatabaseName 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
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.Lightsail.Outputs.DatabaseTag>: 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
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 []DatabaseTag: 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
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<DatabaseTag>: 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
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 DatabaseTag[]: 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
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[DatabaseTag]: 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
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

DatabaseTag

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
Value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key string: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value string: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key str: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value str: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

key String: The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
value String: The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.

Package Details

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

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.65.0 published on Wednesday, Jun 7, 2023 by Pulumi

pulumi/pulumi-aws-native

aws-native.lightsail.getDatabase

On this page

On this page

Using getDatabase

getDatabase Result

Supporting Types

DatabaseTag

Package Details

On this page

On this page