RDS - Create Session

Declaration

<AMAWSRDS ACTIVITY="create_session" ACCESSKEY="text" SECRETKEY="encrypted_text" USERAGENT="text" SERVICEURL="text" PROXYHOST="text" PROXYPORT="number" SIGNMETHOD="text" SIGNVERSION="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 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 associated to a specific session.  To end a session, use the End Session activity.

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

Ideally used to create a session to be used in correlation with other RDS activities.  

Parameters

Credentials Properties

Property

Type

Req'd

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 RDS uses to confirm a valid user's identity.

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

S3Session

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 RDSSession.

NOTE: Make sure to use an End Session activity to end a particular session.

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
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 session. AWS access key is "022QF06E7MXBSH9DHM02". Useragent is "text". Service URL is "https://eu-west-1.ec2.amazonaws.com". Set max error retry to "2". Signature method is "HmacSHA256". Signature version is "2".

 

<AMAWSRDS ACTIVITY="create_session" ACCESSKEY="022QF06E7MXBSH9DHM02" SECRETKEY="AM1oiEZnBVA7p6XvqzpvsHQxQ==aME" USERAGENT="text" SERVICEURL="https://eu-west-1.ec2.amazonaws.com" MAXERRORRETRY="2" SIGNMETHOD="HmacSHA256" SIGNVERSION="2" />

 

↑ [Top of Page]