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 setup 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_access_policy	Associates an access policy and its scope to an access entry
associate_encryption_config	Associates an encryption configuration to an existing cluster
associate_identity_provider_config	Associates an identity provider configuration to a cluster
create_access_entry	Creates an access entry
create_addon	Creates an Amazon EKS add-on
create_cluster	Creates an Amazon EKS control plane
create_eks_anywhere_subscription	Creates an EKS Anywhere subscription
create_fargate_profile	Creates an Fargate profile for your Amazon EKS cluster
create_nodegroup	Creates a managed node group for an Amazon EKS cluster
create_pod_identity_association	Creates an EKS Pod Identity association between a service account in an Amazon EKS cluster and an IAM role with EKS Pod Identity
delete_access_entry	Deletes an access entry
delete_addon	Deletes an Amazon EKS add-on
delete_cluster	Deletes an Amazon EKS cluster control plane
delete_eks_anywhere_subscription	Deletes an expired or inactive subscription
delete_fargate_profile	Deletes an Fargate profile
delete_nodegroup	Deletes a managed node group
delete_pod_identity_association	Deletes a EKS Pod Identity association
deregister_cluster	Deregisters a connected cluster to remove it from the Amazon EKS control plane
describe_access_entry	Describes an access entry
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	Describes an Amazon EKS cluster
describe_eks_anywhere_subscription	Returns descriptive information about a subscription
describe_fargate_profile	Describes an Fargate profile
describe_identity_provider_config	Describes an identity provider configuration
describe_insight	Returns details about an insight that you specify using its ID
describe_nodegroup	Describes a managed node group
describe_pod_identity_association	Returns descriptive information about an EKS Pod Identity association
describe_update	Describes an update to an Amazon EKS resource
disassociate_access_policy	Disassociates an access policy from an access entry
disassociate_identity_provider_config	Disassociates an identity provider configuration from a cluster
list_access_entries	Lists the access entries for your cluster
list_access_policies	Lists the available access policies
list_addons	Lists the installed add-ons
list_associated_access_policies	Lists the access policies associated with an access entry
list_clusters	Lists the Amazon EKS clusters in your Amazon Web Services account in the specified Amazon Web Services Region
list_eks_anywhere_subscriptions	Displays the full description of the subscription
list_fargate_profiles	Lists the Fargate profiles associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region
list_identity_provider_configs	Lists the identity provider configurations for your cluster
list_insights	Returns a list of all insights checked for against the specified cluster
list_nodegroups	Lists the managed node groups associated with the specified cluster in your Amazon Web Services account in the specified Amazon Web Services Region
list_pod_identity_associations	List the EKS Pod Identity associations in a cluster
list_tags_for_resource	List the tags for an Amazon EKS resource
list_updates	Lists the updates associated with an Amazon EKS resource in your Amazon Web Services account, in the specified Amazon Web Services Region
register_cluster	Connects a Kubernetes cluster to the Amazon EKS control plane
tag_resource	Associates the specified tags to an Amazon EKS resource with the specified resourceArn
untag_resource	Deletes specified tags from an Amazon EKS resource
update_access_entry	Updates an access entry
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_eks_anywhere_subscription	Update an EKS Anywhere Subscription
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
update_pod_identity_association	Updates a EKS Pod Identity association

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. 17, 2024, 5:07 p.m.