Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Adding an S3 repository

Updated on April 5, 2022

Add an S3 repository to provide centralized storage, versioning, and metadata support for file storage and knowledge management, for example, to store and source file attachments in cases.

Pega Cloud Services environments do not support adding local file system repositories. Instead, client applications running in Pega Cloud Services environments use a default S3 repository that is preconfigured and optimized for Pega Cloud environments. This repository appears as pegacloudfilestorage in your list of repositories in RecordsSysAdminRepository in Dev Studio. For details, see Pega Cloud Services File Storage.

Note: To create a repository, your access group must have the PegaRULES:RepositoryAdministrator role. To use a repository, your access group must have the PegaRULES:RepositoryUser role.
  1. In the header of Dev Studio, click CreateSysAdminRepository.

  2. Enter a short description of the repository and the repository name and click Create and open.

  3. In the Definition tab, click Select and select the repository type.

  4. In the Bucket field, enter the S3 bucket location where artifacts are stored.

  5. In the Authentication profile field, enter the name of the authentication profile to connect to the repository. To create an authentication profile, click the target icon to the right of the Authentication profile field.

    Note: Do not select the Provide secret access key by reference in clear text check box when creating an authentication profile for a repository. This check box is only used when entering Global Resource Settings, and Global Resource Settings are not supported for repositories.
  6. To enable data encryption at its destination by the service that receives the data, select Server side data encryption with KMS managed keys.

  7. In the KMS key ID field, enter the customer master key or data key that you generated to secure the data in your Amazon S3 bucket.

    For more information, refer to your Amazon Simple Storage Service documentation.
  8. In the Advanced settings section, the system automatically populates the following fields with the corresponding AWS SDK values. You can edit the field values, for example, if you are storing large files and need to increase connection timeout or pool size.

    For more information, see the AWS developer documentation.
    • The value in the Connection max idle time field indicates the default maximum idle time, in milliseconds, for a connection in the connection pool.
    • The value in the Max connection pool size field indicates the default maximum size of the connection pool.
    • The value in the New connection timeout field indicates the default timeout for creating new connections, in milliseconds.
    • The value in the Expiration time for connections in the pool field indicates the default expiration time, in milliseconds, for a connection in the connection pool.
    • The value in the Request timeout fields returns the amount of time to wait, in milliseconds, for the request to complete before timing out. If you enter a negative value, request timeout is disabled.
  9. To collect data on the health of your repository connection, select Enable metric collection.

  10. Click Test connectivity to verify the credentials.

  11. Click Save.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us