Delete Cluster

eks_delete_cluster

R Documentation

Deletes an Amazon EKS cluster control plane

Description

Deletes an Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a cluster in the Amazon EKS User Guide.

If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodgroup and delete_fargate_profile.

Usage

eks_delete_cluster(name)

Arguments

name

[required] The name of the cluster to delete.

Value

A list with the following syntax:

list(
  cluster = list(
    name = "string",
    arn = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    version = "string",
    endpoint = "string",
    roleArn = "string",
    resourcesVpcConfig = list(
      subnetIds = list(
        "string"
      ),
      securityGroupIds = list(
        "string"
      ),
      clusterSecurityGroupId = "string",
      vpcId = "string",
      endpointPublicAccess = TRUE|FALSE,
      endpointPrivateAccess = TRUE|FALSE,
      publicAccessCidrs = list(
        "string"
      )
    ),
    kubernetesNetworkConfig = list(
      serviceIpv4Cidr = "string",
      serviceIpv6Cidr = "string",
      ipFamily = "ipv4"|"ipv6"
    ),
    logging = list(
      clusterLogging = list(
        list(
          types = list(
            "api"|"audit"|"authenticator"|"controllerManager"|"scheduler"
          ),
          enabled = TRUE|FALSE
        )
      )
    ),
    identity = list(
      oidc = list(
        issuer = "string"
      )
    ),
    status = "CREATING"|"ACTIVE"|"DELETING"|"FAILED"|"UPDATING"|"PENDING",
    certificateAuthority = list(
      data = "string"
    ),
    clientRequestToken = "string",
    platformVersion = "string",
    tags = list(
      "string"
    ),
    encryptionConfig = list(
      list(
        resources = list(
          "string"
        ),
        provider = list(
          keyArn = "string"
        )
      )
    ),
    connectorConfig = list(
      activationId = "string",
      activationCode = "string",
      activationExpiry = as.POSIXct(
        "2015-01-01"
      ),
      provider = "string",
      roleArn = "string"
    ),
    id = "string",
    health = list(
      issues = list(
        list(
          code = "AccessDenied"|"ClusterUnreachable"|"ConfigurationConflict"|"InternalFailure"|"ResourceLimitExceeded"|"ResourceNotFound"|"IamRoleNotFound"|"VpcNotFound"|"InsufficientFreeAddresses"|"Ec2ServiceNotSubscribed"|"Ec2SubnetNotFound"|"Ec2SecurityGroupNotFound"|"KmsGrantRevoked"|"KmsKeyNotFound"|"KmsKeyMarkedForDeletion"|"KmsKeyDisabled"|"StsRegionalEndpointDisabled"|"UnsupportedVersion"|"Other",
          message = "string",
          resourceIds = list(
            "string"
          )
        )
      )
    ),
    outpostConfig = list(
      outpostArns = list(
        "string"
      ),
      controlPlaneInstanceType = "string",
      controlPlanePlacement = list(
        groupName = "string"
      )
    ),
    accessConfig = list(
      bootstrapClusterCreatorAdminPermissions = TRUE|FALSE,
      authenticationMode = "API"|"API_AND_CONFIG_MAP"|"CONFIG_MAP"
    )
  )
)

Request syntax

svc$delete_cluster(
  name = "string"
)

Examples

## Not run: 
# This example command deletes a cluster named `devel` in your default
# region.
svc$delete_cluster(
  name = "devel"
)

## End(Not run)