ec2-rds-dbinstance.nix

{ config, lib, uuid, name, ... }:

with lib;

{

  options = {

    id = mkOption {
      type = types.str;
      default = "nixops-${uuid}-${name}";
      description = "Identifier for RDS database instance";
    };

    region = mkOption {
      type = types.str;
      description = "Amazon RDS region.";
    };

    accessKeyId = mkOption {
      default = "";
      type = types.str;
      description = "The AWS Access Key ID.";
    };

    allocatedStorage = mkOption {
      type = types.int;
      description = "Allocated storage in GB";
    };

    instanceClass = mkOption {
      type = types.str;
      example = "db.m3.xlarge";
      description = ''
        RDS instance class. See <link
        xlink:href='http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html' />
        for more information.
      '';
    };

    masterUsername = mkOption {
      type = types.str;
      example = "sa";
      description = "Master username for authentication to database instance.";
    };

    masterPassword = mkOption {
      type = types.str;
      description = "Password for master user.";
    };

    port = mkOption {
      type = types.int;
      description = "Port for database instance connections.";
    };

    engine = mkOption {
      type = types.str;
      description = ''Database engine. See <link
      xlink:href='http://boto.readthedocs.org/en/latest/ref/rds.html#boto.rds.RDSConnection.create_dbinstance'
      for valid engines.'';
    };

    dbName = mkOption {
      type = types.str;
      description = "Optional database name to be created when instance is first created.";
    };

    endpoint = mkOption {
      default = ""; # FIXME: Needs a default until read-only options are supported.
      type = types.str;
      description = "The endpoint address of the database instance.  This is set by NixOps.";
    };

  };

  config._type = "ec2-rds-dbinstance";

}