[][src]Trait rusoto_eks::Eks

pub trait Eks {
    fn create_cluster(
        &self,
        input: CreateClusterRequest
    ) -> RusotoFuture<CreateClusterResponse, CreateClusterError>;
fn delete_cluster(
        &self,
        input: DeleteClusterRequest
    ) -> RusotoFuture<DeleteClusterResponse, DeleteClusterError>;
fn describe_cluster(
        &self,
        input: DescribeClusterRequest
    ) -> RusotoFuture<DescribeClusterResponse, DescribeClusterError>;
fn describe_update(
        &self,
        input: DescribeUpdateRequest
    ) -> RusotoFuture<DescribeUpdateResponse, DescribeUpdateError>;
fn list_clusters(
        &self,
        input: ListClustersRequest
    ) -> RusotoFuture<ListClustersResponse, ListClustersError>;
fn list_updates(
        &self,
        input: ListUpdatesRequest
    ) -> RusotoFuture<ListUpdatesResponse, ListUpdatesError>;
fn update_cluster_config(
        &self,
        input: UpdateClusterConfigRequest
    ) -> RusotoFuture<UpdateClusterConfigResponse, UpdateClusterConfigError>;
fn update_cluster_version(
        &self,
        input: UpdateClusterVersionRequest
    ) -> RusotoFuture<UpdateClusterVersionResponse, UpdateClusterVersionError>; }

Trait representing the capabilities of the Amazon EKS API. Amazon EKS clients implement this trait.

Required methods

fn create_cluster(
    &self,
    input: CreateClusterRequest
) -> RusotoFuture<CreateClusterResponse, CreateClusterError>

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 AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and 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 worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via 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 Amazon CloudWatch Pricing.

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

fn delete_cluster(
    &self,
    input: DeleteClusterRequest
) -> RusotoFuture<DeleteClusterResponse, DeleteClusterError>

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.

fn describe_cluster(
    &self,
    input: DescribeClusterRequest
) -> RusotoFuture<DescribeClusterResponse, DescribeClusterError>

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

fn describe_update(
    &self,
    input: DescribeUpdateRequest
) -> RusotoFuture<DescribeUpdateResponse, DescribeUpdateError>

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

fn list_clusters(
    &self,
    input: ListClustersRequest
) -> RusotoFuture<ListClustersResponse, ListClustersError>

Lists the Amazon EKS clusters in your AWS account in the specified Region.

fn list_updates(
    &self,
    input: ListUpdatesRequest
) -> RusotoFuture<ListUpdatesResponse, ListUpdatesError>

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

fn update_cluster_config(
    &self,
    input: UpdateClusterConfigRequest
) -> RusotoFuture<UpdateClusterConfigResponse, UpdateClusterConfigError>

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation 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 Amazon CloudWatch Pricing.

You can also use this API operation 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 .

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

fn update_cluster_version(
    &self,
    input: UpdateClusterVersionRequest
) -> RusotoFuture<UpdateClusterVersionResponse, UpdateClusterVersionError>

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

Loading content...

Implementors

impl Eks for EksClient[src]

fn create_cluster(
    &self,
    input: CreateClusterRequest
) -> RusotoFuture<CreateClusterResponse, CreateClusterError>
[src]

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 AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and 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 worker nodes (for example, to support kubectl exec, logs, and proxy data flows).

Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via 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 Amazon CloudWatch Pricing.

Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.

fn delete_cluster(
    &self,
    input: DeleteClusterRequest
) -> RusotoFuture<DeleteClusterResponse, DeleteClusterError>
[src]

Deletes the Amazon EKS cluster control plane.

If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.

fn describe_cluster(
    &self,
    input: DescribeClusterRequest
) -> RusotoFuture<DescribeClusterResponse, DescribeClusterError>
[src]

Returns descriptive information about an Amazon EKS cluster.

The API server endpoint and certificate authority data returned by this operation are required for kubelet and kubectl to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.

The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE state.

fn describe_update(
    &self,
    input: DescribeUpdateRequest
) -> RusotoFuture<DescribeUpdateResponse, DescribeUpdateError>
[src]

Returns descriptive information about an update against your Amazon EKS cluster.

When the status of the update is Succeeded, the update is complete. If an update fails, the status is Failed, and an error detail explains the reason for the failure.

fn list_clusters(
    &self,
    input: ListClustersRequest
) -> RusotoFuture<ListClustersResponse, ListClustersError>
[src]

Lists the Amazon EKS clusters in your AWS account in the specified Region.

fn list_updates(
    &self,
    input: ListUpdatesRequest
) -> RusotoFuture<ListUpdatesResponse, ListUpdatesError>
[src]

Lists the updates associated with an Amazon EKS cluster in your AWS account, in the specified Region.

fn update_cluster_config(
    &self,
    input: UpdateClusterConfigRequest
) -> RusotoFuture<UpdateClusterConfigResponse, UpdateClusterConfigError>
[src]

Updates an Amazon EKS cluster configuration. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

You can use this API operation 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 Amazon CloudWatch Pricing.

You can also use this API operation 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 .

At this time, you can not update the subnets or security group IDs for an existing cluster.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

fn update_cluster_version(
    &self,
    input: UpdateClusterVersionRequest
) -> RusotoFuture<UpdateClusterVersionResponse, UpdateClusterVersionError>
[src]

Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.

Cluster updates are asynchronous, and they should finish within a few minutes. During an update, the cluster status moves to UPDATING (this status transition is eventually consistent). When the update is complete (either Failed or Successful), the cluster status moves to Active.

Loading content...