Learn R Programming

paws (version 0.1.12)

eks: Amazon Elastic Kubernetes Service

Description

Amazon Elastic Kubernetes Service (Amazon EKS) is a managed service that makes it easy for you to run Kubernetes on AWS without needing to stand up or maintain your own Kubernetes control plane. Kubernetes is an open-source system for automating the deployment, scaling, and management of containerized applications.

Amazon EKS runs up-to-date versions of the open-source Kubernetes software, so you can use all the existing plugins and tooling from the Kubernetes community. Applications running on Amazon EKS are fully compatible with applications running on any standard Kubernetes environment, whether running in on-premises data centers or public clouds. This means that you can easily migrate any standard Kubernetes application to Amazon EKS without any code modification required.

Usage

eks(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

Service syntax

svc <- eks(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

create_addonCreates an Amazon EKS add-on
create_clusterCreates an Amazon EKS control plane
create_fargate_profileCreates an AWS Fargate profile for your Amazon EKS cluster
create_nodegroupCreates a managed worker node group for an Amazon EKS cluster
delete_addonDelete an Amazon EKS add-on
delete_clusterDeletes the Amazon EKS cluster control plane
delete_fargate_profileDeletes an AWS Fargate profile
delete_nodegroupDeletes an Amazon EKS node group for a cluster
describe_addonDescribes an Amazon EKS add-on
describe_addon_versionsDescribes the Kubernetes versions that the add-on can be used with
describe_clusterReturns descriptive information about an Amazon EKS cluster
describe_fargate_profileReturns descriptive information about an AWS Fargate profile
describe_nodegroupReturns descriptive information about an Amazon EKS node group
describe_updateReturns descriptive information about an update against your Amazon EKS cluster or associated managed node group
list_addonsLists the available add-ons
list_clustersLists the Amazon EKS clusters in your AWS account in the specified Region
list_fargate_profilesLists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region
list_nodegroupsLists the Amazon EKS managed node groups associated with the specified cluster in your AWS account in the specified Region
list_tags_for_resourceList the tags for an Amazon EKS resource
list_updatesLists the updates associated with an Amazon EKS cluster or managed node group in your AWS account, in the specified Region
tag_resourceAssociates the specified tags to a resource with the specified resourceArn
untag_resourceDeletes specified tags from a resource
update_addonUpdates an Amazon EKS add-on
update_cluster_configUpdates an Amazon EKS cluster configuration
update_cluster_versionUpdates an Amazon EKS cluster to the specified Kubernetes version
update_nodegroup_configUpdates an Amazon EKS managed node group configuration
update_nodegroup_versionUpdates the Kubernetes version or AMI version of an Amazon EKS managed node group

Examples

Run this code
if (FALSE) {
svc <- eks()
# The following example creates an Amazon EKS cluster called prod.
svc$create_cluster(
  version = "1.10",
  name = "prod",
  clientRequestToken = "1d2129a1-3d38-460a-9756-e5b91fddb951",
  resourcesVpcConfig = list(
    securityGroupIds = list(
      "sg-6979fe18"
    ),
    subnetIds = list(
      "subnet-6782e71e",
      "subnet-e7e761ac"
    )
  ),
  roleArn = "arn:aws:iam::012345678910:role/eks-service-role-AWSServiceRole..."
)
}

Run the code above in your browser using DataLab