Skip to content

User Guide: Integration > Configure the Integration Service > AWS S3 Adapter

AWS S3 Adapter

S3 (Simple Storage Service) is an object storage service that is provided by Amazon Web Services. The AWS S3 service on Volt MX Foundry connects to the specified S3 bucket, and also performs supported operations.

You can use the service in scenarios where you want to store the data for your app (such as archives, website data, or data lakes) in an S3 bucket.

Configure a service for AWS S3

To configure an AWS S3 adapter in Integration Service Definition tab, follow these steps:

  1. In the Name field, provide a unique name for your service.
    When you enter the name, the name is updated for the active service under the Services section on the left pane.

    Note: If you have an existing service with the same name, you can select a different Version for the service.

  2. From the Service Type list, select AWS S3.

  3. Under Connection Parameters, provide the following details.

    Fields Description
    Expiry Time The expiration period of the objects in the S3 bucket.This parameter is optional.
    Access Key The access key ID of your AWS account. For more information, refer to Managing Access Keys for Your AWS Account Root User.
    Access Secret The secret access key of your AWS account. For more information, refer to Managing Access Keys for Your AWS Account Root User.
    Backend URL The URL of the service endpoint on AWS. For more information, refer to AWS Service Endpoints.
    Region The region code of your endpoint. For more information, refer to Regional Endpoints.
    Bucket Path The path of the S3 bucket that you want to use. For more information, refer to Path-Style Access.
    Service Namespace The namespace of the resource that you want to use. For more information, refer to Amazon Resource Names.
    Advanced Settings Additional settings that are configured for the S3 bucket. For more information, refer to Advanced Settings for S3 Bucket Properties.This parameter is optional.

  4. For additional configuration of your service definition, provide the following details in the Advanced section.

    Field Description
    Custom code Specifies any custom business logic that you want to use for the service and the operations. The custom business logic must be in a JAR file. To specify a JAR associated to the service, select one from the Select Existing JAR drop-down menu or click Upload New to add a new JAR file. For on-premise instances of Volt MX Foundry, make sure that the JAR file that is built on the same JDK version that is used to install Volt MX Foundry Integration.
    API Throttling API throttling on the Volt MX Foundry Console limits the number of request calls within a minute. To use API Throttling, configure the following fields: Total Rate Limit: Limits the number of requests that are processed by the service Rate Limit Per IP: Limits the number of requests that are processed by an IP address To override throttling from the Volt MX Foundry App Services Console, refer to Override API Throttling Configuration.

Note:
Options in the Advanced section are optional.

  1. Enter the Description for the service.
  2. Click SAVE to save your service definition.

Create operations for AWS S3

  1. After you configure a service, click SAVE & ADD OPERATION.
    Alternatively, from the left pane, click the add (+) icon, and then click Add New Operation.
  2. Under the Operation List tab. from the drop-down list, select the operations that you want to add.
  3. Click ADD OPERATION. Foundry adds the selected operations to the Operations List page.
  4. Under Configured Operations list, click an operation to view the details of the operation.

  5. The console displays the selected operation in the edit mode. Provide the following details to configure the operation:

    Field Description
    Name The operation name appears in the Name field. You can edit the name based on your preference.
    Operation Security Level It specifies how a client must authenticate to invoke this operation.

    Select one of the following security operations in the Operation Security Level field

    Authenticated App User – It restricts the access to clients who have successfully authenticated using an Identity Service associated with the app.

    Anonymous App User – It allows the access from trusted clients that have the required App Key and App Secret. Authentication through an Identity Service is not required.

    Public – It allows any client to invoke this operation without any authentication. This setting does not provide any security to invoke this operation and you should avoid this authentication type if possible.

    Private - It blocks the access to this operation from any external client. It allows invocation either from an Orchestration/Object Service, or from the custom code in the same run-time environment.

  6. response operations, provide the following details in the Advanced section.

    Custom Code InvocationYou can add pre and post processing logic to services to modify the request inputs. When you test, the services details of various stages in the service execution are presented to you for better debugging. All options in the Advanced section are optional. For more details, refer to Preprocessor and Postprocessor.
    Additional Configuration PropertiesAdditional Configuration Properties allows you to configure service call time out cache response. For information on different types of configuration properties, refer Properties.
    Front-end APIFront-end API allows you map your endpoint (or) backend URL of an operation to a front-end URL. For detailed information, refer Custom Front-end URL.
    Server EventsUsing Server Events you can configure this service to trigger or process server side events. For detailed information, refer Server Events.

Note: All options in the Advanced section for operations are optional.

  1. Enter the Description for the operation.

Note:
The Operations List tab appears only after the service definition is saved.

Configure request input parameters

  1. Under Request Input, on the Body tab, configure the following fields:

    Field Description
    Name Specifies the name of the input parameter. the name must be unique.
    Test Value Specifies the value of the input parameter that is used to test the operation.
    Default Value Specifies the default value of the input parameter. The default value is used to test the operation if the test value not set.
    Data Type Specifies the data type of the input parameter. Foundry supports the following data types:String is a combination of alpha-numeric and special charactersSupports all formats including UTF-8 and UTF-16 with no maximum size limitBoolean a value that can be true or falseNumber an integer or a floating point number
    Record ID Specifies the ID of the parent record of the parameter. Applicable for nested payloads.
    Collection ID Specifies the ID of the parent collection or parent array of the parameter. Applicable for parameters that are inside an array.
    Description Specifies the text that is displayed on the console as the description of the parameter.

  2. To validate the provided details, you must test the service operation. You can refer to Test a Service Operation for the steps to test a service.

Configure response output parameters

  1. Under Response Output, on the Body tab, configure the following fields:

    Field Description
    Name Specifies the name of the output parameter. the name must be unique.
    Path Specifies the path of the parameter in the back-end response.
    Scope Specifies the scope in which the output parameter should be available. 
    Data Type Specifies the data type of the output parameter. Foundry supports the following data types:Collection is an array or an object that contains more parametersRecord is a parameter that contains nested parametersString is a combination of alpha-numeric and special charactersSupports all formats including UTF-8 and UTF-16 with no maximum size limitBoolean a value that can be true or falseNumber an integer or a floating point number
    Record ID Specifies the ID of the parent record of the parameter. Applicable for nested payloads.
    Collection ID Specifies the ID of the parent collection or parent array of the parameter. Applicable for parameters that are inside an array.
    Description Specifies the text that is displayed as the description of the parameter.

  2. To validate the provided details, you must test the service operation. You can refer to Test a Service Operation for the steps to test a service.