Cluster

eks.services.k8s.aws/v1alpha1

TypeLink
GoDoceks-controller/apis/v1alpha1#Cluster

Metadata

PropertyValue
ScopeNamespaced
KindCluster
ListKindClusterList
Pluralclusters
Singularcluster

An object representing an Amazon EKS cluster.

Spec

clientRequestToken: string
encryptionConfig:
  provider: 
    keyARN: string
  resources:
  - string
kubernetesNetworkConfig: 
  ipFamily: string
  serviceIPv4CIDR: string
logging: 
  clusterLogging:
  - enabled: boolean
    types:
    - string
name: string
resourcesVPCConfig: 
  endpointPrivateAccess: boolean
  endpointPublicAccess: boolean
  publicAccessCIDRs:
  - string
  securityGroupIDs:
  - string
  subnetIDs:
  - string
roleARN: string
tags: {}
version: string
FieldDescription
clientRequestToken
Optional
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
encryptionConfig
Optional
array
The encryption configuration for the cluster.
encryptionConfig.[]
Required
object
The encryption configuration for the cluster.
encryptionConfig.[].provider.keyARN
Optional
string
encryptionConfig.[].resources
Optional
array
encryptionConfig.[].resources.[]
Required
string
kubernetesNetworkConfig.ipFamily
Optional
string
kubernetesNetworkConfig.serviceIPv4CIDR
Optional
string
logging
Optional
object
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 (https://docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html) 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 (http://aws.amazon.com/cloudwatch/pricing/).
logging.clusterLogging
Optional
array
logging.clusterLogging.[]
Required
object
An object representing the enabled or disabled Kubernetes control plane logs for your cluster.
logging.clusterLogging.[].types
Optional
array
logging.clusterLogging.[].types.[]
Required
string
resourcesVPCConfig
Required
object
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 (https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html) and Cluster Security Group Considerations (https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html) 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.
resourcesVPCConfig.endpointPrivateAccess
Optional
boolean
resourcesVPCConfig.endpointPublicAccess
Optional
boolean
resourcesVPCConfig.publicAccessCIDRs
Optional
array
resourcesVPCConfig.publicAccessCIDRs.[]
Required
string
resourcesVPCConfig.securityGroupIDs.[]
Required
string
resourcesVPCConfig.subnetIDs.[]
Required
string
tags
Optional
object
The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.
version
Optional
string
The desired Kubernetes version for your cluster. If you don’t specify a value here, the latest version available in Amazon EKS is used.

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
certificateAuthority: 
  data: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
connectorConfig: 
  activationCode: string
  activationExpiry: string
  activationID: string
  provider: string
  roleARN: string
createdAt: string
endpoint: string
identity: 
  oidc: 
    issuer: string
platformVersion: string
status: string
FieldDescription
ackResourceMetadata
Optional
object
All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource
ackResourceMetadata.arn
Optional
string
ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270
ackResourceMetadata.ownerAccountID
Required
string
OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource.
ackResourceMetadata.region
Required
string
Region is the AWS region in which the resource exists or will exist.
certificateAuthority
Optional
object
The certificate-authority-data for your cluster.
certificateAuthority.data
Optional
string
conditions
Optional
array
All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource
conditions.[]
Required
object
Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource
conditions.[].message
Optional
string
A human readable message indicating details about the transition.
conditions.[].reason
Optional
string
The reason for the condition’s last transition.
conditions.[].status
Optional
string
Status of the condition, one of True, False, Unknown.
conditions.[].type
Optional
string
Type is the type of the Condition
connectorConfig
Optional
object
The configuration used to connect to a cluster for registration.
connectorConfig.activationCode
Optional
string
connectorConfig.activationExpiry
Optional
string
connectorConfig.activationID
Optional
string
connectorConfig.provider
Optional
string
connectorConfig.roleARN
Optional
string
createdAt
Optional
string
The Unix epoch timestamp in seconds for when the cluster was created.
endpoint
Optional
string
The endpoint for your Kubernetes API server.
identity
Optional
object
The identity provider information for the cluster.
identity.oidc
Optional
object
An object representing the OpenID Connect (https://openid.net/connect/) (OIDC) identity provider information for the cluster.
identity.oidc.issuer
Optional
string
platformVersion
Optional
string
The platform version of your Amazon EKS cluster. For more information, see Platform Versions (https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html) in the Amazon EKS User Guide .
status
Optional
string
The current status of the cluster.