Illumina Connected Software is becoming Illumina BioInsight Platform. For this and other updates, you can
read more here
Ctrlk
Illumina KnowledgeIllumina SupportSign In
For the complete documentation index, see llms.txt. This page is also available as Markdown.

IAM User Method

To use the IAM user method, you need to:

Optional steps:

  • It is also best practice to block public access to the S3 bucket.

  • If your bucket is KMS-enabled, follow the additional steps described here.

1

Configure Bucket CORS Permission

Platform Core requires cross-origin resource sharing (CORS) permissions to write to the S3 bucket for uploads via the browser. Refer to Configuring cross-origin resource sharing (CORS) (expand the Using the S3 console section) documentation for instructions on enabling CORS via the AWS Management Console.

In the cross-origin resource sharing (CORS) section, enter the following content.

[
    {
        "AllowedHeaders": [
            "*"
        ],
        "AllowedMethods": [
            "HEAD",
            "GET",
            "PUT",
            "POST",
            "DELETE"
        ],
        "AllowedOrigins": [
            "https://ica.illumina.com"
        ],
        "ExposeHeaders": [
            "ETag",
            "x-amz-meta-custom-header"
        ]
    }
]
2

Create Data Access Permission - AWS IAM Policy

Platform Core requires specific permissions to access data in an AWS S3 bucket. These permissions are contained in an AWS IAM Policy.

Permissions

Refer to the Creating policies on the JSON tab documentation for instructions on creating an AWS IAM Policy via the AWS Management Console. Use the configuration below during the process, tab one shows the code for unversioned buckets, tab two the code for versioned and versioning-suspended buckets.

Paste the JSON policy document below. Note the example below provides access to all object prefixes in the bucket.

Replace <YOUR_BUCKET_NAME> with the name of the S3 bucket you created for Platform Core. Replace <YOUR_FOLDER_NAME> with the name of the folder in your S3 bucket.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutBucketNotification",
                "s3:ListBucket",
                "s3:GetBucketNotification",
                "s3:GetBucketLocation"
            ],
            "Resource": [
                "arn:aws:s3:::<YOUR_BUCKET_NAME>"
            ]
        },
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:GetObject",
                "s3:RestoreObject",
                "s3:DeleteObject",
                "s3:GetObjectTagging",
                "s3:PutObjectTagging"
            ],
            "Resource": "arn:aws:s3:::<YOUR_BUCKET_NAME>/<YOUR_FOLDER_NAME>/*"
        },
        {
            "Effect": "Allow",
            "Action": [
                "sts:GetFederationToken"
            ],
            "Resource": [
                "*"
            ]
        }
    ]
}

On Versioned OR Suspended buckets, paste the JSON policy document below. Note the example below provides access to all objects prefixes in the bucket.

Replace <YOUR_BUCKET_NAME> with the name of the S3 bucket you created for Platform Core. Replace <YOUR_FOLDER_NAME> with the name of the folder in your S3 bucket.

(Optional) Set policy name to "illumina-core-admin-policy"

To create the IAM Policy via the AWS CLI, create a local file named illumina-core-admin-policy.json containing the policy content above and run the following command. Be sure the path to the policy document (--policy-document) leads to the path where you saved the file:

aws iam create-policy --policy-name illumina-core-admin-policy --policy-document file://illumina-core-admin-policy.json
3

Create AWS IAM User

An AWS IAM User is needed to create an Access Key for Platform Core to connect to the AWS S3 Bucket. The policy will be attached to the IAM user to grant the user the necessary permissions.

Refer to the Creating IAM users (console) documentation for instructions on creating an AWS IAM User via the AWS Management Console. Use the following configuration during the process:

  • (optional) Set user name to "illumina_core_admin"

  • Select the Programmatic access option for the type of access.

  • Select Attach existing policies directly when setting the permissions, and choose the policy created in Create Data Access Permission - AWS IAM Policy.

  • (Optional) Retrieve the Access Key ID and Secret Access Key by choosing to Download .csv.

To create the IAM user and attach the policy via the AWS CLI, enter the following command (AWS IAM users are global resources and do not require a region to be specified). This command creates an IAM user illumina_core_admin, retrieves your AWS account number, and then attaches the policy to the user.

aws iam create-user --user-name illumina_core_admin
ACCOUNT_ID=$(aws sts get-caller-identity --query Account --output text)
aws iam attach-user-policy --policy-arn arn:aws:iam::${ACCOUNT_ID}:policy/illumina-core-admin-policy --user-name illumina_core_admin
4

Create AWS Access Key

If the Access Key information was retrieved during the IAM user creation, skip this step.

