Skip to content

/AWS1/CL_EKS=>CREATECLUSTER()

About CreateCluster

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by Amazon Web Services, and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS nodes run in your Amazon Web Services account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpointPublicAccess and endpointPrivateAccess parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the ipFamily for the cluster. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide.

Method Signature

IMPORTING

Required arguments:

iv_name TYPE /AWS1/EKSCLUSTERNAME /AWS1/EKSCLUSTERNAME

The unique name to give to your cluster. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphanumeric character and can't be longer than 100 characters. The name must be unique within the Amazon Web Services Region and Amazon Web Services account that you're creating the cluster in.

iv_rolearn TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

io_resourcesvpcconfig TYPE REF TO /AWS1/CL_EKSVPCCONFIGREQUEST /AWS1/CL_EKSVPCCONFIGREQUEST

The VPC configuration that's used by the cluster control plane. Amazon EKS VPC resources have specific requirements to work properly with Kubernetes. For more information, see Cluster VPC Considerations and Cluster Security Group Considerations in the Amazon EKS User Guide. You must specify at least two subnets. You can specify up to five security groups. However, we recommend that you use a dedicated security group for your cluster control plane.

Optional arguments:

iv_version TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

The desired Kubernetes version for your cluster. If you don't specify a value here, the default version available in Amazon EKS is used.

The default version might not be the latest version available.

io_kubernetesnetworkconfig TYPE REF TO /AWS1/CL_EKSKUBERNETESNETWOR00 /AWS1/CL_EKSKUBERNETESNETWOR00

The Kubernetes network configuration for the cluster.

io_logging TYPE REF TO /AWS1/CL_EKSLOGGING /AWS1/CL_EKSLOGGING

Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs . By default, cluster control plane logs aren't exported to CloudWatch Logs . For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

iv_clientrequesttoken TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

it_tags TYPE /AWS1/CL_EKSTAGMAP_W=>TT_TAGMAP TT_TAGMAP

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

it_encryptionconfig TYPE /AWS1/CL_EKSENCRYPTIONCONFIG=>TT_ENCRYPTIONCONFIGLIST TT_ENCRYPTIONCONFIGLIST

The encryption configuration for the cluster.

io_outpostconfig TYPE REF TO /AWS1/CL_EKSOUTPOSTCONFIGREQ /AWS1/CL_EKSOUTPOSTCONFIGREQ

An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn't available for creating Amazon EKS clusters on the Amazon Web Services cloud.

io_accessconfig TYPE REF TO /AWS1/CL_EKSCREATEACCCONFIGREQ /AWS1/CL_EKSCREATEACCCONFIGREQ

The access configuration for the cluster.

iv_bootstrapselfmanagedadd00 TYPE /AWS1/EKSBOXEDBOOLEAN /AWS1/EKSBOXEDBOOLEAN

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

The default networking add-ons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

io_upgradepolicy TYPE REF TO /AWS1/CL_EKSUPGRADEPOLICYREQ /AWS1/CL_EKSUPGRADEPOLICYREQ

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

io_zonalshiftconfig TYPE REF TO /AWS1/CL_EKSZONALSHIFTCFGREQ /AWS1/CL_EKSZONALSHIFTCFGREQ

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.

You can start a zonal shift for an Amazon EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your Amazon EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .

io_remotenetworkconfig TYPE REF TO /AWS1/CL_EKSREMOTENETWORKCFG00 /AWS1/CL_EKSREMOTENETWORKCFG00

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

io_computeconfig TYPE REF TO /AWS1/CL_EKSCOMPUTECONFIGREQ /AWS1/CL_EKSCOMPUTECONFIGREQ

Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account

io_storageconfig TYPE REF TO /AWS1/CL_EKSSTORAGECONFIGREQ /AWS1/CL_EKSSTORAGECONFIGREQ

Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

RETURNING

