Establishing the Connection to AWS Step Functions

{"URL":["/*.*/awa/pa_view_pa_view_CONN_aws_step_functions"],"heroDescriptionIdentifier":"ice_hero_CONN_AWS_StepFunctions","customCards":[{"id":"ice_specific_CONN_AWS_StepFunctions","title":"Defining the Connection Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_EstablishingConnection.htm","languages":["en-us"]},{"id":"ice_permissions_AWS_IAM_CONN_AWS_StepFunctions","title":"IAM Permissions for AWS Step Functions","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_IAM_Permissions.htm","languages":["en-us"]},{"id":"ice_video_AWS_StepFunctions","title":"Watch the Video","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_Video.htm","languages":["en-us"]},{"id":"ice_Proxy_CONN_AWS_StepFunctions","title":"Defining the Proxy Parameters","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_EstablishingConnection.htm","languages":["en-us"]},{"id":"ice_related_information_CONN_AWS_StepFunctions","title":"Related Information","type":"customize","url":"https://docs.automic.com/documentation/webhelp/english/ALL/components/IG_AWS_STEP/*.*/Agent%20Guide/Content/AWS_StepFunctions/AWS_StepFunctions_EstablishingConnection.htm","languages":["en-us"]}]}

The communication between the AWS Step Functions Agent and the target system is established by Connection objects. The Step Functions Connection object contains the parameters (target system endpoint, credentials and so on) required to authenticate on and connect to AWS Step Functions.

As an administrator user, you create the Step Functions Connection object. As a developer or object designer, you assign the respective Step Functions Connection object to the Step Functions Jobs to execute and monitor them on the target cloud solution without leaving Automic Automation. This page explains how to configure the Step Functions Connection object.

This page includes the following:

Adding an AWS Step Functions Connection Object

In the Automic Web Interface, go to the Process Assembly perspective. It opens to the Explorer view which contains the list of jobs that are available to you in your system.
You have two options:
- Right-click anywhere on the list and select Add > Add Object.
- Click the Add Object button on the toolbar.
On the Add Object dialog, start typing the name of the relevant integration in the Search field.
Select the corresponding Connection object and click Add. The Object Name dialog is displayed.
Enter a descriptive Name.
Optionally, enter a short and descriptive Title that helps you recognize the purpose of the object.
Click OK. A new page opens where you can start with the object definitions.

Step Functions Page

The Step Functions page contains two sections:

Connection

Here you define the parameters relevant for the connection to the AWS system.
Proxy

If the AWS system is behind a proxy server, you define the parameters relevant for the connection to the AWS system in this section.

AWS Step Functions-Specific Connection Section

Make sure you select AWS as your Cloud Storage Type and continue with the definition of the object.

Endpoint: Endpoint for the region in which the AWS Step Functions bucket is located, for example https://stepfunctions.us-east-2.amazonaws.com.

Make sure that the URL does not have a slash at the end as that causes the authentication to fail.
Region Optionally, define the region in the AWS account where Step Functions resides, for example:

us-east-1

If you do not define the region, the system uses the URL defined in the Endpoint.
Credentials Method: Select one of the credential methods available:

AWS Credentials File Path
- Profile Name: Define the credential profile name.
- Credentials File Path: Specify the file location of the AWS credential file on the agent machine.
  
  Example
  
  Windows: C:\Users\user\Documents\AWS\credential
  
  UNIX:/home/user/aws/credentials
EC2 Profile Instance

Allows you to connect to an EC2 VM within an AWS cloud application.
- Profile Instance Name: Define the credentials used for authentication on the EC2 server.
Note:
To use this option, you must have an EC2 instance profile. For instructions on how to set it up, please refer to the official AWS documentation.

Secret Access Key
- Access Key: Define the access key.
- Secret Access Key: Define the encrypted access key secret value.
External Provider

Allows you to set up single sign-on (SSO) with SAML using either a service or an identity provider.

Note:
Azure is the identity provider supported. To set it up as your AWS identity provider, please refer to the official Azure and AWS documentations, respectively.

Define the authentication data required to access the AWS system using single sign-on (SSO):
- Tenant ID: Identifier of the Azure AD tenant.
- Authentication URL: URL that identifies the network address of the Azure AD used to secure the application.
  
  By default, the URL (https://login.microsoftonline.com) points to the Azure AD log in. If you do not want to use this URL, make sure you change the default definition.
- SAML Username: Username used for SAML authentication when setting up Azure as your AWS identity provider.
- SAML Password: Password for the user used for SAML authentication.
- Principal ARN: Enter the Amazon Resource Name (ARN) of the account's principal.
- Role ARN: Enter the Amazon Resource Name (ARN) of the role to be assumed by the user.
- Identity Provider:Azure is the identity provider supported.
Assume Role

Allows you temporarily to assume a role and access different services with the credentials that you are assuming.
- Access Key: Define the access key.
- Secret Access Key: Define the encrypted access key secret value.
- Role ARN: Enter the Amazon Resource Name (ARN) of the role to be assumed by the user.
- Role Session Name: Define a name for the respective session to differentiate it from other sessions that you might have using the same assumed role.

Proxy Section

If the AWS Step Functions system is behind a proxy server, you define the parameters relevant for the connection to that system in this section.

Proxy Host Name

Host name or IP address of the proxy server to which you want to connect.
Proxy Port

Port used by the proxy server.
Proxy Username

User name used to authenticate the proxy server.
Proxy Password

Password of the user used to authenticate the proxy server.

Common Definition Pages

In addition to the Agent-specific connection parameters, you can also specify optional properties. You do so on the following definition pages:

Once the Connection object is configured, developers and object designers can select it when defining the Step Functions Start Execution Jobs.