Instaclustr AWS Endpoint Service Principals V2 API

openapi: 3.2.0
info:
  title: Instaclustr AWS Endpoint Service Principals V2 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 AWS Endpoint Service Principals V2 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: AWS Endpoint Service Principals V2
  description: Operations related to AWS endpoint service principals.
  x-insta-tag-group: Cluster Management V2
paths:
  /cluster-management/v2/data-sources/cluster_data_center/{clusterDataCenterId}/aws-endpoint-service-principals/v2/:
    parameters:
    - name: clusterDataCenterId
      in: path
      description: ID of the Cluster Data Center.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    x-terraform-resource-name: aws_endpoint_service_principals_v2
    get:
      tags:
      - AWS Endpoint Service Principals V2
      summary: List all IAM Principal ARNs
      description: Retrieve all the allowed principal for accessing Endpoint Service on a specific cluster data centre. AWS principals, such as AWS accounts, IAM users, and IAM roles used to allow connection from AWS interface endpoint to the endpoint service
      responses:
        '200':
          description: Retrieved IAM Principal ARNs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IamPrincipalArnsV2'
      operationId: getClusterManagementV2DataSourcesClusterDataCenterByClusterDataCenterIdAwsEndpointServicePrincipalsV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/aws-endpoint-service-principals/v2/:
    x-terraform-resource-name: aws_endpoint_service_principal_v2
    post:
      tags:
      - AWS Endpoint Service Principals V2
      summary: Add an IAM Principal ARN on the AWS Endpoint Service
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IamPrincipalArnV2'
        required: true
      responses:
        '202':
          description: Successfully added an IAM Principal ARNs on the AWS Endpoint Service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IamPrincipalArnV2'
              example:
                clusterDataCenterId: f3eab841-6952-430d-ba90-1bfc3f15da10
                id: The Instaclustr ID of the IAM Principal ARN.
                principalArn: arn:aws:iam::123456789012:role/role-name
      x-codegen-request-body-name: body
      operationId: postClusterManagementV2ResourcesAwsEndpointServicePrincipalsV2
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
  /cluster-management/v2/resources/aws-endpoint-service-principals/v2/{principalId}:
    parameters:
    - name: principalId
      in: path
      description: ID of the IAM Principal ARN.
      required: true
      style: simple
      explode: false
      schema:
        type: string
        format: uuid
    get:
      tags:
      - AWS Endpoint Service Principals V2
      summary: Retrieve a single IAM Principal ARN
      description: Get details for a single IAM Principal ARN.
      responses:
        '200':
          description: Retrieved the details an IAM Principal ARN.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IamPrincipalArnV2'
              example:
                clusterDataCenterId: f3eab841-6952-430d-ba90-1bfc3f15da10
                id: The Instaclustr ID of the IAM Principal ARN.
                principalArn: arn:aws:iam::123456789012:role/role-name
        '404':
          description: IAM Principal ARN not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      operationId: getClusterManagementV2ResourcesAwsEndpointServicePrincipalsV2ByPrincipalId
      x-operation-id-source: derived
    delete:
      tags:
      - AWS Endpoint Service Principals V2
      summary: Delete an IAM Principal ARN
      description: Delete an IAM Principal ARN.
      responses:
        '204':
          description: IAM Principal ARN successfully deleted.
          content: {}
        '404':
          description: IAM Principal ARN not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorListResponseV2'
      operationId: deleteClusterManagementV2ResourcesAwsEndpointServicePrincipalsV2ByPrincipalId
      x-operation-id-source: derived
    servers:
    - url: https://api.instaclustr.com
      description: Instaclustr API
components:
  schemas:
    ErrorListResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorResponseV2'
      description: ''
    ErrorResponseV2:
      title: Root Type for ErrorResponse
      type: object
      properties:
        name:
          type: string
        message:
          type: string
      description: ''
    IamPrincipalArnV2:
      required:
      - clusterDataCenterId
      - principalArn
      type: object
      properties:
        clusterDataCenterId:
          type: string
          description: The ID of the cluster data center.
          format: uuid
          x-terraform-force-new: true
        endPointServiceId:
          type: string
          description: The Instaclustr ID of the AWS endpoint service
          x-terraform-computed: true
        id:
          type: string
          description: The Instaclustr ID of the IAM Principal ARN.
          format: uuid
          readOnly: true
        principalArn:
          pattern: ^arn:aws:iam::[0-9]{12}:(root$|user\/[\w+=,.@-]+|role\/[\w+=,.@-]+)$
          type: string
          description: The IAM Principal ARN.
          x-terraform-force-new: true
      description: Definition of an IAM Principal ARN being used for Kafka PrivateLink.
      example:
        clusterDataCenterId: f3eab841-6952-430d-ba90-1bfc3f15da10
        principalArn: arn:aws:iam::123456789012:role/role-name
    IamPrincipalArnsV2:
      type: object
      properties:
        clusterDataCenterId:
          type: string
          description: ID of the cluster data center
          x-terraform-id: true
        iamPrincipalArns:
          type: array
          description: IAM Principal ARNs to allow connection to the AWS Endpoint Service.
          items:
            $ref: '#/components/schemas/IamPrincipalArnV2'
      description: List of IAM Principal ARNs for a cluster data center
  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