GetConnection

The GetConnection activity is used to access an AWS service client object for the selected service. You can select the AWS service (for example KMS) from the drop-down on the General tab. The activity provides a KMS client object in the activity output, which can be used with the Java Invoke activity.

General

The General tab contains the following fields:

Field Module Property? Description
Name No Name to be displayed as a label for the activity in the process
Amazon Connection Yes Provides connection details to communicate with an Amazon Common Services instance
AWS Service No Choose the AWS Service to get the Client Object for the selected service from the following:
  • KMS
  • S3

Description

On the Description tab, you can provide a short description of the GetConnection activity.

Field Module Property? Description
Description No Description of the GetConnection activity

Input

The Input tab contains the following fields:

Input Item Data Type Description
key String AccessKeyID of external temporary credentials.
secret String SecretAceesKey of external temporary credentials.
token String SessionToken of external temporary credentials.
useCrossAccountCredentials Boolean Use AWS Security Token Service (AWS STS) to create and provide trusted users with temporary security credentials that can control access to your AWS resources. This parameter uses temporary security credentials for cross-account access created by Assume Role. See the AWS documentation for more information about Temporary Security Credentials.
roleARN String The Amazon Resource Name (ARN) of the role to assume. For more details about RoleARN, see the AWS documentation.
roleSessionName String An identifier for the assumed role session used to uniquely identify a session when the same role is assumed by different principals or for different reasons. For more details about roleSessionName, see the AWS documentation.
externalID? String A unique identifier that might be required when you assume a role in another account. It is used to address the confused deputy problem. For more details about externalID, see the AWS documentation.
expirationDuration? Integer Parameter to specify the duration in minutes for which the temporary security credentials remain valid using AssumeRole. For more details about ExpirationDuration, see the AWS documentation.
Note: CrossAccountCredentials supports the AWS Credentials and Container Credentials authentication types.

Note: To use Assume Role, the user must configure the input items in the input schema.

Output

The Output tab contains the following field:

Output Item Data Type Description
AWSClientAccessor Object AWS Service Client Object for the selected Service

 

Fault

The Fault tab lists exceptions that are generated by the GetConnection activity. It has the following fields:

Error Schema Element Data Type Description
Amazon CS Plugin Exception Complex Any exception created by TIBCO BusinessWorks Plug-in for Amazon Common Services

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon CS Client Exception Complex Any exception or error reported by Amazon Common Services Client

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in

Amazon CS Service Exception Complex Any exception or error reported by Amazon Common Services instance

msg: Error message description that is returned by the plug-in

msgCode: Error code that is returned by the plug-in