/AWS1/CL_EKSCLUSTER¶
An object representing an Amazon EKS cluster.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
IV_NAME TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The name of your cluster.
IV_ARN TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The Amazon Resource Name (ARN) of the cluster.
IV_CREATEDAT TYPE /AWS1/EKSTIMESTAMP /AWS1/EKSTIMESTAMP¶
The Unix epoch timestamp at object creation.
IV_VERSION TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The Kubernetes server version for the cluster.
IV_ENDPOINT TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The endpoint for your Kubernetes API server.
IV_ROLEARN TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
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.
IO_RESOURCESVPCCONFIG TYPE REF TO /AWS1/CL_EKSVPCCONFIGRESPONSE /AWS1/CL_EKSVPCCONFIGRESPONSE¶
The VPC configuration 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.
IO_KUBERNETESNETWORKCONFIG TYPE REF TO /AWS1/CL_EKSKUBERNETESNETWOR01 /AWS1/CL_EKSKUBERNETESNETWOR01¶
The Kubernetes network configuration for the cluster.
IO_LOGGING TYPE REF TO /AWS1/CL_EKSLOGGING /AWS1/CL_EKSLOGGING¶
The logging configuration for your cluster.
IO_IDENTITY TYPE REF TO /AWS1/CL_EKSIDENTITY /AWS1/CL_EKSIDENTITY¶
The identity provider information for the cluster.
IV_STATUS TYPE /AWS1/EKSCLUSTERSTATUS /AWS1/EKSCLUSTERSTATUS¶
The current status of the cluster.
IO_CERTIFICATEAUTHORITY TYPE REF TO /AWS1/CL_EKSCERTIFICATE /AWS1/CL_EKSCERTIFICATE¶
The
certificate-authority-datafor your cluster.
IV_CLIENTREQUESTTOKEN TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
IV_PLATFORMVERSION TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
IT_TAGS TYPE /AWS1/CL_EKSTAGMAP_W=>TT_TAGMAP TT_TAGMAP¶
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.
IT_ENCRYPTIONCONFIG TYPE /AWS1/CL_EKSENCRYPTIONCONFIG=>TT_ENCRYPTIONCONFIGLIST TT_ENCRYPTIONCONFIGLIST¶
The encryption configuration for the cluster.
IO_CONNECTORCONFIG TYPE REF TO /AWS1/CL_EKSCONNECTORCONFIGRSP /AWS1/CL_EKSCONNECTORCONFIGRSP¶
The configuration used to connect to a cluster for registration.
IV_ID TYPE /AWS1/EKSSTRING /AWS1/EKSSTRING¶
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
IO_HEALTH TYPE REF TO /AWS1/CL_EKSCLUSTERHEALTH /AWS1/CL_EKSCLUSTERHEALTH¶
An object representing the health of your Amazon EKS cluster.
IO_OUTPOSTCONFIG TYPE REF TO /AWS1/CL_EKSOUTPOSTCONFIGRSP /AWS1/CL_EKSOUTPOSTCONFIGRSP¶
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
IO_ACCESSCONFIG TYPE REF TO /AWS1/CL_EKSACCESSCONFIGRSP /AWS1/CL_EKSACCESSCONFIGRSP¶
The access configuration for the cluster.
IO_UPGRADEPOLICY TYPE REF TO /AWS1/CL_EKSUPGRADEPOLICYRSP /AWS1/CL_EKSUPGRADEPOLICYRSP¶
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the EKS User Guide.
Queryable Attributes¶
name¶
The name of your cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_NAME() |
Getter for NAME, with configurable default |
ASK_NAME() |
Getter for NAME w/ exceptions if field has no value |
HAS_NAME() |
Determine if NAME has a value |
arn¶
The Amazon Resource Name (ARN) of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ARN() |
Getter for ARN, with configurable default |
ASK_ARN() |
Getter for ARN w/ exceptions if field has no value |
HAS_ARN() |
Determine if ARN has a value |
createdAt¶
The Unix epoch timestamp at object creation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CREATEDAT() |
Getter for CREATEDAT, with configurable default |
ASK_CREATEDAT() |
Getter for CREATEDAT w/ exceptions if field has no value |
HAS_CREATEDAT() |
Determine if CREATEDAT has a value |
version¶
The Kubernetes server version for the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VERSION() |
Getter for VERSION, with configurable default |
ASK_VERSION() |
Getter for VERSION w/ exceptions if field has no value |
HAS_VERSION() |
Determine if VERSION has a value |
endpoint¶
The endpoint for your Kubernetes API server.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENDPOINT() |
Getter for ENDPOINT, with configurable default |
ASK_ENDPOINT() |
Getter for ENDPOINT w/ exceptions if field has no value |
HAS_ENDPOINT() |
Determine if ENDPOINT has a value |
roleArn¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
resourcesVpcConfig¶
The VPC configuration 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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RESOURCESVPCCONFIG() |
Getter for RESOURCESVPCCONFIG |
kubernetesNetworkConfig¶
The Kubernetes network configuration for the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_KUBERNETESNETWORKCONFIG() |
Getter for KUBERNETESNETWORKCONFIG |
logging¶
The logging configuration for your cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_LOGGING() |
Getter for LOGGING |
identity¶
The identity provider information for the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTITY() |
Getter for IDENTITY |
status¶
The current status of the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STATUS() |
Getter for STATUS, with configurable default |
ASK_STATUS() |
Getter for STATUS w/ exceptions if field has no value |
HAS_STATUS() |
Determine if STATUS has a value |
certificateAuthority¶
The
certificate-authority-datafor your cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CERTIFICATEAUTHORITY() |
Getter for CERTIFICATEAUTHORITY |
clientRequestToken¶
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLIENTREQUESTTOKEN() |
Getter for CLIENTREQUESTTOKEN, with configurable default |
ASK_CLIENTREQUESTTOKEN() |
Getter for CLIENTREQUESTTOKEN w/ exceptions if field has no |
HAS_CLIENTREQUESTTOKEN() |
Determine if CLIENTREQUESTTOKEN has a value |
platformVersion¶
The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see Platform versions in the Amazon EKS User Guide . For more information about local clusters deployed on an Outpost, see Amazon EKS local cluster platform versions in the Amazon EKS User Guide .
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PLATFORMVERSION() |
Getter for PLATFORMVERSION, with configurable default |
ASK_PLATFORMVERSION() |
Getter for PLATFORMVERSION w/ exceptions if field has no val |
HAS_PLATFORMVERSION() |
Determine if PLATFORMVERSION has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TAGS() |
Getter for TAGS, with configurable default |
ASK_TAGS() |
Getter for TAGS w/ exceptions if field has no value |
HAS_TAGS() |
Determine if TAGS has a value |
encryptionConfig¶
The encryption configuration for the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ENCRYPTIONCONFIG() |
Getter for ENCRYPTIONCONFIG, with configurable default |
ASK_ENCRYPTIONCONFIG() |
Getter for ENCRYPTIONCONFIG w/ exceptions if field has no va |
HAS_ENCRYPTIONCONFIG() |
Determine if ENCRYPTIONCONFIG has a value |
connectorConfig¶
The configuration used to connect to a cluster for registration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CONNECTORCONFIG() |
Getter for CONNECTORCONFIG |
id¶
The ID of your local Amazon EKS cluster on an Amazon Web Services Outpost. This property isn't available for an Amazon EKS cluster on the Amazon Web Services cloud.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ID() |
Getter for ID, with configurable default |
ASK_ID() |
Getter for ID w/ exceptions if field has no value |
HAS_ID() |
Determine if ID has a value |
health¶
An object representing the health of your Amazon EKS cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HEALTH() |
Getter for HEALTH |
outpostConfig¶
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. This object isn't available for clusters on the Amazon Web Services cloud.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_OUTPOSTCONFIG() |
Getter for OUTPOSTCONFIG |
accessConfig¶
The access configuration for the cluster.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ACCESSCONFIG() |
Getter for ACCESSCONFIG |
upgradePolicy¶
This value indicates if extended support is enabled or disabled for the cluster.
Learn more about EKS Extended Support in the EKS User Guide.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_UPGRADEPOLICY() |
Getter for UPGRADEPOLICY |