Cluster ¶

class Cluster(TypedDict, closed=True):
    name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of your cluster.</p>"""
    arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the cluster.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp at object creation.</p>"""
    version: NotRequired["capo_eks.types.string.String"]
    """<p>The Kubernetes server version for the cluster.</p>"""
    endpoint: NotRequired["capo_eks.types.string.String"]
    """<p>The endpoint for your Kubernetes API server.</p>"""
    role_arn: NotRequired["capo_eks.types.string.String"]
    """<p>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.</p>"""
    resources_vpc_config: NotRequired[
        "capo_eks.types.vpc_config_response.VpcConfigResponse"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html">Cluster VPC considerations</a> and <a href="https://docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html">Cluster security group considerations</a> in the <i>Amazon EKS User Guide</i>.</p>"""
    kubernetes_network_config: NotRequired[
        "capo_eks.types.kubernetes_network_config_response.KubernetesNetworkConfigResponse"
    ]
    """<p>The Kubernetes network configuration for the cluster.</p>"""
    logging: NotRequired["capo_eks.types.logging.Logging"]
    """<p>The logging configuration for your cluster.</p>"""
    identity: NotRequired["capo_eks.types.identity.Identity"]
    """<p>The identity provider information for the cluster.</p>"""
    status: NotRequired["capo_eks.types.cluster_status.ClusterStatus"]
    """<p>The current status of the cluster.</p>"""
    certificate_authority: NotRequired["capo_eks.types.certificate.Certificate"]
    """<p>The <code>certificate-authority-data</code> for your cluster.</p>"""
    client_request_token: NotRequired["capo_eks.types.string.String"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"""
    platform_version: NotRequired["capo_eks.types.string.String"]
    """<p>The platform version of your Amazon EKS cluster. For more information about clusters deployed on the Amazon Web Services Cloud, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/platform-versions.html">Platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>. For more information about local clusters deployed on an Outpost, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/eks-outposts-platform-versions.html">Amazon EKS local cluster platform versions</a> in the <i> <i>Amazon EKS User Guide</i> </i>.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    """<p>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.</p>"""
    encryption_config: NotRequired[
        "capo_eks.types.encryption_config_list.EncryptionConfigList"
    ]
    """<p>The encryption configuration for the cluster.</p>"""
    connector_config: NotRequired[
        "capo_eks.types.connector_config_response.ConnectorConfigResponse"
    ]
    """<p>The configuration used to connect to a cluster for registration.</p>"""
    id: NotRequired["capo_eks.types.string.String"]
    """<p>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.</p>"""
    health: NotRequired["capo_eks.types.cluster_health.ClusterHealth"]
    """<p>An object representing the health of your Amazon EKS cluster.</p>"""
    outpost_config: NotRequired[
        "capo_eks.types.outpost_config_response.OutpostConfigResponse"
    ]
    """<p>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.</p>"""
    access_config: NotRequired[
        "capo_eks.types.access_config_response.AccessConfigResponse"
    ]
    """<p>The access configuration for the cluster.</p>"""
    upgrade_policy: NotRequired[
        "capo_eks.types.upgrade_policy_response.UpgradePolicyResponse"
    ]
    """<p>This value indicates if extended support is enabled or disabled for the cluster.</p> <p> <a href="https://docs.aws.amazon.com/eks/latest/userguide/extended-support-control.html">Learn more about EKS Extended Support in the <i>Amazon EKS User Guide</i>.</a> </p>"""
    zonal_shift_config: NotRequired[
        "capo_eks.types.zonal_shift_config_response.ZonalShiftConfigResponse"
    ]
    """<p>The configuration for zonal shift for the cluster.</p>"""
    remote_network_config: NotRequired[
        "capo_eks.types.remote_network_config_response.RemoteNetworkConfigResponse"
    ]
    """<p>The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.</p>"""
    compute_config: NotRequired[
        "capo_eks.types.compute_config_response.ComputeConfigResponse"
    ]
    """<p>Indicates the current configuration of the compute capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account. For more information, see EKS Auto Mode compute capability in the <i>Amazon EKS User Guide</i>.</p>"""
    storage_config: NotRequired[
        "capo_eks.types.storage_config_response.StorageConfigResponse"
    ]
    """<p>Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster. For example, if the capability is enabled or disabled. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account. For more information, see EKS Auto Mode block storage capability in the <i>Amazon EKS User Guide</i>.</p>"""
    deletion_protection: NotRequired["capo_eks.types.boxed_boolean.BoxedBoolean"]
    """<p>The current deletion protection setting for the cluster. When <code>true</code>, deletion protection is enabled and the cluster cannot be deleted until protection is disabled. When <code>false</code>, the cluster can be deleted normally. This setting only applies to clusters in an active state.</p>"""
    control_plane_scaling_config: NotRequired[
        "capo_eks.types.control_plane_scaling_config.ControlPlaneScalingConfig"
    ]
    """<p>The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.</p>"""
    kube_api_server_config: NotRequired[
        "capo_eks.types.kube_api_server_config_response.KubeApiServerConfigResponse"
    ]
    """<p>The Kubernetes API server configuration for the cluster.</p>"""
    kube_scheduler_config: NotRequired[
        "capo_eks.types.kube_scheduler_config_response.KubeSchedulerConfigResponse"
    ]
    """<p>The Kubernetes scheduler configuration for the cluster.</p>"""
    kube_controller_manager_config: NotRequired[
        "capo_eks.types.kube_controller_manager_config_response.KubeControllerManagerConfigResponse"
    ]
    """<p>The Kubernetes controller manager configuration for the cluster.</p>"""