Amazon RDS - Create Session

Declaration

<AMAWSRDS ACTIVITY="create_session" ACCESSKEY="text" 
SECRETKEY="text (encrypted)" PROXYHOST="text" 
USERAGENT="text" PROXYPORT="number" PROXYUSER="text" 
PROXYPWD="text (encrypted)" MAXERRORRETRY="number" 
SIGNMETHOD="text" SIGNVERSION="number" SESSION="text" />

Description: Creates a unique session which can be used to associate subsequent Amazon RDS steps. This provides a single task the ability to execute numerous RDS operations simultaneously.

Practical Usage

Ideally used to create a session to be used in correlation with other RDS activities. To end a session, use the End session activity.

Credentials Parameters

Property	Type	Required	Default	Markup	Description
Access Key	Text	Yes	(Empty)	ACCESSKEY="MyAccessKey"	Specifies the alphanumeric text string that uniquely identifies a user who owns an Amazon RDS account. This along with a Secret Access Key forms a secure information set that RDS uses to confirm a valid user's identity.
Secret Access Key	Text	Yes	(Empty)	SECRETKEY="SecretKey"	Serves the role as password to access Amazon RDS. This along with an associated Access Key forms a secure information set that Amazon Web Service uses to confirm a valid user's identity.
Session	Text	Yes	RDSession1	SESSION="mySession"	Specifies the session name to create for this activity. Subsequent S3 activities can be linked to this  session allowing several S3 operations (that may contain multiple activities) to be performed within a single task. The default session name is 'RDSSession1'.
User Agent	Text	Yes	AutoMate	USERAGENT="AutoMate"	The User-Agent request-header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. The default value is AutoMate.
Service URL	Text	No	(Empty)	SERVICEURL= "https://eu-west-1.ec2.amazonaws.com"	The Service URL used to make requests to the RDS service. The Service URL provides the service endpoint.
Maximum retry on error	Number	No	(Empty)	MAXERRORRETRY="4"	Indicates how many times the Amazon RDS Engine should retry the request before generating an error.
Proxy Host	Text	No	(Empty)	PROXYHOST="proxy.host.com"	The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.
Proxy Port	Number	No	(Empty)	PROXYPORT="1028"	The port that should be used to connect to the proxy server.
Signature Method	Text	No	(Empty)	SIGNMETHOD="HmacSHA256"	The Signature Method for signing the request.
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.
Session Name	Text	Yes	RDSession1	SESSION="mySession"	Specifies the session name to create for this activity. Subsequent S3 activities can be linked to this  session allowing several S3 operations (that may contain multiple activities) to be performed within a single task. The default session name is RDSSession1.

Advanced Parameters

Property	Type	Required	Default	Markup	Description
User agent	Text	Yes	AutoMate	USERAGENT="AutoMate"	The user agent request header field contains information about the user agent originating the request. This is for statistical purposes, the tracing of protocol violations, and automated recognition of user agents for the sake of tailoring responses to avoid particular user agent limitations. The default value is AutoMate.
Service URL	Text	No	(Empty)	SERVICEURL= "https://eu-west-1.ec2.amazonaws.com"	The Service URL used to make requests to the RDS service. The Service URL provides the service endpoint.
Maximum retries on error	Number	No	(Empty)	MAXERRORRETRY="4"	Indicates how many times the Amazon RDS Engine should retry the request before generating an error.
Proxy host	Text	No	(Empty)	PROXYHOST="proxy.host.com"	The hostname (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server.
Proxy port	Number	No	(Empty)	PROXYPORT="1028"	The port that should be used to connect to the proxy server.
Signature method	Text	No	(Empty)	SIGNMETHOD="HmacSHA256"	The Signature Method for signing the request.
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.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

RDS Endpoints and Regions

This table contains a complete list of Amazon Relational Database Service endpoints, along with their corresponding regions and supported protocols.

Endpoint	Region	Protocol
rds.us-east-1.amazonaws.com	US East (Northern Virginia) Region	HTTP and HTTPS
rds.us-west-2.amazonaws.com	US West (Oregon) Region	HTTP and HTTPS
rds.us-west-1.amazonaws.com	US West (Northern California) Region	HTTP and HTTPS
rds.eu-west-1.amazonaws.com	EU (Ireland) Region	HTTP and HTTPS
rds.ap-southeast-1.amazonaws.com	Asia Pacific (Singapore) Region	HTTP and HTTPS
rds.ap-southeast-2.amazonaws.com	Asia Pacific (Sydney) Region	HTTP and HTTPS
rds.ap-northeast-1.amazonaws.com	Asia Pacific (Tokyo) Region	HTTP and HTTPS
rds.sa-east-1.amazonaws.com	South America (Sao Paulo) Region	HTTP and HTTPS

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: This session-based task demonstrates some of RDS activities. It creates a database instance and performs some modifications onto the new instance. Thereafter, it creates a snapshot of the newly modified instance then reboots. The last step ends the session.

<AMAWSRDS ACTIVITY="create_session" ACCESSKEY="AKIAJU2LHLMG6BA6BZTA" 
SECRETKEY="AM3m5RnKS1eh50=aME" USERAGENT="AutoMate" 
SESSION="MySession" />

<AMAWSRDS INSTANCEID="myRDSDatabase" 
INSTANCETYPE="db.m1.small" ZONE="us-east-1a" 
MASTERUSER="myName" MASTERPWD="AM16wP88TJPA0FX78Oon4bvjg==aME" 
PORT="3306" STORAGE="5" PROVIDER="session_based" 
SESSION="MySession" />

<AMAWSRDS ACTIVITY="modify_instance" 
INSTANCEID="myRDSDatabase" INSTANCETYPE="db.m1.large" 
STORAGE="10" APPLYFAST="yes" PROVIDER="session_based" 
SESSION="MySession" />

<AMAWSRDS ACTIVITY="create_snapshot" 
SNAPSHOTID="rdsSnap" INSTANCEID="myRDSDatabase" 
RESULTDATASET="theSnap" PROVIDER="session_based" 
SESSION="MySession" />

<AMAWSRDS ACTIVITY="reboot_instance" 
INSTANCEID="myRDSDatabase" PROVIDER="session_based" 
SESSION="MySession" />

<AMAWSRDS ACTIVITY="end_session" 
SESSION="MySession" />