RDS - Create Instance

Declaration

<AMAWSRDS INSTANCEID="text" INSTANCETYPE="text" ZONE="text" MASTERUSER="text" MASTERPWD="text_encrypted" SECURITYGROUP="text" PARAMGROUP="text" DATABASE="text" />

See Also

RDS - Authorize Security Group | RDS - Create Instance | RDS - Create Security Group | RDS - Create Session | RDS - Create Snapshot | RDS - Delete Instance | RDS - Delete Security Group | RDS - Delete Snapshot | RDS - End Session | RDS - List Instance(s) | RDS - List Security Group(s) | RDS - List Snapshot(s) | RDS - Modify Instance | RDS - Reboot Instance | RDS - Revoke Security Group

Description

Creates an RDS (Relational Database Service) instance, which is an isolated database environment running in the cloud. It can contain multiple user-created databases, and can be accessed using the same tools and applications as a stand-alone database instance. Amazon RDS is designed for developers or businesses who require the full features and capabilities of a relational database, or who wish to migrate existing applications and tools that utilize a relational database. It gives you access to the full capabilities of a MySQL 5.1 database running on your own Amazon RDS database instance.

IMPORTANT: The RDS activities in AutoMate use Amazon's RDS engine to perform their work. You must enter a valid Amazon RDS service account in order for these activities to work properly.

Practical Usage

Commonly used for the creation of an RDS instance. You can set the specified class and storage capacity that best meets your organization's needs.

Parameters

Instance Properties

Property

Type

Req'd

Default

Markup

Description

Instance Identifier

Text

Yes

(Empty)

INSTANCEID="my-test-1"

A unique name/identifier for the RDS instance. This identifier specifies a particular DB Instance when interacting with the Amazon RDS API and commands. Constraints are as follows:

  • Must contain 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • May not end with a hyphen or contain two consecutive hyphens.

NOTE: The DB Instance identifier must be unique for that customer in an AWS region. If the name is not in lowercase characters, it will be converted (i.e. my-test-1).

Instance Type

Text Options

Yes

(Empty)

INSTANCETYPE="db.m1.large"

The type of RDS Instance to launch. The available options are:

  • db.m1.small

  • db.m1.large

  • db.m1.xlarge

  • db.m2.2xlarge

  • db.m2.4xlarge

Availability Zone

Text Options

Yes

(Empty)

ZONE="us-east-1b"

The availability zone into which the RDS Instance will be launched. The available options are:

  • No preference

  • us-east-1a

  • us-east-1b

  • us-east-1c

  • us-east-1d

NOTE: For billing purposes, you might want to use the same availability zone as the server instances that will be connecting to it.

Master Username

Text

Yes

(Empty)

MASTERUSER="username"

The username used to log into MySQL.

Master Password

Text

Yes

(Empty)

MASTERPWD=

"AM1sTPOFuKG75M=aME"

the password used to log into MySQL.

Port

Number

Yes

3306

Port="3306"

The RDS Instance's endpoint port.  If you leave this field blank (recommended), the default port for MySQL (3306) will be used.

Size (GBs)

Number

Yes

5

Size="6"

The size of the RDS Instance in GB that's allocated for storage. Valid Range: 5-1024GB.   

Engine

Text

Yes

MySQL5.1

ENGINE="MySQL5.1"

The version of the MySQL engine of the RDS Instance. Currently, AWS only supports MySQL v5.1. (Default: MySQL5.1)

Security Group

Text

No

(Empty)

SECURITYGROUP="myGroup"

The name of the Amazon RDS security group.

NOTE: If unspecified, the 'default' security group will be used. If it does not exist, it will be created for you. You can also select multiple security groups.

Parameter Groupname

Text

No

(Empty)

PARAMGROUP="myParamGroup"

The parameter group name. This is the customer-specified description for this DB Parameter Group.

NOTE: If unspecified, the 'default.mysql5.1' parameter group will be used. If it does not exist, it will be created for you.  You can only select one RDS Parameter Group.

