Skip to main content

Updates the cluster configuration information

PUT 

/v1/cloudconfigs/eks/:configUid/clusterConfig

Updates the cluster configuration information

Request

Path Parameters

    configUid stringrequired

    Cluster's cloud config uid

Header Parameters

    ProjectUid string

    Scope the request to the specified project uid

Body

    clusterConfig

    object

    EksClusterConfig defines EKS specific config

    addons

    object[]

    Addons defines the EKS addons to enable with the EKS cluster. This may be required for brownfield clusters

  • Array [

  • conflictResolutionstring

    ConflictResolution is used to declare what should happen if there are parameter conflicts.

    namestringrequired

    Name is the name of the addon

    serviceAccountRoleARNstring

    ServiceAccountRoleArn is the ARN of an IAM role to bind to the addons service account

    versionstringrequired

    Version is the version of the addon to use

  • ]

  • bastionDisabledboolean

    BastionDisabled is the option to disable bastion node

    controlPlaneLoadBalancerstring

    ControlPlaneLoadBalancer specifies how API server elb will be configured, this field is optional, not provided, "", default => "Internet-facing" "Internet-facing" => "Internet-facing" "internal" => "internal" For spectro saas setup we require to talk to the apiserver from our cluster so ControlPlaneLoadBalancer should be "", not provided or "Internet-facing"

    encryptionConfig

    object

    EncryptionConfig specifies the encryption configuration for the cluster

    isEnabledboolean

    Is encryption configuration enabled for the cluster

    providerstring

    Provider specifies the ARN or alias of the CMK (in AWS KMS)

    resourcesstring[]

    Resources specifies the resources to be encrypted

    endpointAccess

    object

    Endpoints specifies access to this cluster's control plane endpoints

    privateboolean

    Private points VPC-internal control plane access to the private endpoint

    privateCIDRsstring[]

    PrivateCIDRs specifies which blocks can access the private endpoint

    publicboolean

    Public controls whether control plane endpoints are publicly accessible

    publicCIDRsstring[]

    PublicCIDRs specifies which blocks can access the public endpoint

    regionstringrequired

    The AWS Region the cluster lives in.

    sshKeyNamestring

    SSHKeyName specifies which EC2 SSH key can be used to access machines.

    vpcIdstring

    VPC Id to deploy cluster into should have one public and one private subnet for the the cluster creation, this field is optional, If VPC Id is not provided a fully managed VPC will be created

Responses

The resource was updated successfully

Loading...