Instaclustr Logo
Powered by Redocly

BYOC AWS Provider Account Setup V1

Operations related to BYOC provider account setup records.

List all BYOC provider account setup records.

Returns a list of all BYOC provider account setup records for the authenticated account.

SecurityBasic Authentication
Responses
200

List of BYOC provider account setup records.

403

Forbidden

get/cluster-management/v2/resources/byoc-setups/aws/v1/
Request samples 
Response samples 
application/json
[
  • {
    }
]
Create BYOC provider account setup record.
Create a new BYOC provider account setup record to indicate that a user has started setting up a BYOC provider account.


SecurityBasic Authentication 
Request 
Request Body schema: application/json
required
cloudProviderAccountId
required
string
Cloud provider account ID for BYOC setup.


 
required
Array of objects (ByocAwsDataCentreBackupBucketV1) 
Ordered list of data centre backup bucket mappings. The first entry is the primary region. Exactly one entry is required on create.


 
providerAccountName
required
string
Name of the provider account.


 
iamRoleName
string
Custom IAM role name for BYOC setup. If not provided, defaults to 'instaclustr-'. Must be 1-64 characters, containing only alphanumeric characters and +=,.@-_ symbols.


 
Responses 
202
BYOC provider account setup record created successfully.


400
Bad request. Invalid input parameters.


403
Forbidden


post/cluster-management/v2/resources/byoc-setups/aws/v1/
Request samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Response samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Get BYOC provider account setup record.
Returns a BYOC provider account setup record matching the provided provider account ID.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string <uuid> 
ID of the BYOC provider account.


 
Responses 
200
BYOC provider account setup record.


403
Forbidden


404
BYOC provider account setup record not found.


get/cluster-management/v2/resources/byoc-setups/aws/v1/{id}
Request samples 
Response samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Update BYOC provider account setup record.
Update a BYOC provider account setup record matching the provided provider account ID. For setups in PROVISIONING, GENESIS, or FAILED status, the following fields can be updated: dataCentreBackupBuckets, cloudProviderAccountId, and iamRoleName. For setups in RUNNING status, new data centres may be added to dataCentreBackupBuckets (backup bucket names for existing data centres cannot be changed). At least one data centre backup bucket mapping is required.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string <uuid> 
ID of the BYOC provider account.


 
Request Body schema: application/json
required
cloudProviderAccountId
required
string
Cloud provider account ID for BYOC setup.


 
required
Array of objects (ByocAwsDataCentreBackupBucketV1) 
Ordered list of data centre backup bucket mappings. The first entry is the primary region. Exactly one entry is required on create.


 
providerAccountName
required
string
Name of the provider account.


 
iamRoleName
string
Custom IAM role name for BYOC setup. If not provided, defaults to 'instaclustr-'. Must be 1-64 characters, containing only alphanumeric characters and +=,.@-_ symbols.


 
Responses 
202
BYOC provider account setup record updated successfully.


400
Bad request. Invalid input parameters or disallowed field changes.


403
Forbidden. Missing required permissions, or AWS permission validation failed for new data centres.


404
BYOC provider account setup record not found.


put/cluster-management/v2/resources/byoc-setups/aws/v1/{id}
Request samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Response samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Validate BYOC provider account setup record.
Triggers validation of a BYOC provider account setup record matching the provided provider account ID. Validates the setup configuration and, if successful, transitions the provider account status to RUNNING.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string <uuid> 
ID of the BYOC provider account.


 
Responses 
202
BYOC provider account setup validation triggered successfully.


400
Bad request. Invalid input parameters.


403
Forbidden. Missing required permissions, or AWS provisioning permission validation failed.


404
BYOC provider account setup record not found.


post/cluster-management/v2/resources/byoc-setups/aws/v1/{id}
Request samples 
Response samples 
application/json
{
  • "accountId": "068c447e-8475-49b2-974b-ca1c91702ed4",
  • "cloudProvider": "AWS_VPC",
  • "cloudProviderAccountId": "123456789012",
  • "dataCentreBackupBuckets": [
    ],
  • "iamRoleName": "instaclustr-my-account-role",
  • "providerAccountId": "568c447e-8475-49b2-974b-ca1c91702ed4",
  • "providerAccountName": "my-byoc-provider-account",
  • "selfServiceByoc": true,
  • "status": "RUNNING"
}
Delete BYOC provider account setup record.
Delete a BYOC provider account setup record matching the provided provider account ID.


SecurityBasic Authentication 
Request 
path Parameters
id
required
string <uuid> 
ID of the BYOC provider account.


 
Responses 
204
BYOC provider account setup record deleted successfully.


403
Forbidden


404
BYOC provider account setup record not found.


delete/cluster-management/v2/resources/byoc-setups/aws/v1/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Cadence Provisioning V2