Database Name

Text

No

(Empty)

DATABASE="myDatabase"

The name of the database. The Database Name is the name of a database hosted in your Amazon DB Instance.

NOTE: An Amazon DB Instance can host multiple databases. Databases hosted by the same DB Instance must have a unique name within that instance.

Backup Retention Period

Number

No

(Empty)

BACKUPPERIOD="2"

Specifies the desired length of your retention period in number of days. Valid Range: 1-3.

AWS performs regular backups of the RDS Instance. For typical workloads, you should be able to restore your database to any point in time within your retention period, up to the last five minutes.

Preferred Backup Window

Date

No

(Empty)

BACKUPWINDOW="01:00-03:00"

Specifies a 2-hour window (GMT timezone) for backups (HH:MM-HH:MM). If this field is left blank, the default window will be used (03:00-05:00).

AWS will automatically perform a daily backup of your database during your predefined backup window.

Preferred Maintenance Window

Date

No

(Empty)

MAINTENANCEWINDOW=

"Sun:5:00-Sun:9:00"

Specifies a 4-hour window (GMT timezone) during non peak time that's ideal for maintenance purposes. (Day:HH:MM-Day:HH:MM) If this field is left blank, the default window will be used (Sun:05:00-Sun:09:00).

Create and populate dataset with RDS Instance information

Text

No

(Empty)

RESULTDATASET="myDataset"

The name of the dataset to be created and populated with the RDS Instance information. More on datasets below under Notes.

Credentials Properties

The Credentials properties allows you to set or link specific recommendations for this particular RDS activity.

Property

Type

Req'd

Default

Markup

Description

Provide Credentials

 

 

 

 

Indicates where this activity's credentials should originate from. Different properties apply depending on the option selected. This is a design-time parameter used interactively during  construction mode, thus, contains no markups. The available options are:

  • Custom (Default) - Specifies that a custom set of credentials will be entered for this EC2 activity. Select this option if performing a single RDS activity.

  • Session Based - Specifies that credentials should derive from a session created in a previous step with the use of the Create Session activity. This allows several RDS activities to be linked to a specific session.

Access Key

Text

Yes

(Empty)

ACCESSKEY=

"022QF06E7MXBSH9DHM02"

A 20-character, alphanumeric string that uniquely identifies a user who owns a RDS account (i.e. 022QF06E7MXBSH9DHM02). This along with a Secret Access Key forms a secure information set that RDS uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

Secret Access Key

Text

Yes

(Empty)

SECRETKEY=

"kWcrlUX5JEDGM/LtmEENI/

aVmYvHNif5zB+d9+ct"

A 40-character string that serves the role as Password to access RDS (i.e. kWcrlUX5JEDGM/LtmEENI/aVmYvHNif5zB+d9+ct). This along with an associated Access Key forms a secure information set that RDS uses to confirm a valid user's identity.

This property is active only if Custom is selected under the Provide Credentials property.

User Agent

Text

No

AutoMate

USERAGENT="AutoMate"

The User-Agent header name. The User-Agent request-header field contains information about the user agent originating the request such as timeouts, proxies, name, etc. The default User Agent name is AutoMate.

This property is active only if Custom is selected under the Provide Credentials property.

Maximum retry on error

Number

No

(Empty)

MAXERRORRETRY="4"

Signifies how many times the Amazon RDS engine should retry the request before returning an error.

This property is active only if Custom is selected under the Provide Credentials property.

Service URL

Text

No

(Empty)

SERVICEURL=

"https://sdb.eu-west-1.amazonaws.com"

The Service URL used to make requests to the RDS service. The Service URL provides the service endpoint. For example, To make the service call to a different region, you can pass the region-specific endpoint, such as 'https://sdb.eu-west-1.amazonaws.com'.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Host

Text

No

(Empty)

PROXYHOST="proxy.host.com"

The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Proxy Port

Number

No

(Empty)

PROXYPORT="1028"