Refer to the Managing access keys (console) AWS documentation for instructions on creating an AWS Access Key via the AWS Console. See the "To create, modify, or delete another IAM user's access keys (console)" sub-section.

Use the command below to create the Access Key for the illumina_core_admin IAM user. Note the SecretAccessKey is sensitive and should be stored securely. The access key is only displayed when this command is executed and cannot be recovered. A new access key must be created if it is lost.

aws iam create-access-key --user-name illumina_core_admin

    "AccessKey": {
        "UserName": "illumina_core_admin",
        "AccessKeyId": "<access key id>",
        "Status": "Active",
        "SecretAccessKey": "<secret access key>",
        "CreateDate": "2020-10-22 09:42:24+00:00"
    }

The AccessKeyId and SecretAccessKey values will be provided to Platform Core in the next step.

5

S3 Bucket Policy

Connecting your S3 bucket to Platform Core does not require any additional bucket policies.

What if you need a bucket policy for use cases beyond Platform Core?

The bucket policy must then support the essential permissions needed by ICA without inadvertently restricting its functionality.

Be sure to replace the following fields:

  • YOUR_BUCKET_NAME: Replace this field with the name of the S3 bucket you created for Platform Core.

  • YOUR_ACCOUNT_ID: Replace this field with your account ID number.

  • YOUR_IAM_USER: Replace this field with the name of your IAM user created for Platform Core.

{
     "Version": "2012-10-17",
     "Statement": [
         {
             "Effect": "Deny",
             "Principal": {
                 "AWS": "*"
             },
             "Action": [
                 "s3:PutObject",
                 "s3:GetObject",
                 "s3:RestoreObject",
                 "s3:DeleteObject",
                 "s3:DeleteObjectVersion",
                 "s3:GetObjectVersion",
                 "s3:GetObjectTagging",
                 "s3:PutObjectTagging",
                 "s3:GetObjectVersionTagging",
                 "s3:PutObjectVersionTagging"
             ],
             "Resource": "arn:aws:s3:::YOUR_BUCKET_NAME/*",
             "Condition": {
                 "ArnNotLike": {
                     "aws:PrincipalArn": [
                         "arn:aws:iam::YOUR_ACCOUNT_ID:user/YOUR_IAM_USER",
                         "arn:aws:sts::YOUR_ACCOUNT_ID:federated-user/*"
                     ]
                 }
             }
         }
     ]
 }

In this example, restriction is enabled on the bucket policy to prevent any kind of access to the bucket. However, there is an exception rule added for the IAM user that Platform Core is using to connect to the S3 bucket. The exception rule is allowing Platform Core to perform the above S3 action permissions necessary for Platform Core functionalities.

Additionally, the exception rule is applied to the STS federated user session principal associated with Platform Core. Since Platform Core leverages the AWS STS to provide temporary credentials that allow users to perform actions on the S3 bucket, it is crucial to include these STS federated user session principals in your policy's whitelist. Failing to do so could result in 403 Forbidden errors when users attempt to interact with the bucket's objects using the provided temporary credentials.

6

S3 Object Ownership

Verify that the bucket's Object Ownership is set to ACLs disabled (Bucket owner enforced) on the Permissions tab. This is the AWS-recommended default for new buckets.

If it is not correctly set, open your bucket In the AWS S3 console, go to the Permissions tab, find Object Ownership, choose Edit, select ACLs disabled (recommended), and save.

When Illumina copies data into your bucket, the objects are written by an Illumina service identity. If your bucket has ACLs enabled (Bucket owner preferred), those copied objects remain owned by the writer rather than by your bucket, and Illumina's processing is then unable to read them back, which causes copy jobs to stall or fail with an access-denied (403) error. Setting Object Ownership to ACLs disabled (Bucket owner enforced) ensures your account always owns every object in the bucket, so the data can be read and processed normally.

Object Ownership is not the same as the Bucket Policy

Object Ownership and Bucket Policy are two separate settings on an S3 bucket:

  • Bucket Policy is the JSON document that grants Illumina access to your bucket.

  • Object Ownership controls who owns objects written to the bucket.

7

Block Public Access to S3 bucket (optional)

By default, public access to the S3 bucket is allowed. For increased security, it is advised to block public access with the following command below. Change <YOUR_BUCKET_NAME> to the name of your S3 bucket.

aws s3api put-public-access-block --bucket <YOUR_BUCKET_NAME> --public-access-block-configuration "BlockPublicAcls=true,IgnorePublicAcls=true,BlockPublicPolicy=true,RestrictPublicBuckets=true"

To block public access to S3 buckets on account level, you can use the AWS Console on the Amazon Web Services website.

