Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data Cluster = Cluster' {
- arn :: Maybe Text
- certificateAuthority :: Maybe Certificate
- clientRequestToken :: Maybe Text
- connectorConfig :: Maybe ConnectorConfigResponse
- createdAt :: Maybe POSIX
- encryptionConfig :: Maybe [EncryptionConfig]
- endpoint :: Maybe Text
- health :: Maybe ClusterHealth
- id :: Maybe Text
- identity :: Maybe Identity
- kubernetesNetworkConfig :: Maybe KubernetesNetworkConfigResponse
- logging :: Maybe Logging
- name :: Maybe Text
- outpostConfig :: Maybe OutpostConfigResponse
- platformVersion :: Maybe Text
- resourcesVpcConfig :: Maybe VpcConfigResponse
- roleArn :: Maybe Text
- status :: Maybe ClusterStatus
- tags :: Maybe (HashMap Text Text)
- version :: Maybe Text
- newCluster :: Cluster
- cluster_arn :: Lens' Cluster (Maybe Text)
- cluster_certificateAuthority :: Lens' Cluster (Maybe Certificate)
- cluster_clientRequestToken :: Lens' Cluster (Maybe Text)
- cluster_connectorConfig :: Lens' Cluster (Maybe ConnectorConfigResponse)
- cluster_createdAt :: Lens' Cluster (Maybe UTCTime)
- cluster_encryptionConfig :: Lens' Cluster (Maybe [EncryptionConfig])
- cluster_endpoint :: Lens' Cluster (Maybe Text)
- cluster_health :: Lens' Cluster (Maybe ClusterHealth)
- cluster_id :: Lens' Cluster (Maybe Text)
- cluster_identity :: Lens' Cluster (Maybe Identity)
- cluster_kubernetesNetworkConfig :: Lens' Cluster (Maybe KubernetesNetworkConfigResponse)
- cluster_logging :: Lens' Cluster (Maybe Logging)
- cluster_name :: Lens' Cluster (Maybe Text)
- cluster_outpostConfig :: Lens' Cluster (Maybe OutpostConfigResponse)
- cluster_platformVersion :: Lens' Cluster (Maybe Text)
- cluster_resourcesVpcConfig :: Lens' Cluster (Maybe VpcConfigResponse)
- cluster_roleArn :: Lens' Cluster (Maybe Text)
- cluster_status :: Lens' Cluster (Maybe ClusterStatus)
- cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text))
- cluster_version :: Lens' Cluster (Maybe Text)
Documentation
An object representing an Amazon EKS cluster.
See: newCluster
smart constructor.
Cluster' | |
|
Instances
newCluster :: Cluster Source #
Create a value of Cluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Cluster'
, cluster_arn
- The Amazon Resource Name (ARN) of the cluster.
$sel:certificateAuthority:Cluster'
, cluster_certificateAuthority
- The certificate-authority-data
for your cluster.
$sel:clientRequestToken:Cluster'
, cluster_clientRequestToken
- Unique, case-sensitive identifier that you provide to ensure the
idempotency of the request.
$sel:connectorConfig:Cluster'
, cluster_connectorConfig
- The configuration used to connect to a cluster for registration.
$sel:createdAt:Cluster'
, cluster_createdAt
- The Unix epoch timestamp in seconds for when the cluster was created.
$sel:encryptionConfig:Cluster'
, cluster_encryptionConfig
- The encryption configuration for the cluster.
$sel:endpoint:Cluster'
, cluster_endpoint
- The endpoint for your Kubernetes API server.
$sel:health:Cluster'
, cluster_health
- An object representing the health 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.
$sel:id:Cluster'
, cluster_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.
$sel:identity:Cluster'
, cluster_identity
- The identity provider information for the cluster.
$sel:kubernetesNetworkConfig:Cluster'
, cluster_kubernetesNetworkConfig
- The Kubernetes network configuration for the cluster.
$sel:logging:Cluster'
, cluster_logging
- The logging configuration for your cluster.
$sel:name:Cluster'
, cluster_name
- The name of the cluster.
$sel:outpostConfig:Cluster'
, cluster_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.
$sel:platformVersion:Cluster'
, cluster_platformVersion
- The platform version of your Amazon EKS cluster. For more information,
see
Platform Versions
in the /Amazon EKS User Guide/ .
$sel:resourcesVpcConfig:Cluster'
, cluster_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.
Cluster
, cluster_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.
$sel:status:Cluster'
, cluster_status
- The current status of the cluster.
$sel:tags:Cluster'
, cluster_tags
- The metadata that you apply to the cluster to assist with categorization
and organization. Each tag consists of a key and an optional value. You
define both. Cluster tags do not propagate to any other resources
associated with the cluster.
$sel:version:Cluster'
, cluster_version
- The Kubernetes server version for the cluster.
cluster_certificateAuthority :: Lens' Cluster (Maybe Certificate) Source #
The certificate-authority-data
for your cluster.
cluster_clientRequestToken :: Lens' Cluster (Maybe Text) Source #
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
cluster_connectorConfig :: Lens' Cluster (Maybe ConnectorConfigResponse) Source #
The configuration used to connect to a cluster for registration.
cluster_createdAt :: Lens' Cluster (Maybe UTCTime) Source #
The Unix epoch timestamp in seconds for when the cluster was created.
cluster_encryptionConfig :: Lens' Cluster (Maybe [EncryptionConfig]) Source #
The encryption configuration for the cluster.
cluster_health :: Lens' Cluster (Maybe ClusterHealth) Source #
An object representing the health 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.
cluster_id :: Lens' Cluster (Maybe Text) Source #
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.
cluster_identity :: Lens' Cluster (Maybe Identity) Source #
The identity provider information for the cluster.
cluster_kubernetesNetworkConfig :: Lens' Cluster (Maybe KubernetesNetworkConfigResponse) Source #
The Kubernetes network configuration for the cluster.
cluster_logging :: Lens' Cluster (Maybe Logging) Source #
The logging configuration for your cluster.
cluster_outpostConfig :: Lens' Cluster (Maybe OutpostConfigResponse) Source #
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.
cluster_platformVersion :: Lens' Cluster (Maybe Text) Source #
The platform version of your Amazon EKS cluster. For more information, see Platform Versions in the /Amazon EKS User Guide/ .
cluster_resourcesVpcConfig :: Lens' Cluster (Maybe VpcConfigResponse) Source #
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.
cluster_roleArn :: Lens' Cluster (Maybe Text) Source #
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.
cluster_status :: Lens' Cluster (Maybe ClusterStatus) Source #
The current status of the cluster.
cluster_tags :: Lens' Cluster (Maybe (HashMap Text Text)) Source #
The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Cluster tags do not propagate to any other resources associated with the cluster.