Resource Type: rds_instance

Defined in:
lib/puppet/type/rds_instance.rb
Providers:
v2

Overview

Type representing an RDS instance.

Properties

  • allocated_storage

    The size of the DB.

  • availability_zone

    The availability zone in which to place the instance.

  • backup_retention_period (defaults to: 30)

    The number of days to retain backups. Defaults to 30 days.

  • db_instance_class

    The instance class to use for the instance eg. db.m3.medium.

  • db_name

    The meaning of this parameter differs according to the database engine you use. Type: String

    MySQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    Must contain 1 to 64 alphanumeric characters Cannot be a word reserved by the specified database engine

    PostgreSQL

    The name of the database to create when the DB instance is created. If this parameter is not specified, no database is created in the DB instance.

    Constraints:

    Must contain 1 to 63 alphanumeric characters Must begin with a letter or an underscore. Subsequent characters can be letters, underscores, or digits (0-9). Cannot be a word reserved by the specified database engine

    Oracle

    The Oracle System ID (SID) of the created DB instance.

    Default: ORCL

    Constraints:

    Cannot be longer than 8 characters

    SQL Server

    Not applicable. Must be null.

  • db_parameter_group

    The DB parameter group for this RDS instance.

  • db_security_groups

    The DB security groups to assign to this RDS instance.

  • db_subnet

    The VPC DB subnet for this instance.

  • endpoint

    The connection endpoint for the database.

  • engine

    the type of Database for the instance( mysql, postgres, etc…)

  • engine_version

    The version of Database for the instance.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • iops

    The number of input/output operations per second for the database.

  • license_model

    The license for the instance (Valid values: license-included | bring-your-own-license | general-public-license).

  • master_username

    The main user for the DB.

  • multi_az (defaults to: false)

    Define a multi-az.

    Supported values:
    • false
    • false
    • true
  • port

    The port the database is running on.

  • region

    The region in which to launch the instance.

  • storage_type

    The storage type for the DB (Valid values: gp | io1 *Note: If you specify io1, you must also include a value for the Iops parameter).

Parameters

  • final_db_snapshot_identifier

    Name given to the last snapshot on deletion.

  • master_user_password

    The main user Password.

  • name (namevar)

    The name of the db instance (also known as the db_instance_identifier)

  • provider

    The specific backend to use for this ‘rds_instance` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • skip_final_snapshot (defaults to: false)

    Skip snapshot on deletion.

    Supported values:
    • false
    • false
    • true