oo_output TYPE REF TO /aws1/cl_ekscreateclusterrsp /AWS1/CL_EKSCREATECLUSTERRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->/aws1/if_eks~createcluster(
  io_accessconfig = new /aws1/cl_ekscreateaccconfigreq(
    iv_authenticationmode = |string|
    iv_bootstrapclstcreatoradm00 = ABAP_TRUE
  )
  io_computeconfig = new /aws1/cl_ekscomputeconfigreq(
    it_nodepools = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |string| ) )
    )
    iv_enabled = ABAP_TRUE
    iv_noderolearn = |string|
  )
  io_kubernetesnetworkconfig = new /aws1/cl_ekskubernetesnetwor00(
    io_elasticloadbalancing = new /aws1/cl_ekselasticloadbalan00( ABAP_TRUE )
    iv_ipfamily = |string|
    iv_serviceipv4cidr = |string|
  )
  io_logging = new /aws1/cl_ekslogging(
    it_clusterlogging = VALUE /aws1/cl_ekslogsetup=>tt_logsetups(
      (
        new /aws1/cl_ekslogsetup(
          it_types = VALUE /aws1/cl_ekslogtypes_w=>tt_logtypes(
            ( new /aws1/cl_ekslogtypes_w( |string| ) )
          )
          iv_enabled = ABAP_TRUE
        )
      )
    )
  )
  io_outpostconfig = new /aws1/cl_eksoutpostconfigreq(
    io_controlplaneplacement = new /aws1/cl_eksctlplaneplcmtreq( |string| )
    it_outpostarns = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |string| ) )
    )
    iv_controlplaneinstancetype = |string|
  )
  io_remotenetworkconfig = new /aws1/cl_eksremotenetworkcfg00(
    it_remotenodenetworks = VALUE /aws1/cl_eksremotenodenetwork=>tt_remotenodenetworklist(
      (
        new /aws1/cl_eksremotenodenetwork(
          it_cidrs = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
            ( new /aws1/cl_eksstringlist_w( |string| ) )
          )
        )
      )
    )
    it_remotepodnetworks = VALUE /aws1/cl_eksremotepodnetwork=>tt_remotepodnetworklist(
      (
        new /aws1/cl_eksremotepodnetwork(
          it_cidrs = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
            ( new /aws1/cl_eksstringlist_w( |string| ) )
          )
        )
      )
    )
  )
  io_resourcesvpcconfig = new /aws1/cl_eksvpcconfigrequest(
    it_publicaccesscidrs = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |string| ) )
    )
    it_securitygroupids = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |string| ) )
    )
    it_subnetids = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |string| ) )
    )
    iv_endpointprivateaccess = ABAP_TRUE
    iv_endpointpublicaccess = ABAP_TRUE
  )
  io_storageconfig = new /aws1/cl_eksstorageconfigreq( new /aws1/cl_eksblockstorage( ABAP_TRUE ) )
  io_upgradepolicy = new /aws1/cl_eksupgradepolicyreq( |string| )
  io_zonalshiftconfig = new /aws1/cl_ekszonalshiftcfgreq( ABAP_TRUE )
  it_encryptionconfig = VALUE /aws1/cl_eksencryptionconfig=>tt_encryptionconfiglist(
    (
      new /aws1/cl_eksencryptionconfig(
        io_provider = new /aws1/cl_eksprovider( |string| )
        it_resources = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
          ( new /aws1/cl_eksstringlist_w( |string| ) )
        )
      )
    )
  )
  it_tags = VALUE /aws1/cl_ekstagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_ekstagmap_w=>ts_tagmap_maprow(
        value = new /aws1/cl_ekstagmap_w( |string| )
        key = |string|
      )
    )
  )
  iv_bootstrapselfmanagedadd00 = ABAP_TRUE
  iv_clientrequesttoken = |string|
  iv_name = |string|
  iv_rolearn = |string|
  iv_version = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_cluster = lo_result->get_cluster( ).
  IF lo_cluster IS NOT INITIAL.
    lv_string = lo_cluster->get_name( ).
    lv_string = lo_cluster->get_arn( ).
    lv_timestamp = lo_cluster->get_createdat( ).
    lv_string = lo_cluster->get_version( ).
    lv_string = lo_cluster->get_endpoint( ).
    lv_string = lo_cluster->get_rolearn( ).
    lo_vpcconfigresponse = lo_cluster->get_resourcesvpcconfig( ).
    IF lo_vpcconfigresponse IS NOT INITIAL.
      LOOP AT lo_vpcconfigresponse->get_subnetids( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_vpcconfigresponse->get_securitygroupids( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_vpcconfigresponse->get_clustersecuritygroupid( ).
      lv_string = lo_vpcconfigresponse->get_vpcid( ).
      lv_boolean = lo_vpcconfigresponse->get_endpointpublicaccess( ).
      lv_boolean = lo_vpcconfigresponse->get_endpointprivateaccess( ).
      LOOP AT lo_vpcconfigresponse->get_publicaccesscidrs( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_kubernetesnetworkconfig = lo_cluster->get_kubernetesnetworkconfig( ).
    IF lo_kubernetesnetworkconfig IS NOT INITIAL.
      lv_string = lo_kubernetesnetworkconfig->get_serviceipv4cidr( ).
      lv_string = lo_kubernetesnetworkconfig->get_serviceipv6cidr( ).
      lv_ipfamily = lo_kubernetesnetworkconfig->get_ipfamily( ).
      lo_elasticloadbalancing = lo_kubernetesnetworkconfig->get_elasticloadbalancing( ).
      IF lo_elasticloadbalancing IS NOT INITIAL.
        lv_boxedboolean = lo_elasticloadbalancing->get_enabled( ).
      ENDIF.
    ENDIF.
    lo_logging = lo_cluster->get_logging( ).
    IF lo_logging IS NOT INITIAL.
      LOOP AT lo_logging->get_clusterlogging( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          LOOP AT lo_row_3->get_types( ) into lo_row_4.
            lo_row_5 = lo_row_4.
            IF lo_row_5 IS NOT INITIAL.
              lv_logtype = lo_row_5->get_value( ).
            ENDIF.
          ENDLOOP.
          lv_boxedboolean = lo_row_3->get_enabled( ).
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_identity = lo_cluster->get_identity( ).
    IF lo_identity IS NOT INITIAL.
      lo_oidc = lo_identity->get_oidc( ).
      IF lo_oidc IS NOT INITIAL.
        lv_string = lo_oidc->get_issuer( ).
      ENDIF.
    ENDIF.
    lv_clusterstatus = lo_cluster->get_status( ).
    lo_certificate = lo_cluster->get_certificateauthority( ).
    IF lo_certificate IS NOT INITIAL.
      lv_string = lo_certificate->get_data( ).
    ENDIF.
    lv_string = lo_cluster->get_clientrequesttoken( ).
    lv_string = lo_cluster->get_platformversion( ).
    LOOP AT lo_cluster->get_tags( ) into ls_row_6.
      lv_key = ls_row_6-key.
      lo_value = ls_row_6-value.
      IF lo_value IS NOT INITIAL.
        lv_tagvalue = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
    LOOP AT lo_cluster->get_encryptionconfig( ) into lo_row_7.
      lo_row_8 = lo_row_7.
      IF lo_row_8 IS NOT INITIAL.
        LOOP AT lo_row_8->get_resources( ) into lo_row.
          lo_row_1 = lo_row.
          IF lo_row_1 IS NOT INITIAL.
            lv_string = lo_row_1->get_value( ).
          ENDIF.
        ENDLOOP.
        lo_provider = lo_row_8->get_provider( ).
        IF lo_provider IS NOT INITIAL.
          lv_string = lo_provider->get_keyarn( ).
        ENDIF.
      ENDIF.
    ENDLOOP.
    lo_connectorconfigresponse = lo_cluster->get_connectorconfig( ).
    IF lo_connectorconfigresponse IS NOT INITIAL.
      lv_string = lo_connectorconfigresponse->get_activationid( ).
      lv_string = lo_connectorconfigresponse->get_activationcode( ).
      lv_timestamp = lo_connectorconfigresponse->get_activationexpiry( ).
      lv_string = lo_connectorconfigresponse->get_provider( ).
      lv_string = lo_connectorconfigresponse->get_rolearn( ).
    ENDIF.
    lv_string = lo_cluster->get_id( ).
    lo_clusterhealth = lo_cluster->get_health( ).
    IF lo_clusterhealth IS NOT INITIAL.
      LOOP AT lo_clusterhealth->get_issues( ) into lo_row_9.
        lo_row_10 = lo_row_9.
        IF lo_row_10 IS NOT INITIAL.
          lv_clusterissuecode = lo_row_10->get_code( ).
          lv_string = lo_row_10->get_message( ).
          LOOP AT lo_row_10->get_resourceids( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_string = lo_row_1->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_outpostconfigresponse = lo_cluster->get_outpostconfig( ).
    IF lo_outpostconfigresponse IS NOT INITIAL.
      LOOP AT lo_outpostconfigresponse->get_outpostarns( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_outpostconfigresponse->get_controlplaneinstancetype( ).
      lo_controlplaneplacementre = lo_outpostconfigresponse->get_controlplaneplacement( ).
      IF lo_controlplaneplacementre IS NOT INITIAL.
        lv_string = lo_controlplaneplacementre->get_groupname( ).
      ENDIF.
    ENDIF.
    lo_accessconfigresponse = lo_cluster->get_accessconfig( ).
    IF lo_accessconfigresponse IS NOT INITIAL.
      lv_boxedboolean = lo_accessconfigresponse->get_bootstrapclstcreatorad00( ).
      lv_authenticationmode = lo_accessconfigresponse->get_authenticationmode( ).
    ENDIF.
    lo_upgradepolicyresponse = lo_cluster->get_upgradepolicy( ).
    IF lo_upgradepolicyresponse IS NOT INITIAL.
      lv_supporttype = lo_upgradepolicyresponse->get_supporttype( ).
    ENDIF.
    lo_zonalshiftconfigrespons = lo_cluster->get_zonalshiftconfig( ).
    IF lo_zonalshiftconfigrespons IS NOT INITIAL.
      lv_boxedboolean = lo_zonalshiftconfigrespons->get_enabled( ).
    ENDIF.
    lo_remotenetworkconfigresp = lo_cluster->get_remotenetworkconfig( ).
    IF lo_remotenetworkconfigresp IS NOT INITIAL.
      LOOP AT lo_remotenetworkconfigresp->get_remotenodenetworks( ) into lo_row_11.
        lo_row_12 = lo_row_11.
        IF lo_row_12 IS NOT INITIAL.
          LOOP AT lo_row_12->get_cidrs( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_string = lo_row_1->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
      LOOP AT lo_remotenetworkconfigresp->get_remotepodnetworks( ) into lo_row_13.
        lo_row_14 = lo_row_13.
        IF lo_row_14 IS NOT INITIAL.
          LOOP AT lo_row_14->get_cidrs( ) into lo_row.
            lo_row_1 = lo_row.
            IF lo_row_1 IS NOT INITIAL.
              lv_string = lo_row_1->get_value( ).
            ENDIF.
          ENDLOOP.
        ENDIF.
      ENDLOOP.
    ENDIF.
    lo_computeconfigresponse = lo_cluster->get_computeconfig( ).
    IF lo_computeconfigresponse IS NOT INITIAL.
      lv_boxedboolean = lo_computeconfigresponse->get_enabled( ).
      LOOP AT lo_computeconfigresponse->get_nodepools( ) into lo_row.
        lo_row_1 = lo_row.
        IF lo_row_1 IS NOT INITIAL.
          lv_string = lo_row_1->get_value( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_computeconfigresponse->get_noderolearn( ).
    ENDIF.
    lo_storageconfigresponse = lo_cluster->get_storageconfig( ).
    IF lo_storageconfigresponse IS NOT INITIAL.
      lo_blockstorage = lo_storageconfigresponse->get_blockstorage( ).
      IF lo_blockstorage IS NOT INITIAL.
        lv_boxedboolean = lo_blockstorage->get_enabled( ).
      ENDIF.
    ENDIF.
  ENDIF.
ENDIF.

To create a new cluster

The following example creates an Amazon EKS cluster called prod.

DATA(lo_result) = lo_client->/aws1/if_eks~createcluster(
  io_resourcesvpcconfig = new /aws1/cl_eksvpcconfigrequest(
    it_securitygroupids = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |sg-6979fe18| ) )
    )
    it_subnetids = VALUE /aws1/cl_eksstringlist_w=>tt_stringlist(
      ( new /aws1/cl_eksstringlist_w( |subnet-6782e71e| ) )
      ( new /aws1/cl_eksstringlist_w( |subnet-e7e761ac| ) )
    )
  )
  iv_clientrequesttoken = |1d2129a1-3d38-460a-9756-e5b91fddb951|
  iv_name = |prod|
  iv_rolearn = |arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRoleForAmazonEKS-J7ONKE3BQ4PI|
  iv_version = |1.10|
).