Package com.pulumi.aws.lightsail.inputs

Class DatabaseState

  • public final class DatabaseState
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  DatabaseState.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> backupRetentionEnabled()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> blueprintId()  
      static DatabaseState.Builder builder()  
      static DatabaseState.Builder builder​(DatabaseState defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> bundleId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertificateIdentifier()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cpuCount()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdAt()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Double>> diskSize()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterDatabaseName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterEndpointAddress()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> masterEndpointPort()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPassword()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUsername()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredBackupWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Double>> ramSize()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> relationalDatabaseName()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> secondaryAvailabilityZone()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> supportCode()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • applyImmediately

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> applyImmediately()
        Returns:
        Whether to apply changes immediately. When false, applies changes during the preferred maintenance window. Some changes may cause an outage.

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN of the database (matches `id`).

      • availabilityZone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZone()
        Returns:
        Availability Zone in which to create your database. Use the us-east-2a case-sensitive format.

      • backupRetentionEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> backupRetentionEnabled()
        Returns:
        Whether to enable automated backup retention for your database. When false, disables automated backup retention for your database. Disabling backup retention deletes all automated database backups. Before disabling this, you may want to create a snapshot of your database.

      • blueprintId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> blueprintId()
        Returns:
        Blueprint ID for your database. A blueprint describes the major engine version of a database. You can get a list of database blueprints IDs by using the AWS CLI command: `aws lightsail get-relational-database-blueprints`

      • bundleId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> bundleId()
        Returns:
        Bundle ID for your database. A bundle describes the performance specifications for your database (see list below). You can get a list of database bundle IDs by using the AWS CLI command: `aws lightsail get-relational-database-bundles`.

      • caCertificateIdentifier

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> caCertificateIdentifier()
        Returns:
        Certificate associated with the database.

      • cpuCount

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> cpuCount()
        Returns:
        Number of vCPUs for the database.

      • createdAt

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> createdAt()
        Returns:
        Date and time when the database was created.

      • diskSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> diskSize()
        Returns:
        Size of the disk for the database.

      • engine

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engine()
        Returns:
        Database software (for example, MySQL).

      • engineVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> engineVersion()
        Returns:
        Database engine version (for example, 5.7.23).

      • finalSnapshotName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> finalSnapshotName()
        Returns:
        Name of the database snapshot created if skip final snapshot is false, which is the default value for that parameter.

      • masterDatabaseName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterDatabaseName()
        Returns:
        Name of the master database created when the Lightsail database resource is created.

      • masterEndpointAddress

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterEndpointAddress()
        Returns:
        Master endpoint FQDN for the database.

      • masterEndpointPort

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> masterEndpointPort()
        Returns:
        Master endpoint network port for the database.

      • masterPassword

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterPassword()
        Returns:
        Password for the master user of your database. The password can include any printable ASCII character except "/", """, or "@".

      • masterUsername

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> masterUsername()
        Returns:
        Master user name for your database.

      • preferredBackupWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredBackupWindow()
        Returns:
        Daily time range during which automated backups are created for your database if automated backups are enabled. Must be in the hh24:mi-hh24:mi format. Example: `16:00-16:30`. Specified in Coordinated Universal Time (UTC).

      • preferredMaintenanceWindow

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> preferredMaintenanceWindow()
        Returns:
        Weekly time range during which system maintenance can occur on your database. Must be in the ddd:hh24:mi-ddd:hh24:mi format. Specified in Coordinated Universal Time (UTC). Example: `Tue:17:00-Tue:17:30`

      • publiclyAccessible

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> publiclyAccessible()
        Returns:
        Whether the database is accessible to resources outside of your Lightsail account. 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.

      • ramSize

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> ramSize()
        Returns:
        Amount of RAM in GB for the database.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • relationalDatabaseName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> relationalDatabaseName()
        Returns:
        Name to use for your Lightsail database resource. Names be unique within each AWS Region in your Lightsail account. The following arguments are optional:

      • secondaryAvailabilityZone

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> secondaryAvailabilityZone()
        Returns:
        Secondary Availability Zone of a high availability database. The secondary database is used for failover support of a high availability database.

      • skipFinalSnapshot

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> skipFinalSnapshot()
        Returns:
        Whether a final database snapshot is created before your database is deleted. If true is specified, no database snapshot is created. If false is specified, a database snapshot is created before your database is deleted. You must specify the final relational database snapshot name parameter if the skip final snapshot parameter is false.

      • supportCode

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> supportCode()
        Returns:
        Support code for the database. Include this code in your email to support when you have questions about a database in Lightsail. This code enables our support team to look up your Lightsail information more easily.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Map of tags to assign to the resource. To create a key-only tag, use an empty string as the value. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tagsAll()
        Returns:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.