Configure Custom Storage with an AWS S3 Bucket

This page is for Cloud Storage in AWS. If you use Cloud Storage in Azure, see the Azure storage section of the Cloud Storage Services online help.

Instead of the S3 bucket that NICE CXone provides by default, you can use your own Amazon S3 bucket to store and retrieve your files in Cloud Storage Services. You cannot use custom storage if you plan to use, or already use, a custom AWS KMS key.

Custom storage will not allow you to: 

  • Save or remove playable files in your storage. Calls are encrypted, have a GUID for a file name, and can only be played using CXone. You will need to retrieve stored files back into CXone to play them.
  • Use your own long-term or glacier storage. That disables your ability to retrieve your files in CXone for playback.
  • Use SEA or APIs to pull unencrypted files off the CXone platform.

See the custom storage overview page for more details about custom storage limitations,

You can either: 

The CloudFormation template is the preferred configuration method. For either method, you need contact your CXone Account Representative to turn on custom storage for your system and to give you the CloudFormation template for your region.

Complete each of these tasks in the order given.

Automatically Configure Your S3 Bucket on Creation

Use the CXone CloudFormation template to create a new S3 bucket that's already configured for use with Cloud Storage Services. The CloudFormation template is a JSON file that specifies the resources that you want in your stack.

If you want to use an existing bucket, skip this task and manually configure it for use with Cloud Storage Services instead.

  1. Contact your CXone Account Representative to enable custom storage and to ask for the CloudFormation template for your region. Fill in the template.

    You can set up custom storage in an AWS region that differs from your CXone hosted region. However, if you use FedRAMP, you should create your custom storage location in the same region as your CXone hosted region to comply with the regulatory requirements.

  2. Log in to the Amazon S3 console at https://console.aws.amazon.com/s3/.

  3. Click CloudFormation.

  4. Select the region for the bucket.

  5. Click Create Stack.

  6. Under Choose a template, select Upload a template to Amazon S3. Click Browse. Select the CloudFormation template you received from your CXone Account Representative.

  7. Click Next.

  8. Enter a Stack name and a CustomerBucketName. The CustomerBucketName can usually be anything you want. However, if you want to host your local storage in your AWS account, your bucket name must follow these conventions, with <BUID> being your business unitClosed High-level organizational grouping used to manage technical support, billing, and global settings for your CXone environment or billing ID: 

    Region Bucket Name
    US West (Oregon) ic-storageservices-cs-ao-<BUID>
    Europe (Frankfurt) ic-storageservices-cs-af-<BUID>
    Asia Pacific (Sydney) ic-storageservices-cs-aa-<BUID>

    Contact your CXone Account Representative if you need help finding the correct regional code.

  9. Save the bucket name somewhere so you can use it during the CXone setup steps.

  10. Click Next. Click Next again.

  11. Click Create. Stay on the page until the stack Status is CREATE_COMPLETE. If the stack deployment fails, follow these steps: 

    1. Select the stack.
    2. Click Actions > Delete Stack.
    3. Restart the process to create a new stack.

If you need more help with this process, see the CloudFormation guide in the AWS documentation .

Manually Configure Your Own S3 Bucket for Cloud Storage Services

Use parts of the CXone CloudFormation template to configure your existing S3 storage bucket for use with Cloud Storage Services. The CloudFormation template is a JSON file that specifies the resources that you want in your stack.

If you set up a new S3 bucket with the CloudFormation template, skip the tasks in this section and move on to enabling custom storage for CXone.

Complete each of these tasks in the order given.

Apply S3 Policy on Custom Storage Bucket

Screen shot of the Bucket policy editor in the AWS console.

  1. Contact your CXone Account Representative to enable custom storage and to ask for the CloudFormation template for your region. Fill in the template.

    You can set up custom storage in an AWS region that differs from your CXone hosted region. However, if you use FedRAMP, you should create your custom storage location in the same region as your CXone hosted region to comply with the regulatory requirements.

  2. Sign in to the Amazon S3 console at https://console.aws.amazon.com/s3/.
  3. Click Services.
  4. In the Bucket name list, find the name of the bucket that you want to use for Cloud Storage Services. Click it.
  5. Click the Permissions tab.
  6. Click Bucket Policy.

  7. Using the policy contained in the CloudFormation template you received earlier, update the policy document in the Bucket policy editor:

    • If your custom storage bucket doesn't have an existing policy, copy the policy in as-is, replacing all references to the bucket ID with your unique bucket ID.

    • If your custom storage bucket has an existing policy, merge the policy in the existing policy, replacing all references to the bucket ID with your bucket ID.

  8. Click Save.

Apply Tags to the S3 Bucket

Tags help you keep files organized in your S3 bucket. Use the following steps to create the tags that are required for use with Cloud Storage Services.

Screenshot of Tags in the AWS console.
  1. Back on the Amazon S3 console home page, click Properties.
  2. Click Tags.
  3. Click Add tag. Create a key-value pair with Region as the Key and the appropriate region name as the Value; for example, us-west-2. The region should be the same as you specified when you created the S3 bucket.
  4. Click Add Tags again. Create a key value pair with AccountId as the Key and your AWS account ID as the Value; for example, 123456. You can find your account ID using these steps: 
    1. On the Amazon S3 console home page, click Services.
    2. Search for iam. Open the first link.
    3. Click Users.

    4. Open any existing user. Copy the Account ID from the User ARN. See the highlighted area of the following image for guidance.

      Screenshot from AWS Console showing the User ARN with the numbers between "iam::" and ":user/" highlighted.

  5. Click Save.

Configure Custom Storage in CXone

Required permissions: Life Cycle Management Edit

When custom storage is enabled for your system, you must manage the lifespan of the files using AWS settings instead of CXone settings. Because of this, once you've enabled custom storage, the time to live (TTL) settings are no longer available on the LIfe Cycle Management page of CXone.

  1. In CXone, click the app selector and select Admin.
  2. Go to Cloud Storage > Life Cycle Management.
  3. Click the Custom Storage Configuration tab.
  4. Select Enable Custom Storage.

  5. For the Custom Storage Region, enter the region you specified when you set up your S3 bucket.

  6. For the Custom Storage Location, enter the name you gave your S3 bucket. This should be the same as the value you entered in CustomerBucketName in the AmazonAWS console. Be sure that you have the permissions required to save data on the storage location you specify. You should create only one custom storage location.

  7. Click Validate & Save.

Maintain Your Custom Storage Setup

Use this section to manage your custom storage configuration after it's set up.

Edit Deployed Custom Storage CloudFormation Stack

  1. Select the stack.

  2. Click Actions > Update Stack.

  3. Edit the parameters you need to update.

Disable Custom Storage in CXone

Required permissions: Life Cycle Management Edit

Once you choose AWS or Azure as your custom storage type, you cannot switch to the other. However, you can turn off custom storage.

  1. Click the app selector and select Admin.
  2. Go to Cloud Storage > Life Cycle Management.
  3. Click the Custom Storage Configuration tab.
  4. Clear the Enable Custom Storage checkbox.

  5. Click Validate & Save