eks: Amazon Elastic Kubernetes Service

In paws: Amazon Web Services Software Development Kit

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 Amazon Web Services 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(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials. endpoint: The complete URL to use for the constructed client. region: The AWS Region used in instantiating the client. close_connection: Immediately close all HTTP connections. timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds. s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: access_key_id: AWS access key ID secret_access_key: AWS secret access key session_token: AWS temporary session token profile: The name of a profile to use. If not given, then the default profile is used. anonymous: Set anonymous credentials.
endpoint	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

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.

Service syntax

svc <- eks(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

associate_encryption_config	Associate encryption configuration to an existing cluster
associate_identity_provider_config	Associate an identity provider configuration to a cluster
create_addon	Creates an Amazon EKS add-on
create_cluster	Creates an Amazon EKS control plane
create_fargate_profile	Creates an Fargate profile for your Amazon EKS cluster
create_nodegroup	Creates a managed node group for an Amazon EKS cluster
delete_addon	Delete an Amazon EKS add-on
delete_cluster	Deletes the Amazon EKS cluster control plane
delete_fargate_profile	Deletes an Fargate profile
delete_nodegroup	Deletes an Amazon EKS node group for a cluster
deregister_cluster	Deregisters a connected cluster to remove it from the Amazon EKS control plane
describe_addon	Describes an Amazon EKS add-on
describe_addon_configuration	Returns configuration options
describe_addon_versions	Describes the versions for an add-on
describe_cluster	Returns descriptive information about an Amazon EKS cluster
describe_fargate_profile	Returns descriptive information about an Fargate profile
describe_identity_provider_config	Returns descriptive information about an identity provider configuration
describe_nodegroup	Returns descriptive information about an Amazon EKS node group
describe_update	Returns descriptive information about an update against your Amazon EKS cluster or associated managed node group or Amazon EKS add-on
disassociate_identity_provider_config	Disassociates an identity provider configuration from a cluster
list_addons	Lists the available add-ons
list_clusters	Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Region
list_fargate_profiles	Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Region
list_identity_provider_configs	A list of identity provider configurations
list_nodegroups	Lists the Amazon EKS managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Region
list_tags_for_resource	List the tags for an Amazon EKS resource
list_updates	Lists the updates associated with an Amazon EKS cluster or managed node group in your Amazon Web Services account, in the specified Region
register_cluster	Connects a Kubernetes cluster to the Amazon EKS control plane
tag_resource	Associates the specified tags to a resource with the specified resourceArn
untag_resource	Deletes specified tags from a resource
update_addon	Updates an Amazon EKS add-on
update_cluster_config	Updates an Amazon EKS cluster configuration
update_cluster_version	Updates an Amazon EKS cluster to the specified Kubernetes version
update_nodegroup_config	Updates an Amazon EKS managed node group configuration
update_nodegroup_version	Updates the Kubernetes version or AMI version of an Amazon EKS managed node group

Examples

## Not run: 
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..."
)

## End(Not run)

paws documentation built on Sept. 15, 2023, 5:06 p.m.