Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article

...

Parameter Data TypeDescription
Label*String


Multiexcerpt macro
nameAccount_Label

Required. Specify a unique label for the account. We recommend that you update the account name if there is more than one account of the same account type in your project.

Default ValueN/A
ExampleS3 Account

Access-key IDString

Required when IAM role is deselected. Specify the unique access key ID part of AWS authentication.

Default ValueN/A
ExampleASTPPGC2DCFDB5DW9GHI

Secret keyString

Required when IAM role is deselected. Specify the secret key part of AWS authentication.

Default Value: N/A
ExampleFGSDFG5465F4G6D5F4DFG5DFD5FGD5F5FGD58

Server-side encryptionCheckbox

Required for writing to S3. Specify the server-side encryption to use for the objects. For more information see Protecting Data Using Server-Side Encryption with Amazon S3-Managed Encryption Keys.

Default Value: Deselected
Example: N/A

IAM roleCheckbox

If you select this checkbox, the IAM role stored in the EC2 instance is used to access the S3 bucket.

Note
  • If you select this checkbox, ensure that the Access-key ID and Secret key fields are empty.
  • This field is valid only in Groundplex nodes hosted in the EC2 environment.

    In the Groundplex, add the following line to global.properties and restart the JCC: 
    jcc.jvm_options = -DIAM_CREDENTIAL_FOR_S3=TRUE
  • Validation does not work when you select this checkbox.

Default Value: Deselected
Example: N/A

IAM Role properties

Use this field set to enter information associated with the IAM Role.

Note

Use this field set only if you do not plan to provide the Access key ID and Secret key, and if IAM role, above, is selected.

Default Value: N/A

AWS account ID

String

Specify the Amazon Web Services account ID associated with the AWS S3 account that you want to use.

Default Value: N/A

IAM role name

String

Specify the name of the IAM role that can access the AWS S3 account identified above.

Default Value: N/A

Region Endpoint name

String

Specify the endpoint name of the region to which the target AWS S3 bucket belongs.

Protocols supported: S3

Default Value: N/A
Examples3.us-east-2.amazonaws.com

...