Skip to main content

Add IAM role to an S3 Instant Access endpoint​

Adds a user-defined IAM role to allow access to an S3 Instant Access endpoint.

Path Parameters
  • endpoint_id string required

    ID of the endpoint to add a role

Request Body required
  • is_allow_external_account boolean

    Allow the addition of a role from an external account. This requires a feature flag to be enabled, contact support@clumio.com.

  • role_alias string

    Descriptive alias of the IAM role.

  • role_arn string required

    ARN of the IAM role to allow access the endpoint. The role must be accessible from AWS account registered with Clumio.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-protection-group-s3-asset

    Embeds the associated protection group S3 asset

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-protection-group-instant-access-endpoint

    URL to the detailed information of the instant access endpoint

  • read-protection-group-instant-access-endpoint-role-permission

    URL to the role permissions of the instant access endpoint

  • read-protection-group-instant-access-endpoint-uri

    URL for getting URI of the instant access endpoint

  • read-protection-group-s3-asset

    URL to the associated protection group S3 asset

  • role_id string

    The issued ID to the added role

Loading...