[object Object] Icon

Encoding
Learn how to create, start, manage and modify Encodings

[object Object] Icon

Player
Learn how to create, start, manage and modify Players

[object Object] Icon

Analytics
Learn how to create, start, manage and modify Analyticss

Docs Home
User shortcuts for search
Focus by pressing f
Hide results by pressing Esc
Navigate via   keys

Thu Feb 18 2021

How to create an S3 Role-Based Output for Analytics exports

OverviewLink Icon

S3 role-based Inputs resp. S3 role-based Outputs are an alternative way for our services to access your AWS (Amazon Web Services) S3 bucket to be used as an Encoding Input and/or Output, or an Output for Analytics Exports.

Instead of you providing your AWS Access/Secret key pair to our Encoding or Analytics service, we provide you with an AWS IAM (Identity and Access Management) user name, which you can grant specific access rights in your account so it can access your desired S3 bucket.

To do that, you are asked to create an IAM role in your AWS account, and attach an IAM policy to it. This policy states which of your buckets can be accessed by our user, and which permissions are granted to it.

Create an AWS S3 BucketLink Icon

In the AWS Management Console, open the S3 section.

  1. Click on the Create Bucket button which starts the bucket creation wizard
  2. In the "Name and Region" panel, choose a bucket name (for example my-bitmovin-bucket) and a Region (for example (EU) Ireland)), then press Next
  3. The options in the "Configure options" view are all optional and do not affect how Bitmovin uses your bucket. Press Next
  4. The way you configure options under "Set permissions" depends on how you want to use the bucket. The default settings will block public access which is generally recommended, unless you want to test playback or easily provide access to files in your bucket directly. We provide an FAQ for details on how to configure it for public access.
  5. Finish going through the wizard and click Create Bucket

Your bucket is now ready to be used.

Create an S3 role-based OutputLink Icon

Role based S3 output resources can be created via the Bitmovin API. The minimal required information to create a Role based S3 output are the following :

  • bucketName: the name of your target S3 bucket
  • roleArn: Amazon Resource Name of the Role you created

For more control over who can assume your IAM role, an externalID can be used. It is returned by the Bitmovin API after creating an S3-role-based Output. Enable it by selecting one of the following externalIdMode:

  • externalIdMode:
    • GLOBAL - A consistent and unique ID is used, which is used for every S3 role-based output that you create.
    • GENERATED - A unique but random UUID is returned
    • *CUSTOM (deprecated) Define a custom external ID that you can use in your AWS IAM role definition.
  • externalId (optional): required when using CUSTOM as externalIdMode.*

Hint: The property externalId is only part of the S3 role-based output response if externalIdMode GLOBAL or GENERATED is used.


Create an AWS IAM RoleLink Icon

In order to continue, you will have to create a Role in your AWS account.

  1. Login to your AWS account.
  2. Click on "Services" near the top left.
  3. Look for "Security, Identity & Compliance" and click on "IAM". You are now in the Identity and Access Management (IAM) page of your account.
  4. On the left pane, click on "Access Management" -> "Roles".
  5. Click on "Create Role". The Create Role page appears.
  6. The page shows you four boxes of which you can select one for a type of trusted entity. Click on the "Another AWS account" box.
  7. In the field "Account ID", enter 630681592166.
  8. Next to "Option", check the "Require external ID" checkbox. A box opens asking you to enter an external ID.
  9. Enter the external ID that is shown in the S3 role-based Output Details.
  10. Click on "Next: Permissions"
  11. Assign a policy to the role by selecting it in the policy list.

    (Note: The pre-defined AmazonS3FullAccess policy is known to be suitable but since it provides unrestricted access to your bucket, you might need to create a custom policy with fine-tuned access rights. Please review details of the permissions required for buckets for Encoding Input and Output or buckets for Analytics Exports buckets)

  12. Click on "Next: Tags". The Add Tags page appears, on which you optionally can assign tags to the role.
  13. Click "Next: Review". The Review page appears. Give the new role a name, e.g. "Bitmovin".
  14. Click "Create Role". You are now back in the Identity and Access Management(IAM)-Roles page, and the system tells you "The role Bitmovin has been created". You also see the new role in the list of roles in your account.

If you want to learn more about Roles in AWS, please see their documentation.

JSON Payload

If you prefer using the AWS CLI tools, you can create this role with the following JSON payload.