8

Create Platform Core Storage Credential

Storage Credential

To connect your S3 account to Platform Core, you need to add a storage credential in Platform Core containing the Access Key ID and Access Key created in the previous step. From the Platform Core home screen, navigate to System Settings > Credentials > Create > Storage Credential to create a new storage credential.

Provide a name for the storage credentials, ensure the type is set to "AWS user" and provide the Access Key ID and Secret Access Key.

The key prefix is mandatory in your storage credentials if you created a folder as recommended in step 2 data access permissions.

Storage Configuration

Once the storage credentials are present, create a storage configuration using the secret credential. Refer to Create a Storage Configuration for details.

9

Enabling Cross-Account Access for Copy and Move Operations

When setting up cross-account access, ensure that no organisational policies are blocking the required permissions

Platform Core uses AssumeRole to copy and move objects from a bucket in an AWS account to another bucket in another AWS account. To allow cross account access to a bucket, the following policy statements must be added in the S3 bucket policy.

Be sure to replace the following fields:

  • <ASSUME_ROLE_ARN>: Replace this field with the ARN of the cross account role you want to give permission to. Refer to the table below to determine which region-specific Role ARN should be used.

  • <YOUR_BUCKET_NAME>: Replace this field with the name of the S3 bucket you created for Platform Core.

  {
        "Version": "2012-10-17",
        "Statement": [
            {
                "Sid": "AllowCrossAccountAccess",
                "Effect": "Allow",
                "Principal": {
                    "AWS": "<ASSUME_ROLE_ARN>"
                },
                "Action": [
                    "s3:PutObject",
                    "s3:DeleteObject",
                    "s3:ListMultipartUploadParts",
                    "s3:AbortMultipartUpload",
                    "s3:GetObject",
                    "s3:GetObjectTagging",
                    "s3:PutObjectTagging"
                ],
                "Resource": [
                    "arn:aws:s3:::<YOUR_BUCKET_NAME>",
                    "arn:aws:s3:::<YOUR_BUCKET_NAME>/*"
                ]
            }
        ]
    }

The ARN of the cross account role you want to give permission to is specified in the Principal. Refer to the table below to determine which region-specific Role ARN should be used.

Region
Role ARN

Australia (AU)

arn:aws:iam::079623148045:role/ica_aps2_crossacct

Canada (CA)

arn:aws:iam::079623148045:role/ica_cac1_crossacct

Germany (EU)

arn:aws:iam::079623148045:role/ica_euc1_crossacct

India (IN)

arn:aws:iam::079623148045:role/ica_aps3_crossacct

Indonesia (ID)

arn:aws:iam::079623148045:role/ica_aps4_crossacct

Israel (IL)

arn:aws:iam::079623148045:role/ica_ilc1_crossacct

Japan (JP)

arn:aws:iam::079623148045:role/ica_apn1_crossacct

Singapore (SG)

arn:aws:iam::079623148045:role/ica_aps1_crossacct

South Korea (KR)

arn:aws:iam::079623148045:role/ica_apn2_crossacct

UK (GB)

arn:aws:iam::079623148045:role/ica_euw2_crossacct

United Arab Emirates (AE)

arn:aws:iam::079623148045:role/ica_mec1_crossacct

United States (US-Oregon)

arn:aws:iam::079623148045:role/ica_usw2_crossacct

United States (US-N. Virginia)

arn:aws:iam::079623148045:role/ica_use1_crossacct

Before copy and move operations are executed on your own S3 storage, a test is performed to verify the necessary operational rights. This can result in temporary test files remaining (for example when IAM policy is not correctly set up for a versioned bucket). These files can safely be manually deleted from your S3 console.

Copying Object Tags

burst-new

Storage configurations created in Platform Core 2.47 or later automatically have object tag copying included.

Object tags are copied when performing Copy, Move, Archive and Unarchive Operations within the same account or across accounts when using your own S3 storage.

For storage configurations created prior to Platform Core v2.47, object tag copying is optional. If you want to enable it, contact Illumina support to enable TaggingPermissionType on the Platform Core Storage Configuration record associated with the S3 bucket with Object tags.

If there is an issue with copying, verify you have the required permission in your policies

  • In the configuration above, the s3:GetObjectTagging and s3:PutObjectTagging are part of the IAM Policy.

  • s3:GetObjectTagging and s3:PutObjectTagging are part of the S3 Bucket policy.

  • For cross-account copy or move operations, s3:GetObjectTagging and s3:PutObjectTagging are included in the cross-account access bucket policy.

PreviousConnect AWS S3 Bucket
NextIAM Role Method

Last updated

Was this helpful?