The port that should be used to connect to the proxy server.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Method

Text

No

(Empty)

SIGNMETHOD="HmacSHA256"

The Signature Method for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Signature Version

Number

No

(Empty)

SIGNVERSION="2"

The Signature Version for signing the request. The version refers to the particular algorithm for signing the request.

This property is active only if Custom is selected under the Provide Credentials property.

Session Name

Text

Yes

(Empty)

SESSION="EC2Session1"

The session name to be created. This allows several RDS activities to be linked to this  session, eliminating redundancy. Numerous sessions can be used within a single task. The default value is RDSSession.

NOTE: Use the End Session activity to end an RDS session.

This property is active only if Session Based is selected under the Provide Credentials property.

Description Properties

The Description tab allows you to customize the text description of any step when it appears in the Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab is part of AutoMate's Error Handling functionality which allows you to select / omit specific errors that will cause a particular step to fail.

More about error causes properties

On Error Properties

The On Error tab is part of AutoMate's Error Handling functionality which allows you to determine what the task should do if a particular step encounters an error.

More about on error properties

Notes

Datasets

A dataset is a multiple column, multiple row container object. This activity creates and populates a dataset containing a specific set of fields. The table below describes these fields (assuming the dataset name assigned was theDataset).

Name

Type

Return Value

theDataset.AllocatedStorage

Number

The size of the RDS Instance in GB that's allocated for storage.

theDataset.AvailabilityZone

Text

The availability zone where the RDS Instance was launched. (Example: us-east-1b)

theDataset.BackupRetentionPeriod

Number

The number of days to retain automated backups initially set for the instance.

theDataset.DBInstanceClass

Text

The compute and memory capacity of the DB Instance. (Example: db.m2.4xlarge)

theDataset.DBInstanceIdentifier

Text

The user-supplied database identifier. This is the unique key that identifies a DB Instance.

theDataset.DBInstanceStatus

Text

The current status of the Instance. (Example: deleted)

theDataset.DBName

Text

The user-defined name of the initial database created when the instance was created.

theDataset.DBParameterGroup

Text

The name of DB Parameter Group applied to the Instance.

theDataset.DBSecurityGroup

Text

The name for the DB Security Group. (Example: mysecuritygroup)

theDataset.EndPointAddress

Text

The address of the RDS Instance. This includes the Instance's name (AWS ID) and EC2 region. (Example: myrds.chxspydgchoo.us-east-1.rds.amazonaws.com)

theDataset.EndPointPort

Number

The RDS Instance's endpoint port.

theDataset.Engine

Text

The name of the database engine (including version) to be used for this DB Instance.

NOTE: Currently, Amazon RDS only supports mySQL.

theDataset.InstanceCreateTime

Date

The date when the Instance was initially created, in UTC.

theDataset.LatestRestorableTime

Date

The latest restorable date set for the DB.

theDataset.MasterUsername

Text

The master username for the instance. This is the username used to log onto themySQL database.

theDataset.PreferredBackupWindow

Date

The 2-hour window (GMT timezone) for backups initially set for the Instance. (Example: 03:00-05:00).

theDataset.PreferredMaintenanceWindow

Date

The 4-hour window (GMT timezone) non peak time initially set for the instance used for maintenance purposes (Example: sun:05:00-sun:09:00).)

 

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

 

Description: Create RDS database instance "text". Instance type is "db.m1.small". Launch database in "us-east-1a" zone.  Master user is  "theuser". Security group name is "thesecuritygroup". Parameter group name is  "paramgroupname". Database name is  "mydatabase". Use default RDS session.

 

<AMAWSRDS INSTANCEID="text" INSTANCETYPE="db.m1.small" ZONE="us-east-1a" MASTERUSER="theuser" MASTERPWD="AM1B2xUP4i/Z1Jj+M2n03FEHg==aME" SECURITYGROUP="thesecuritygroup" PARAMGROUP="paramgroupname" DATABASE="mydatabase" />

 

↑ [Top of Page]