Create Cluster
eks_create_cluster | R Documentation |
Creates an Amazon EKS control plane¶
Description¶
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. 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.
Usage¶
eks_create_cluster(name, version, roleArn, resourcesVpcConfig,
kubernetesNetworkConfig, logging, clientRequestToken, tags,
encryptionConfig, outpostConfig, accessConfig,
bootstrapSelfManagedAddons, upgradePolicy)
Arguments¶
name
[required] The unique name to give to your cluster.
version
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.
roleArn
[required] 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 .
resourcesVpcConfig
[required] 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.
kubernetesNetworkConfig
The Kubernetes network configuration for the cluster.
logging
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.
clientRequestToken
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
tags
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.
encryptionConfig
The encryption configuration for the cluster.
outpostConfig
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.
accessConfig
The access configuration for the cluster.
bootstrapSelfManagedAddons
If you set this value to
False
when creating a cluster, the default networking add-ons will not be installed.The default networking addons 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.
upgradePolicy
New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to
STANDARD
.
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"
),
upgradePolicy = list(
supportType = "STANDARD"|"EXTENDED"
)
)
)
Request syntax¶
svc$create_cluster(
name = "string",
version = "string",
roleArn = "string",
resourcesVpcConfig = list(
subnetIds = list(
"string"
),
securityGroupIds = list(
"string"
),
endpointPublicAccess = TRUE|FALSE,
endpointPrivateAccess = TRUE|FALSE,
publicAccessCidrs = list(
"string"
)
),
kubernetesNetworkConfig = list(
serviceIpv4Cidr = "string",
ipFamily = "ipv4"|"ipv6"
),
logging = list(
clusterLogging = list(
list(
types = list(
"api"|"audit"|"authenticator"|"controllerManager"|"scheduler"
),
enabled = TRUE|FALSE
)
)
),
clientRequestToken = "string",
tags = list(
"string"
),
encryptionConfig = list(
list(
resources = list(
"string"
),
provider = list(
keyArn = "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"
),
bootstrapSelfManagedAddons = TRUE|FALSE,
upgradePolicy = list(
supportType = "STANDARD"|"EXTENDED"
)
)
Examples¶
## Not run:
# 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)