Get cluster options | Astronomer Documentation

[
  {
    "databaseInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "defaultDatabaseInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultNodeInstance": {
      "cpu": 4,
      "memory": "16Gi",
      "name": "e2-standard-4"
    },
    "defaultRegion": {
      "name": "us-east-1",
      "bannedInstances": [
        "t3.medium"
      ],
      "limited": true
    },
    "defaultVpcSubnetRange": "172.20.0.0/19",
    "nodeCountDefault": 20,
    "nodeCountMax": 100,
    "nodeCountMin": 2,
    "nodeInstances": [
      {
        "cpu": 4,
        "memory": "16Gi",
        "name": "e2-standard-4"
      }
    ],
    "provider": "AWS",
    "regions": [
      {
        "name": "us-east-1",
        "bannedInstances": [
          "t3.medium"
        ],
        "limited": true
      }
    ],
    "defaultPodSubnetRange": "172.21.0.0/19",
    "defaultServicePeeringRange": "172.23.0.0/20",
    "defaultServiceSubnetRange": "172.22.0.0/22"
  }
]

Get all possible options for configuring a cluster.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired

The ID of the Organization to get cluster options for.

Query parameters

providerenumOptional

The cluster's cloud provider.

Allowed values:

typeenumRequired

The cluster type.

Allowed values:

Response

databaseInstanceslist of objects

The available database instances.

defaultDatabaseInstanceobject

defaultNodeInstanceobject

defaultRegionobject

defaultVpcSubnetRangestring

The default VPC subnet range.

nodeCountDefaultinteger

The default number of nodes.

nodeCountMaxinteger

The maximum number of nodes.

nodeCountMininteger

The minimum number of nodes.

nodeInstanceslist of objects

The available node instances.

providerenum

The cloud provider.

regionslist of objects

The available regions.

defaultPodSubnetRangestring

The default pod subnet range.

defaultServicePeeringRangestring

The default service peering range.

defaultServiceSubnetRangestring

The default service subnet range.

Errors

400

Get Cluster Options Request Bad Request Error

401

Get Cluster Options Request Unauthorized Error

403

Get Cluster Options Request Forbidden Error

404

Get Cluster Options Request Not Found Error

500

Get Cluster Options Request Internal Server Error

$	curl -G https://api.astronomer.io/platform/v1beta1/organizations/organizationId/cluster-options \
>	-H "Authorization: Bearer <token>" \
>	-d provider=AWS \
>	-d type=DEDICATED