BYOC AWS CloudFormation

Operations related to Bring-Your-Own-Cloud (BYOC) AWS CloudFormation template.

Get raw AWS CloudFormation template for Bring-Your-Own-Cloud (BYOC) setup.

Returns the raw AWS CloudFormation template for BYOC setup as a JSON string. When bucketName and/or iamRoleName are supplied, the corresponding @@S3_BACKUP_BUCKET_NAME@@ / @@IAM_ROLE_NAME@@ placeholders are substituted with those values; otherwise they are left as placeholders for the customer to fill in.

SecurityBasic Authentication

Request

query Parameters

bucketName	string The customer's S3 backup bucket name to substitute for the `@@S3_BACKUP_BUCKET_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
iamRoleName	string The customer's IAM role name to substitute for the `@@IAM_ROLE_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
cloudProviderAccountId	string The customer's AWS account ID. When supplied together with `dataCentre`, used to set the CloudFormation `CreateKeyPair` parameter default to `false` if another RUNNING BYOC setup already exists for the same AWS account and data centre region under this Instaclustr account; otherwise defaults to `true`.
dataCentre	string The AWS data centre region for this BYOC setup (e.g. `US_EAST_1`). Must be supplied together with `cloudProviderAccountId` to determine the `CreateKeyPair` default.

Responses

200

Successfully retrieved raw AWS CloudFormation template for BYOC setup as a JSON string.

400

Bad Request

401

Not Authorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/cluster-management/v2/data-sources/byoc-setups/aws/template/v1

Request samples

Response samples

application/json

[{"accountId": "string",
"templates": [{"template": "string"
}
]
}
]

Download raw AWS CloudFormation template as a JSON file for Bring-Your-Own-Cloud (BYOC) setup.

Returns the AWS CloudFormation template for BYOC setup as a downloadable .json file. When bucketName and/or iamRoleName are supplied, the corresponding @@S3_BACKUP_BUCKET_NAME@@ / @@IAM_ROLE_NAME@@ placeholders are substituted with those values; otherwise they are left as placeholders for the customer to fill in.

SecurityBasic Authentication

Request

query Parameters

bucketName	string The customer's S3 backup bucket name to substitute for the `@@S3_BACKUP_BUCKET_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
iamRoleName	string The customer's IAM role name to substitute for the `@@IAM_ROLE_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
cloudProviderAccountId	string The customer's AWS account ID. When supplied together with `dataCentre`, used to set the CloudFormation `CreateKeyPair` parameter default to `false` if another RUNNING BYOC setup already exists for the same AWS account and data centre region under this Instaclustr account; otherwise defaults to `true`.
dataCentre	string The AWS data centre region for this BYOC setup (e.g. `US_EAST_1`). Must be supplied together with `cloudProviderAccountId` to determine the `CreateKeyPair` default.

Responses

200

Successfully retrieved raw AWS CloudFormation template for BYOC setup as a JSON file.

403

Forbidden

get/cluster-management/v2/data-sources/byoc-setups/template/aws/download-json/

Request samples

Response samples

application/json

"string"

Download raw AWS Terraform templates as a ZIP archive for Bring-Your-Own-Cloud (BYOC) setup.

Returns an AWS Terraform template for BYOC setup as a downloadable ZIP archive. When setup parameters are supplied, the corresponding Terraform variable defaults are populated and the template is tailored for an initial setup or an additional region. When omitted, the original raw template with placeholders is returned for backwards compatibility.

SecurityBasic Authentication

Request

query Parameters

bucketName	string The S3 backup bucket name to use as the Terraform `bucket_name` default.
iamRoleName	string The existing or new IAM role name to use as the Terraform `iam_role_name` default.
cloudProviderAccountId	string The customer's AWS account ID. Must be supplied together with `dataCentre` to determine whether the regional template should create the IAM role and EC2 key pair.
dataCentre	string The AWS Data Centre Region for the template (for example, `US_EAST_1`). Must be supplied together with `cloudProviderAccountId`.

Responses

200

Successfully retrieved raw AWS Terraform templates for BYOC setup as a ZIP archive.

403

Forbidden

get/cluster-management/v2/data-sources/byoc-setups/template/aws/download-terraform/

Request samples

➔ Next to BYOC AWS Provider Account Setup V1