1{
2 "Version": "2012-10-17",
3 "Statement": [
4 {
5 "Effect": "Allow",
6 "Principal": {
7 "AWS": "arn:aws:iam::630681592166:user/bitmovinCustomerS3Access"
8 },
9 "Action": "sts:AssumeRole",
10 "Condition": {
11 "StringEquals": {
12 "sts:ExternalId": "<EXTERNAL_ID_RETURNED_BY_BITMOVIN_API>"
13 }
14 }
15 }
16 ]
17}

(Java) S3 role-based Output for Analytics ExampleLink Icon

This example uses our latest Open API client for Java, which is available on Github. The example shows how to create an Output.

Create a new S3 role-based Output

1bitmovinApi = BitmovinApi.builder().withApiKey("YOUR_BITMOVIN_API_KEY").build();
2
3List<AclEntry> s3RoleBasedAclPermissions = new ArrayList<>();
4AclEntry aclEntry = new AclEntry();
5aclEntry.setPermission(AclPermission.PRIVATE);
6s3RoleBasedAclPermissions.add(aclEntry);
7
8S3RoleBasedOutput s3RoleBasedOutput = new S3RoleBasedOutput();
9s3RoleBasedOutput.setBucketName("<BUCKET_NAME>");
10s3RoleBasedOutput.setRoleArn("<AWS_ARN_ROLE>");
11s3RoleBasedOutput.setExternalIdMode(ExternalIdMode.GLOBAL);
12s3RoleBasedOutput.setAcl(s3RoleBasedAclPermissions);
13
14s3RoleBasedOutput = bitmovinApi.analytics.outputs.s3RoleBased.create(s3RoleBasedOutput);

Use an existing S3 role-based Output

1bitmovinApi = BitmovinApi.builder().withApiKey("YOUR_BITMOVIN_API_KEY").build();
2
3S3RoleBasedOutput s3RoleBasedOutput = bitmovinApi.analytics.outputs.s3RoleBased.get("YOUR_S3_ROLE_BASED_OUTPUT_ID");

Beware that there is a very similar endpoint used for S3 Role-Based Outputs used for encoding: bitmovinApi.encoding.outputs.s3RoleBased. You cannot use those for your Analytics exports and vice-versa, so make sure you set the right one up

Important: Make sure you are creating this resource in the appropriate Organization if you have been invited into a Multi-Tenant Organization. Your personal API Key will by default create all resources in your user's organization and not in the organization you have been invited to. You can pass the X-Tenant-Org-Id HTTP Header or use the withTenantOrgId() API to indicate which Organization your API call is targetting (see Using an API SDK with different Organisations ).


(CURL) S3 role-based Output for Analytics ExampleLink Icon

Create a new S3 role-based Output

API reference: create a role-based S3 Output:

1curl -X POST \
2 https://api.bitmovin.com/v1/analytics/outputs/s3-role-based \
3 -H 'Content-Type: application/json' \
4 -H 'x-api-key: YOUR_BITMOVIN_API_KEY' \
5 -d '{
6 "bucketName": "<BUCKET_NAME>",
7 "roleArn": "<AWS_ARN_ROLE>",
8 "externalIdMode": "<GLOBAL|GENERATED>",
9 "acl": [
10 {
11 "permission": "PRIVATE"
12 }
13 ]
14}'

Get a existing S3 role-based Output

API reference: get a S3 role-based Output

1curl https://api.bitmovin.com/v1/analytics/outputs/s3-role-based/YOUR_S3_ROLE_BASED_OUTPUT_ID \
2 -H 'Content-Type: application/json' \
3 -H 'x-api-key: YOUR_BITMOVIN_API_KEY'

Beware that there is a very similar endpoint used for S3 Role-Based Outputs used for encoding: https://api.bitmovin.com/v1/encoding/outputs/s3-role-based. You cannot use those for your Analytics exports and vice-versa, so make sure you set the right one up

Important: Make sure you are creating this resource in the appropriate Organization if you have been invited into a Multi-Tenant Organization. Your personal API Key will by default create all resources in your user's organization and not in the organization you have been invited to. You can pass the X-Tenant-Org-Id HTTP Header or use the withTenantOrgId() API to indicate which Organization your API call is targetting (see Using an API SDK with different Organisations ).

What's next?Link Icon

Now that you have an S3 role-based Output for Bitmovin Analytics available, you can export your Bitmovin analytics Data to it :)

Give us feedback