Instaclustr BYOC AWS CloudFormation API

openapi: 3.2.0
info:
  title: Instaclustr BYOC AWS CloudFormation API
  version: Current
  x-logo:
    altText: Instaclustr Logo
    backgroundColor: '#FFFFFF'
    url: https://console2.instaclustr.com/assets/logos/instaclustr_logo_for_redocly.svg
  description: 'Operations tagged BYOC AWS CloudFormation across 2 of this provider''s published API definitions: instaclustr-current-openapi.json, instaclustr-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.instaclustr.com
  description: Instaclustr API
security:
- Basic Authentication: []
tags:
- name: BYOC AWS CloudFormation
  description: Operations related to Bring-Your-Own-Cloud (BYOC) AWS CloudFormation template.
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/data-sources/byoc-setups/aws/template/v1:
    x-terraform-resource-name: byoc_aws_cloudformation_template_v1
    get:
      tags:
      - BYOC AWS CloudFormation
      summary: Get raw AWS CloudFormation template for Bring-Your-Own-Cloud (BYOC) setup
      description: 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.
      parameters:
      - name: bucketName
        in: query
        description: The customer's S3 backup bucket name to substitute for the `@@S3_BACKUP_BUCKET_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: iamRoleName
        in: query
        description: The customer's IAM role name to substitute for the `@@IAM_ROLE_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cloudProviderAccountId
        in: query
        description: 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`.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: dataCentre
        in: query
        description: 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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved raw AWS CloudFormation template for BYOC setup as a JSON string.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AwsByocTemplateListV1'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
        '401':
          description: Not Authorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseV2'
      operationId: getClusterManagementV2DataSourcesByocSetupsAwsTemplateV1
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/data-sources/byoc-setups/template/aws/download-json/:
    get:
      tags:
      - BYOC AWS CloudFormation
      summary: Download raw AWS CloudFormation template as a JSON file for…
      description: 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.
      parameters:
      - name: bucketName
        in: query
        description: The customer's S3 backup bucket name to substitute for the `@@S3_BACKUP_BUCKET_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: iamRoleName
        in: query
        description: The customer's IAM role name to substitute for the `@@IAM_ROLE_NAME@@` placeholder. If omitted, the placeholder is left unsubstituted.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cloudProviderAccountId
        in: query
        description: 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`.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: dataCentre
        in: query
        description: 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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved raw AWS CloudFormation template for BYOC setup as a JSON file.
          content:
            application/json:
              schema:
                type: string
                format: binary
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      operationId: getClusterManagementV2DataSourcesByocSetupsTemplateAwsDownloadJson
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/data-sources/byoc-setups/template/aws/download-terraform/:
    get:
      tags:
      - BYOC AWS CloudFormation
      summary: Download raw AWS Terraform templates as a ZIP archive for Bring-Your-Own-Cloud…
      description: 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.
      parameters:
      - name: bucketName
        in: query
        description: The S3 backup bucket name to use as the Terraform `bucket_name` default.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: iamRoleName
        in: query
        description: The existing or new IAM role name to use as the Terraform `iam_role_name` default.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: cloudProviderAccountId
        in: query
        description: 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.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: dataCentre
        in: query
        description: The AWS Data Centre Region for the template (for example, `US_EAST_1`). Must be supplied together with `cloudProviderAccountId`.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Successfully retrieved raw AWS Terraform templates for BYOC setup as a ZIP archive.
          content:
            application/zip:
              schema:
                type: string
                format: binary
        '403':
          description: Forbidden
          content:
            application/zip:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      operationId: getClusterManagementV2DataSourcesByocSetupsTemplateAwsDownloadTerraform
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    AwsByocTemplateListV1:
      type: object
      properties:
        accountId:
          type: string
          description: UUID of the Instaclustr Account
          x-terraform-id: true
        templates:
          type: array
          description: A list of AWS templates
          items:
            $ref: '#/components/schemas/AwsByocTemplate'
      description: A list of AWS templates used in Bring-Your-Own-Cloud (BYOC) setup.
    ErrorListResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseV2'
      description: ''
    AwsByocTemplate:
      type: object
      properties:
        template:
          type: string
          description: The AWS template content as a string (CloudFormation JSON or Terraform configuration).
          x-insta-unchangeable: true
          x-terraform-computed: true
      description: A data source for AWS template used in Bring-Your-Own-Cloud (BYOC) setup.
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
  securitySchemes:
    Basic_Authentication:
      type: http
      description: Most requests to the API must use Basic Authentication and contain a valid username and appropriate API key for the endpoint.<br><br>API keys can be retrieved any time from the <a href='https://console2.instaclustr.com/' target='_blank'>console</a>. To find the API key relevant to the endpoint, refer to the Authentication & Rate Limit section for the endpoint or the group of the endpoint.
      scheme: basic
    No_Authentication:
      type: http
      description: Certain endpoints are publicly available and does not need any authentication to access.
      scheme: none
x-refined-from:
- instaclustr-current-openapi.json
- instaclustr-openapi.yml
x-tagGroups:
- name: Cluster Management V2
  tags:
  - Cluster Management V2 - Trait
  - Account Cluster List V2
  - AWS Encryption Key V2
  - AWS Endpoint DNS Names V2
  - AWS Endpoint Service Names V2
  - AWS Endpoint Service Principals V2
  - AWS FSx ONTAP File Systems
  - AWS FSx ONTAP Filesystem Credentials V2
  - AWS Prefix List Firewall Rule V1
  - AWS Prefix List Firewall Rules V1
  - AWS Security Group Firewall Rule V2
  - AWS Security Group Firewall Rules V2
  - AWS VPC Peer V2
  - Apache Cassandra Provisioning V2
  - Apache Kafka ACL V2
  - Apache Kafka ACL V3
  - Apache Kafka Connect Mirror V2
  - Apache Kafka Connect Provisioning V2
  - Apache Kafka Provisioning V2
  - Apache Kafka Provisioning V3
  - Apache Kafka Rest Proxy User
  - Apache Kafka Schema Registry User
  - Apache Kafka Tiered Storage
  - Apache Kafka Topic V2
  - Apache Kafka Topic V3
  - Apache Kafka User
  - Apache Zookeeper Provisioning V2
  - Azure Private Link Service Subscriptions
  - Azure Vnet Peer V2
  - BYOC AWS CloudFormation
  - BYOC AWS Provider Account Setup V1
  - Cadence Domain Rate Limits V2
  - Cadence Global Domain Rate Limits V2
  - Cadence Provisioning V2
  - ClickHouse Configurations
  - ClickHouse Integrations
  - ClickHouse Provisioning
  - Cloud Provider Details V2
  - Cluster Exclusion Window V2
  - Cluster Maintenance Events V2
  - Cluster Network Firewall Rule V2
  - Cluster Network Firewall Rules V2
  - Cluster Non Recurring Exclusion Window V2
  - Cluster Settings V2
  - Cluster Suspend Resume V2
  - Custom Tags V2
  - GCP PSC Service Attachments Accept List V2
  - GCP VPC Peer V2
  - Horizontal Scaling Operations
  - Karapace Rest Proxy User
  - Karapace Schema Registry User
  - MCP Gateway Backend V1
  - MCP Gateway Persona Access Control V1
  - MCP Gateway Provisioning V1
  - MCP Gateway Tool V1
  - MCP Gateway Virtual Server V1
  - Management Units Usage
  - OpenSearch Egress Rules V2
  - OpenSearch External S3 Bucket V2
  - OpenSearch Provisioning V2
  - PostgreSQL Configuration V2
  - PostgreSQL Operations
  - PostgreSQL Provisioning V2
  - Private Link Private Service Connect Endpoint Addresses V2
  - Redis Provisioning V2
  - Redis User V2
  - Resize Operations V2
  - Terraform Import V2
  - User Actions V3
  - Valkey Provisioning V2
  - Valkey User V2
- name: Monitoring
  tags:
  - Monitoring - Trait
  - Monitoring API
  - Monitoring API - Cluster
  - Monitoring API - Data Centre
  - Monitoring API - Node
- name: User Management
  tags:
  - User Management and SCIM 2.0 API - Trait
  - Service User Management API
  - User Management and SCIM 2.0 API
- name: Other
  tags:
  - Organization Management API
  - Pricing information - Node sizes