Sign in

v1

latestOpenAPI 3.0.12026-07-26152262362.2 KB
Cloud Connect

Create or update an AWS account role

Creates or updates a CloudConnect document for an AWS account. Unlike the CloudFormation variant, this endpoint does not update Firestore channel documents or require a CloudFormation stack ID.

post/core/v1/cloudconnect/aws/accounts

Request body

accountIDstring required

The AWS account ID.

roleArnstring required

The ARN of the IAM role created for DoiT access.

s3Bucketstring

S3 bucket name for CloudTrail real-time anomaly detection. Required together with s3BucketRegion.

s3BucketRegionstring

AWS region of the S3 bucket. Required together with s3Bucket.

enabledFeaturesstring[] required

Declares which supported AWS features the caller intends to enable. Values must match feature names configured in awsFeaturePermissions on app/cloud-connect. The value is persisted and returned in account responses. When "real-time-data" is included, s3Bucket and s3BucketRegion are required; when it is not included, s3Bucket and s3BucketRegion are not allowed.

Example request

{
  "accountID": "123456789012",
  "roleArn": "arn:aws:iam::123456789012:role/DoiTRole",
  "s3BucketRegion": "us-east-1",
  "enabledFeatures": [
    "real-time-data"
  ]
}

Response

OK - Role created/updated successfully.

accountIDstring

The AWS account ID.

roleArnstring

The ARN of the IAM role.

s3Bucketstring

S3 bucket name for real-time anomaly detection. Present only if real-time is enabled.

s3BucketRegionstring

AWS region of the S3 bucket. Present only if s3Bucket exists.

enabledFeaturesstring[]

List of supported AWS features enabled by the caller. Returned in the same order as provided.

timeLinkedstring

ISO 8601 timestamp of when the role was linked.

Example response

{
  "accountID": "123456789012",
  "roleArn": "arn:aws:iam::123456789012:role/DoiTRole",
  "s3BucketRegion": "us-east-1",
  "supportedFeatures": [
    {
      "name": "spot-scaling"
    }
  ],
  "timeLinked": "2024-01-15T10:30:00Z"
}