Struct aws_sdk_eks::Client

pub struct Client { /* private fields */ }

Client for Amazon Elastic Kubernetes Service

Client for invoking operations on Amazon Elastic Kubernetes Service. Each operation on Amazon Elastic Kubernetes Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_eks::Client::new(&config);

Occasionally, SDKs may have additional service-specific that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Config struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_eks::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

Using the Client

A client has a function for every operation that can be performed by the service. For example, the AssociateEncryptionConfig operation has a Client::associate_encryption_config, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.associate_encryption_config()
    .cluster_name("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

Implementations

impl Client

pub fn associate_encryption_config( &self ) -> AssociateEncryptionConfigFluentBuilder

Constructs a fluent builder for the AssociateEncryptionConfig operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster that you are associating with encryption configuration.

    
    
  • encryption_config(EncryptionConfig) / set_encryption_config(Option<Vec::<EncryptionConfig>>):
    required: true
    

    The configuration you are using for encryption.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    The client request token you are using with the encryption configuration.

    
    
• On success, responds with AssociateEncryptionConfigOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<AssociateEncryptionConfigError>

impl Client

pub fn associate_identity_provider_config( &self ) -> AssociateIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the AssociateIdentityProviderConfig operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to associate the configuration to.

    
    
  • oidc(OidcIdentityProviderConfigRequest) / set_oidc(Option<OidcIdentityProviderConfigRequest>):
    required: true
    

    An object representing an OpenID Connect (OIDC) identity provider configuration.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata to apply to the configuration to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with AssociateIdentityProviderConfigOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

  • tags(Option<HashMap::<String, String>>):

    The tags for the resource.

• On failure, responds with SdkError<AssociateIdentityProviderConfigError>

impl Client

pub fn create_addon(&self) -> CreateAddonFluentBuilder

Constructs a fluent builder for the CreateAddon operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to create the add-on for.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

    
    
  • addon_version(impl Into<String>) / set_addon_version(Option<String>):
    required: false
    

    The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

    
    
  • service_account_role_arn(impl Into<String>) / set_service_account_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on’s service account. The role must be assigned the IAM permissions required by the add-on. If you don’t specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

    To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

    
    
  • resolve_conflicts(ResolveConflicts) / set_resolve_conflicts(Option<ResolveConflicts>):
    required: false
    

    How to resolve field value conflicts for an Amazon EKS add-on. Conflicts are handled based on the value you choose:

    • None – If the self-managed version of the add-on is installed on your cluster, Amazon EKS doesn’t change the value. Creation of the add-on might fail.

    • Overwrite – If the self-managed version of the add-on is installed on your cluster and the Amazon EKS default value is different than the existing value, Amazon EKS changes the value to the Amazon EKS default value.

    • Preserve – This is similar to the NONE option. If the self-managed version of the add-on is installed on your cluster Amazon EKS doesn’t change the add-on resource properties. Creation of the add-on might fail if conflicts are detected. This option works differently during the update operation. For more information, see UpdateAddon.

    If you don’t currently have the self-managed version of the add-on installed on your cluster, the Amazon EKS add-on is installed. Amazon EKS sets all values to default values, regardless of the option that you specify.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • configuration_values(impl Into<String>) / set_configuration_values(Option<String>):
    required: false
    

    The set of configuration values for the add-on that’s created. The values that you provide are validated against the schema in DescribeAddonConfiguration .

    
    
• On success, responds with CreateAddonOutput with field(s):
  • addon(Option<Addon>):

    An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

• On failure, responds with SdkError<CreateAddonError>

impl Client

pub fn create_cluster(&self) -> CreateClusterFluentBuilder

Constructs a fluent builder for the CreateCluster operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The unique name to give to your cluster.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The desired Kubernetes version for your cluster. If you don’t specify a value here, the default version available in Amazon EKS is used.

    The default version might not be the latest version available.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    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. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

    
    
  • resources_vpc_config(VpcConfigRequest) / set_resources_vpc_config(Option<VpcConfigRequest>):
    required: true
    

    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 and Cluster Security Group Considerations 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.

    
    
  • kubernetes_network_config(KubernetesNetworkConfigRequest) / set_kubernetes_network_config(Option<KubernetesNetworkConfigRequest>):
    required: false
    

    The Kubernetes network configuration for the cluster.

    
    
  • logging(Logging) / set_logging(Option<Logging>):
    required: false
    

    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 CloudWatch Pricing.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    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.

    
    
  • encryption_config(EncryptionConfig) / set_encryption_config(Option<Vec::<EncryptionConfig>>):
    required: false
    

    The encryption configuration for the cluster.

    
    
  • outpost_config(OutpostConfigRequest) / set_outpost_config(Option<OutpostConfigRequest>):
    required: false
    

    An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost. Before creating a local cluster on an Outpost, review Local clusters for Amazon EKS on Amazon Web Services Outposts in the Amazon EKS User Guide. This object isn’t available for creating Amazon EKS clusters on the Amazon Web Services cloud.

    
    
• On success, responds with CreateClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The full description of your new cluster.

• On failure, responds with SdkError<CreateClusterError>

impl Client

pub fn create_eks_anywhere_subscription( &self ) -> CreateEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEksAnywhereSubscription operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The unique name for your subscription. It must be unique in your Amazon Web Services account in the Amazon Web Services Region you’re creating the subscription in. The name can contain only alphanumeric characters (case-sensitive), hyphens, and underscores. It must start with an alphabetic character and can’t be longer than 100 characters.

    
    
  • term(EksAnywhereSubscriptionTerm) / set_term(Option<EksAnywhereSubscriptionTerm>):
    required: true
    

    An object representing the term duration and term unit type of your subscription. This determines the term length of your subscription. Valid values are MONTHS for term unit and 12 or 36 for term duration, indicating a 12 month or 36 month subscription. This value cannot be changed after creating the subscription.

    
    
  • license_quantity(i32) / set_license_quantity(Option<i32>):
    required: false
    

    The number of licenses to purchase with the subscription. Valid values are between 1 and 100. This value can’t be changed after creating the subscription.

    
    
  • license_type(EksAnywhereSubscriptionLicenseType) / set_license_type(Option<EksAnywhereSubscriptionLicenseType>):
    required: false
    

    The license type for all licenses in the subscription. Valid value is CLUSTER. With the CLUSTER license type, each license covers support for a single EKS Anywhere cluster.

    
    
  • auto_renew(bool) / set_auto_renew(Option<bool>):
    required: false
    

    A boolean indicating whether the subscription auto renews at the end of the term.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata for a subscription to assist with categorization and organization. Each tag consists of a key and an optional value. Subscription tags don’t propagate to any other resources associated with the subscription.

    
    
• On success, responds with CreateEksAnywhereSubscriptionOutput with field(s):
  • subscription(Option<EksAnywhereSubscription>):

    The full description of the subscription.

• On failure, responds with SdkError<CreateEksAnywhereSubscriptionError>

impl Client

pub fn create_fargate_profile(&self) -> CreateFargateProfileFluentBuilder

Constructs a fluent builder for the CreateFargateProfile operation.

• The fluent builder is configurable:
  • fargate_profile_name(impl Into<String>) / set_fargate_profile_name(Option<String>):
    required: true
    

    The name of the Fargate profile.

    
    
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster to apply the Fargate profile to.

    
    
  • pod_execution_role_arn(impl Into<String>) / set_pod_execution_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.

    
    
  • subnets(impl Into<String>) / set_subnets(Option<Vec::<String>>):
    required: false
    

    The IDs of subnets to launch your pods into. At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

    
    
  • selectors(FargateProfileSelector) / set_selectors(Option<Vec::<FargateProfileSelector>>):
    required: false
    

    The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

    
    
• On success, responds with CreateFargateProfileOutput with field(s):
  • fargate_profile(Option<FargateProfile>):

    The full description of your new Fargate profile.

• On failure, responds with SdkError<CreateFargateProfileError>

impl Client

pub fn create_nodegroup(&self) -> CreateNodegroupFluentBuilder

Constructs a fluent builder for the CreateNodegroup operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to create the node group in.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: true
    

    The unique name to give your node group.

    
    
  • scaling_config(NodegroupScalingConfig) / set_scaling_config(Option<NodegroupScalingConfig>):
    required: false
    

    The scaling configuration details for the Auto Scaling group that is created for your node group.

    
    
  • disk_size(i32) / set_disk_size(Option<i32>):
    required: false
    

    The root device disk size (in GiB) for your node group instances. The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate, then don’t specify diskSize, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • subnets(impl Into<String>) / set_subnets(Option<Vec::<String>>):
    required: true
    

    The subnets to use for the Auto Scaling group that is created for your node group. If you specify launchTemplate, then don’t specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • instance_types(impl Into<String>) / set_instance_types(Option<Vec::<String>>):
    required: false
    

    Specify the instance types for a node group. If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate, then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes. If however, you specify an instance type in your launch template and specify any instanceTypes, the node group deployment will fail. If you don’t specify an instance type in a launch template or for instanceTypes, then t3.medium is used, by default. If you specify Spot for capacityType, then we recommend specifying multiple values for instanceTypes. For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide.

    
    
  • ami_type(AmiTypes) / set_ami_type(Option<AmiTypes>):
    required: false
    

    The AMI type for your node group. If you specify launchTemplate, and your launch template uses a custom AMI, then don’t specify amiType, or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • remote_access(RemoteAccessConfig) / set_remote_access(Option<RemoteAccessConfig>):
    required: false
    

    The remote access configuration to use with your node group. For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate, then don’t specify remoteAccess, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • node_role(impl Into<String>) / set_node_role(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate, then don’t specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • labels(impl Into<String>, impl Into<String>) / set_labels(Option<HashMap::<String, String>>):
    required: false
    

    The Kubernetes labels to be applied to the nodes in the node group when they are created.

    
    
  • taints(Taint) / set_taints(Option<Vec::<Taint>>):
    required: false
    

    The Kubernetes taints to be applied to the nodes in the node group. For more information, see Node taints on managed node groups.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata to apply to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • launch_template(LaunchTemplateSpecification) / set_launch_template(Option<LaunchTemplateSpecification>):
    required: false
    

    An object representing a node group’s launch template specification. If specified, then do not specify instanceTypes, diskSize, or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification.

    
    
  • update_config(NodegroupUpdateConfig) / set_update_config(Option<NodegroupUpdateConfig>):
    required: false
    

    The node group update configuration.

    
    
  • capacity_type(CapacityTypes) / set_capacity_type(Option<CapacityTypes>):
    required: false
    

    The capacity type for your node group.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The Kubernetes version to use for your managed nodes. By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate, and your launch template uses a custom AMI, then don’t specify version, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • release_version(impl Into<String>) / set_release_version(Option<String>):
    required: false
    

    The AMI version of the Amazon EKS optimized AMI to use with your node group. By default, the latest available AMI version for the node group’s current Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

    If you specify launchTemplate, and your launch template uses a custom AMI, then don’t specify releaseVersion, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
• On success, responds with CreateNodegroupOutput with field(s):
  • nodegroup(Option<Nodegroup>):

    The full description of your new node group.

• On failure, responds with SdkError<CreateNodegroupError>

impl Client

pub fn create_pod_identity_association( &self ) -> CreatePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the CreatePodIdentityAssociation operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to create the association in.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: true
    

    The name of the Kubernetes namespace inside the cluster to create the association in. The service account and the pods that use the service account must be in this namespace.

    
    
  • service_account(impl Into<String>) / set_service_account(Option<String>):
    required: true
    

    The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the pods that use this service account.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata that you apply to a resource to assist with categorization and organization. Each tag consists of a key and an optional value. You define both.

    The following basic restrictions apply to tags:

    • Maximum number of tags per resource – 50

    • For each resource, each tag key must be unique, and each tag key can have only one value.

    • Maximum key length – 128 Unicode characters in UTF-8

    • Maximum value length – 256 Unicode characters in UTF-8

    • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

    • Tag keys and values are case-sensitive.

    • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

    
    
• On success, responds with CreatePodIdentityAssociationOutput with field(s):
  • association(Option<PodIdentityAssociation>):

    The full description of your new association.

    The description includes an ID for the association. Use the ID of the association in further actions to manage the association.

• On failure, responds with SdkError<CreatePodIdentityAssociationError>

impl Client

pub fn delete_addon(&self) -> DeleteAddonFluentBuilder

Constructs a fluent builder for the DeleteAddon operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to delete the add-on from.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the add-on. The name must match one of the names returned by ListAddons .

    
    
  • preserve(bool) / set_preserve(Option<bool>):
    required: false
    

    Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn’t removed.

    
    
• On success, responds with DeleteAddonOutput with field(s):
  • addon(Option<Addon>):

    An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

• On failure, responds with SdkError<DeleteAddonError>

impl Client

pub fn delete_cluster(&self) -> DeleteClusterFluentBuilder

Constructs a fluent builder for the DeleteCluster operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the cluster to delete.

    
    
• On success, responds with DeleteClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The full description of the cluster to delete.

• On failure, responds with SdkError<DeleteClusterError>

impl Client

pub fn delete_eks_anywhere_subscription( &self ) -> DeleteEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEksAnywhereSubscription operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the subscription.

    
    
• On success, responds with DeleteEksAnywhereSubscriptionOutput with field(s):
  • subscription(Option<EksAnywhereSubscription>):

    The full description of the subscription to be deleted.

• On failure, responds with SdkError<DeleteEksAnywhereSubscriptionError>

impl Client

pub fn delete_fargate_profile(&self) -> DeleteFargateProfileFluentBuilder

Constructs a fluent builder for the DeleteFargateProfile operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster associated with the Fargate profile to delete.

    
    
  • fargate_profile_name(impl Into<String>) / set_fargate_profile_name(Option<String>):
    required: true
    

    The name of the Fargate profile to delete.

    
    
• On success, responds with DeleteFargateProfileOutput with field(s):
  • fargate_profile(Option<FargateProfile>):

    The deleted Fargate profile.

• On failure, responds with SdkError<DeleteFargateProfileError>

impl Client

pub fn delete_nodegroup(&self) -> DeleteNodegroupFluentBuilder

Constructs a fluent builder for the DeleteNodegroup operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster that is associated with your node group.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: true
    

    The name of the node group to delete.

    
    
• On success, responds with DeleteNodegroupOutput with field(s):
  • nodegroup(Option<Nodegroup>):

    The full description of your deleted node group.

• On failure, responds with SdkError<DeleteNodegroupError>

impl Client

pub fn delete_pod_identity_association( &self ) -> DeletePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the DeletePodIdentityAssociation operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The cluster name that

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID of the association to be deleted.

    
    
• On success, responds with DeletePodIdentityAssociationOutput with field(s):
  • association(Option<PodIdentityAssociation>):

    The full description of the EKS Pod Identity association that was deleted.

• On failure, responds with SdkError<DeletePodIdentityAssociationError>

impl Client

pub fn deregister_cluster(&self) -> DeregisterClusterFluentBuilder

Constructs a fluent builder for the DeregisterCluster operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the connected cluster to deregister.

    
    
• On success, responds with DeregisterClusterOutput with field(s):
  • cluster(Option<Cluster>):

    An object representing an Amazon EKS cluster.

• On failure, responds with SdkError<DeregisterClusterError>

impl Client

pub fn describe_addon(&self) -> DescribeAddonFluentBuilder

Constructs a fluent builder for the DescribeAddon operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the add-on. The name must match one of the names returned by ListAddons .

    
    
• On success, responds with DescribeAddonOutput with field(s):
  • addon(Option<Addon>):

    An Amazon EKS add-on. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide.

• On failure, responds with SdkError<DescribeAddonError>

impl Client

pub fn describe_addon_configuration( &self ) -> DescribeAddonConfigurationFluentBuilder

Constructs a fluent builder for the DescribeAddonConfiguration operation.

• The fluent builder is configurable:
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the add-on. The name must match one of the names that DescribeAddonVersions returns.

    
    
  • addon_version(impl Into<String>) / set_addon_version(Option<String>):
    required: true
    

    The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

    
    
• On success, responds with DescribeAddonConfigurationOutput with field(s):
  • addon_name(Option<String>):

    The name of the add-on.

  • addon_version(Option<String>):

    The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

  • configuration_schema(Option<String>):

    A JSON schema that’s used to validate the configuration values that you provide when an addon is created or updated.

• On failure, responds with SdkError<DescribeAddonConfigurationError>

impl Client

pub fn describe_addon_versions(&self) -> DescribeAddonVersionsFluentBuilder

Constructs a fluent builder for the DescribeAddonVersions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • kubernetes_version(impl Into<String>) / set_kubernetes_version(Option<String>):
    required: false
    

    The Kubernetes versions that you can use the add-on with.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of results to return.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated DescribeAddonVersionsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: false
    

    The name of the add-on. The name must match one of the names returned by ListAddons .

    
    
  • types(impl Into<String>) / set_types(Option<Vec::<String>>):
    required: false
    

    The type of the add-on. For valid types, don’t specify a value for this property.

    
    
  • publishers(impl Into<String>) / set_publishers(Option<Vec::<String>>):
    required: false
    

    The publisher of the add-on. For valid publishers, don’t specify a value for this property.

    
    
  • owners(impl Into<String>) / set_owners(Option<Vec::<String>>):
    required: false
    

    The owner of the add-on. For valid owners, don’t specify a value for this property.

    
    
• On success, responds with DescribeAddonVersionsOutput with field(s):
  • addons(Option<Vec::<AddonInfo>>):

    The list of available versions with Kubernetes version compatibility and other properties.

  • next_token(Option<String>):

    The nextToken value to include in a future DescribeAddonVersions request. When the results of a DescribeAddonVersions request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

• On failure, responds with SdkError<DescribeAddonVersionsError>

impl Client

pub fn describe_cluster(&self) -> DescribeClusterFluentBuilder

Constructs a fluent builder for the DescribeCluster operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the cluster to describe.

    
    
• On success, responds with DescribeClusterOutput with field(s):
  • cluster(Option<Cluster>):

    The full description of your specified cluster.

• On failure, responds with SdkError<DescribeClusterError>

impl Client

pub fn describe_eks_anywhere_subscription( &self ) -> DescribeEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the DescribeEksAnywhereSubscription operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the subscription.

    
    
• On success, responds with DescribeEksAnywhereSubscriptionOutput with field(s):
  • subscription(Option<EksAnywhereSubscription>):

    The full description of the subscription.

• On failure, responds with SdkError<DescribeEksAnywhereSubscriptionError>

impl Client

pub fn describe_fargate_profile(&self) -> DescribeFargateProfileFluentBuilder

Constructs a fluent builder for the DescribeFargateProfile operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster associated with the Fargate profile.

    
    
  • fargate_profile_name(impl Into<String>) / set_fargate_profile_name(Option<String>):
    required: true
    

    The name of the Fargate profile to describe.

    
    
• On success, responds with DescribeFargateProfileOutput with field(s):
  • fargate_profile(Option<FargateProfile>):

    The full description of your Fargate profile.

• On failure, responds with SdkError<DescribeFargateProfileError>

impl Client

pub fn describe_identity_provider_config( &self ) -> DescribeIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the DescribeIdentityProviderConfig operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The cluster name that the identity provider configuration is associated to.

    
    
  • identity_provider_config(IdentityProviderConfig) / set_identity_provider_config(Option<IdentityProviderConfig>):
    required: true
    

    An object representing an identity provider configuration.

    
    
• On success, responds with DescribeIdentityProviderConfigOutput with field(s):
  • identity_provider_config(Option<IdentityProviderConfigResponse>):

    The object that represents an OpenID Connect (OIDC) identity provider configuration.

• On failure, responds with SdkError<DescribeIdentityProviderConfigError>

impl Client

pub fn describe_nodegroup(&self) -> DescribeNodegroupFluentBuilder

Constructs a fluent builder for the DescribeNodegroup operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster associated with the node group.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: true
    

    The name of the node group to describe.

    
    
• On success, responds with DescribeNodegroupOutput with field(s):
  • nodegroup(Option<Nodegroup>):

    The full description of your node group.

• On failure, responds with SdkError<DescribeNodegroupError>

impl Client

pub fn describe_pod_identity_association( &self ) -> DescribePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the DescribePodIdentityAssociation operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster that the association is in.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID of the association that you want the description of.

    
    
• On success, responds with DescribePodIdentityAssociationOutput with field(s):
  • association(Option<PodIdentityAssociation>):

    The full description of the EKS Pod Identity association.

• On failure, responds with SdkError<DescribePodIdentityAssociationError>

impl Client

pub fn describe_update(&self) -> DescribeUpdateFluentBuilder

Constructs a fluent builder for the DescribeUpdate operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster associated with the update.

    
    
  • update_id(impl Into<String>) / set_update_id(Option<String>):
    required: true
    

    The ID of the update to describe.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: false
    

    The name of the Amazon EKS node group associated with the update. This parameter is required if the update is a node group update.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: false
    

    The name of the add-on. The name must match one of the names returned by ListAddons . This parameter is required if the update is an add-on update.

    
    
• On success, responds with DescribeUpdateOutput with field(s):
  • update(Option<Update>):

    The full description of the specified update.

• On failure, responds with SdkError<DescribeUpdateError>

impl Client

pub fn disassociate_identity_provider_config( &self ) -> DisassociateIdentityProviderConfigFluentBuilder

Constructs a fluent builder for the DisassociateIdentityProviderConfig operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster to disassociate an identity provider from.

    
    
  • identity_provider_config(IdentityProviderConfig) / set_identity_provider_config(Option<IdentityProviderConfig>):
    required: true
    

    An object representing an identity provider configuration.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with DisassociateIdentityProviderConfigOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<DisassociateIdentityProviderConfigError>

impl Client

pub fn list_addons(&self) -> ListAddonsFluentBuilder

Constructs a fluent builder for the ListAddons operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of add-on results returned by ListAddonsRequest in paginated output. When you use this parameter, ListAddonsRequest returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListAddonsRequest request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListAddonsRequest returns up to 100 results and a nextToken value, if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListAddonsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

    
    
• On success, responds with ListAddonsOutput with field(s):
  • addons(Option<Vec::<String>>):

    A list of installed add-ons.

  • next_token(Option<String>):

    The nextToken value to include in a future ListAddons request. When the results of a ListAddons request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

• On failure, responds with SdkError<ListAddonsError>

impl Client

pub fn list_clusters(&self) -> ListClustersFluentBuilder

Constructs a fluent builder for the ListClusters operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of cluster results returned by ListClusters in paginated output. When you use this parameter, ListClusters returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListClusters request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListClusters returns up to 100 results and a nextToken value if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListClusters request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

    
    
  • include(impl Into<String>) / set_include(Option<Vec::<String>>):
    required: false
    

    Indicates whether external clusters are included in the returned list. Use ‘all’ to return connected clusters, or blank to return only Amazon EKS clusters. ‘all’ must be in lowercase otherwise an error occurs.

    
    
• On success, responds with ListClustersOutput with field(s):
  • clusters(Option<Vec::<String>>):

    A list of all of the clusters for your account in the specified Region.

  • next_token(Option<String>):

    The nextToken value to include in a future ListClusters request. When the results of a ListClusters request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListClustersError>

impl Client

pub fn list_eks_anywhere_subscriptions( &self ) -> ListEksAnywhereSubscriptionsFluentBuilder

Constructs a fluent builder for the ListEksAnywhereSubscriptions operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of cluster results returned by ListEksAnywhereSubscriptions in paginated output. When you use this parameter, ListEksAnywhereSubscriptions returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListEksAnywhereSubscriptions request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListEksAnywhereSubscriptions returns up to 10 results and a nextToken value if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListEksAnywhereSubscriptions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    
    
  • include_status(EksAnywhereSubscriptionStatus) / set_include_status(Option<Vec::<EksAnywhereSubscriptionStatus>>):
    required: false
    

    An array of subscription statuses to filter on.

    
    
• On success, responds with ListEksAnywhereSubscriptionsOutput with field(s):
  • subscriptions(Option<Vec::<EksAnywhereSubscription>>):

    A list of all subscription objects in the region, filtered by includeStatus and paginated by nextToken and maxResults.

  • next_token(Option<String>):

    The nextToken value to include in a future ListEksAnywhereSubscriptions request. When the results of a ListEksAnywhereSubscriptions request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListEksAnywhereSubscriptionsError>

impl Client

pub fn list_fargate_profiles(&self) -> ListFargateProfilesFluentBuilder

Constructs a fluent builder for the ListFargateProfiles operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster that you would like to list Fargate profiles in.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of Fargate profile results returned by ListFargateProfiles in paginated output. When you use this parameter, ListFargateProfiles returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListFargateProfiles request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListFargateProfiles returns up to 100 results and a nextToken value if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListFargateProfiles request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    
    
• On success, responds with ListFargateProfilesOutput with field(s):
  • fargate_profile_names(Option<Vec::<String>>):

    A list of all of the Fargate profiles associated with the specified cluster.

  • next_token(Option<String>):

    The nextToken value to include in a future ListFargateProfiles request. When the results of a ListFargateProfiles request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListFargateProfilesError>

impl Client

pub fn list_identity_provider_configs( &self ) -> ListIdentityProviderConfigsFluentBuilder

Constructs a fluent builder for the ListIdentityProviderConfigs operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The cluster name that you want to list identity provider configurations for.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of identity provider configurations returned by ListIdentityProviderConfigs in paginated output. When you use this parameter, ListIdentityProviderConfigs returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListIdentityProviderConfigs request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListIdentityProviderConfigs returns up to 100 results and a nextToken value, if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated IdentityProviderConfigsRequest where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    
    
• On success, responds with ListIdentityProviderConfigsOutput with field(s):
  • identity_provider_configs(Option<Vec::<IdentityProviderConfig>>):

    The identity provider configurations for the cluster.

  • next_token(Option<String>):

    The nextToken value to include in a future ListIdentityProviderConfigsResponse request. When the results of a ListIdentityProviderConfigsResponse request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListIdentityProviderConfigsError>

impl Client

pub fn list_nodegroups(&self) -> ListNodegroupsFluentBuilder

Constructs a fluent builder for the ListNodegroups operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster that you would like to list node groups in.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of node group results returned by ListNodegroups in paginated output. When you use this parameter, ListNodegroups returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListNodegroups request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListNodegroups returns up to 100 results and a nextToken value if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListNodegroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    
    
• On success, responds with ListNodegroupsOutput with field(s):
  • nodegroups(Option<Vec::<String>>):

    A list of all of the node groups associated with the specified cluster.

  • next_token(Option<String>):

    The nextToken value to include in a future ListNodegroups request. When the results of a ListNodegroups request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListNodegroupsError>

impl Client

pub fn list_pod_identity_associations( &self ) -> ListPodIdentityAssociationsFluentBuilder

Constructs a fluent builder for the ListPodIdentityAssociations operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster that the associations are in.

    
    
  • namespace(impl Into<String>) / set_namespace(Option<String>):
    required: false
    

    The name of the Kubernetes namespace inside the cluster that the associations are in.

    
    
  • service_account(impl Into<String>) / set_service_account(Option<String>):
    required: false
    

    The name of the Kubernetes service account that the associations use.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of EKS Pod Identity association results returned by ListPodIdentityAssociations in paginated output. When you use this parameter, ListPodIdentityAssociations returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListPodIdentityAssociations request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListPodIdentityAssociations returns up to 100 results and a nextToken value if applicable.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

    
    
• On success, responds with ListPodIdentityAssociationsOutput with field(s):
  • associations(Option<Vec::<PodIdentityAssociationSummary>>):

    The list of summarized descriptions of the associations that are in the cluster and match any filters that you provided.

    Each summary is simplified by removing these fields compared to the full PodIdentityAssociation :

    • The IAM role: roleArn

    • The timestamp that the association was created at: createdAt

    • The most recent timestamp that the association was modified at:. modifiedAt

    • The tags on the association: tags

  • next_token(Option<String>):

    The nextToken value to include in a future ListPodIdentityAssociations request. When the results of a ListPodIdentityAssociations request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

    This token should be treated as an opaque identifier that is used only to retrieve the next items in a list and not for other programmatic purposes.

• On failure, responds with SdkError<ListPodIdentityAssociationsError>

impl Client

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

    
    
• On success, responds with ListTagsForResourceOutput with field(s):
  • tags(Option<HashMap::<String, String>>):

    The tags for the resource.

• On failure, responds with SdkError<ListTagsForResourceError>

impl Client

pub fn list_updates(&self) -> ListUpdatesFluentBuilder

Constructs a fluent builder for the ListUpdates operation. This operation supports pagination; See into_paginator().

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster to list updates for.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: false
    

    The name of the Amazon EKS managed node group to list updates for.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: false
    

    The names of the installed add-ons that have available updates.

    
    
  • next_token(impl Into<String>) / set_next_token(Option<String>):
    required: false
    

    The nextToken value returned from a previous paginated ListUpdates request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

    
    
  • max_results(i32) / set_max_results(Option<i32>):
    required: false
    

    The maximum number of update results returned by ListUpdates in paginated output. When you use this parameter, ListUpdates returns only maxResults results in a single page along with a nextToken response element. You can see the remaining results of the initial request by sending another ListUpdates request with the returned nextToken value. This value can be between 1 and 100. If you don’t use this parameter, ListUpdates returns up to 100 results and a nextToken value if applicable.

    
    
• On success, responds with ListUpdatesOutput with field(s):
  • update_ids(Option<Vec::<String>>):

    A list of all the updates for the specified cluster and Region.

  • next_token(Option<String>):

    The nextToken value to include in a future ListUpdates request. When the results of a ListUpdates request exceed maxResults, you can use this value to retrieve the next page of results. This value is null when there are no more results to return.

• On failure, responds with SdkError<ListUpdatesError>

impl Client

pub fn register_cluster(&self) -> RegisterClusterFluentBuilder

Constructs a fluent builder for the RegisterCluster operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    Define a unique name for this cluster for your Region.

    
    
  • connector_config(ConnectorConfigRequest) / set_connector_config(Option<ConnectorConfigRequest>):
    required: true
    

    The configuration settings required to connect the Kubernetes cluster to the Amazon EKS control plane.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: false
    

    The metadata that you apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Cluster tags do not propagate to any other resources associated with the cluster.

    
    
• On success, responds with RegisterClusterOutput with field(s):
  • cluster(Option<Cluster>):

    An object representing an Amazon EKS cluster.

• On failure, responds with SdkError<RegisterClusterError>

impl Client

pub fn tag_resource(&self) -> TagResourceFluentBuilder

Constructs a fluent builder for the TagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

    
    
  • tags(impl Into<String>, impl Into<String>) / set_tags(Option<HashMap::<String, String>>):
    required: true
    

    The tags to add to the resource. A tag is an array of key-value pairs.

    
    
• On success, responds with TagResourceOutput
• On failure, responds with SdkError<TagResourceError>

impl Client

pub fn untag_resource(&self) -> UntagResourceFluentBuilder

Constructs a fluent builder for the UntagResource operation.

• The fluent builder is configurable:
  • resource_arn(impl Into<String>) / set_resource_arn(Option<String>):
    required: true
    

    The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon EKS clusters and managed node groups.

    
    
  • tag_keys(impl Into<String>) / set_tag_keys(Option<Vec::<String>>):
    required: true
    

    The keys of the tags to be removed.

    
    
• On success, responds with UntagResourceOutput
• On failure, responds with SdkError<UntagResourceError>

impl Client

pub fn update_addon(&self) -> UpdateAddonFluentBuilder

Constructs a fluent builder for the UpdateAddon operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster.

    
    
  • addon_name(impl Into<String>) / set_addon_name(Option<String>):
    required: true
    

    The name of the add-on. The name must match one of the names returned by ListAddons .

    
    
  • addon_version(impl Into<String>) / set_addon_version(Option<String>):
    required: false
    

    The version of the add-on. The version must match one of the versions returned by DescribeAddonVersions .

    
    
  • service_account_role_arn(impl Into<String>) / set_service_account_role_arn(Option<String>):
    required: false
    

    The Amazon Resource Name (ARN) of an existing IAM role to bind to the add-on’s service account. The role must be assigned the IAM permissions required by the add-on. If you don’t specify an existing IAM role, then the add-on uses the permissions assigned to the node IAM role. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide.

    To specify an existing IAM role, you must have an IAM OpenID Connect (OIDC) provider created for your cluster. For more information, see Enabling IAM roles for service accounts on your cluster in the Amazon EKS User Guide.

    
    
  • resolve_conflicts(ResolveConflicts) / set_resolve_conflicts(Option<ResolveConflicts>):
    required: false
    

    How to resolve field value conflicts for an Amazon EKS add-on if you’ve changed a value from the Amazon EKS default value. Conflicts are handled based on the option you choose:

    • None – Amazon EKS doesn’t change the value. The update might fail.

    • Overwrite – Amazon EKS overwrites the changed value back to the Amazon EKS default value.

    • Preserve – Amazon EKS preserves the value. If you choose this option, we recommend that you test any field and value changes on a non-production cluster before updating the add-on on your production cluster.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
  • configuration_values(impl Into<String>) / set_configuration_values(Option<String>):
    required: false
    

    The set of configuration values for the add-on that’s created. The values that you provide are validated against the schema in DescribeAddonConfiguration.

    
    
• On success, responds with UpdateAddonOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<UpdateAddonError>

impl Client

pub fn update_cluster_config(&self) -> UpdateClusterConfigFluentBuilder

Constructs a fluent builder for the UpdateClusterConfig operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster to update.

    
    
  • resources_vpc_config(VpcConfigRequest) / set_resources_vpc_config(Option<VpcConfigRequest>):
    required: false
    

    An object representing the VPC configuration to use for an Amazon EKS cluster.

    
    
  • logging(Logging) / set_logging(Option<Logging>):
    required: false
    

    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 CloudWatch Pricing.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdateClusterConfigOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<UpdateClusterConfigError>

impl Client

pub fn update_cluster_version(&self) -> UpdateClusterVersionFluentBuilder

Constructs a fluent builder for the UpdateClusterVersion operation.

• The fluent builder is configurable:
  • name(impl Into<String>) / set_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster to update.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: true
    

    The desired Kubernetes version following a successful update.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdateClusterVersionOutput with field(s):
  • update(Option<Update>):

    The full description of the specified update

• On failure, responds with SdkError<UpdateClusterVersionError>

impl Client

pub fn update_eks_anywhere_subscription( &self ) -> UpdateEksAnywhereSubscriptionFluentBuilder

Constructs a fluent builder for the UpdateEksAnywhereSubscription operation.

• The fluent builder is configurable:
  • id(impl Into<String>) / set_id(Option<String>):
    required: true
    

    The ID of the subscription.

    
    
  • auto_renew(bool) / set_auto_renew(Option<bool>):
    required: true
    

    A boolean indicating whether or not to automatically renew the subscription.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier to ensure the idempotency of the request.

    
    
• On success, responds with UpdateEksAnywhereSubscriptionOutput with field(s):
  • subscription(Option<EksAnywhereSubscription>):

    The full description of the updated subscription.

• On failure, responds with SdkError<UpdateEksAnywhereSubscriptionError>

impl Client

pub fn update_nodegroup_config(&self) -> UpdateNodegroupConfigFluentBuilder

Constructs a fluent builder for the UpdateNodegroupConfig operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster that the managed node group resides in.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: true
    

    The name of the managed node group to update.

    
    
  • labels(UpdateLabelsPayload) / set_labels(Option<UpdateLabelsPayload>):
    required: false
    

    The Kubernetes labels to be applied to the nodes in the node group after the update.

    
    
  • taints(UpdateTaintsPayload) / set_taints(Option<UpdateTaintsPayload>):
    required: false
    

    The Kubernetes taints to be applied to the nodes in the node group after the update. For more information, see Node taints on managed node groups.

    
    
  • scaling_config(NodegroupScalingConfig) / set_scaling_config(Option<NodegroupScalingConfig>):
    required: false
    

    The scaling configuration details for the Auto Scaling group after the update.

    
    
  • update_config(NodegroupUpdateConfig) / set_update_config(Option<NodegroupUpdateConfig>):
    required: false
    

    The node group update configuration.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdateNodegroupConfigOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<UpdateNodegroupConfigError>

impl Client

pub fn update_nodegroup_version(&self) -> UpdateNodegroupVersionFluentBuilder

Constructs a fluent builder for the UpdateNodegroupVersion operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the Amazon EKS cluster that is associated with the managed node group to update.

    
    
  • nodegroup_name(impl Into<String>) / set_nodegroup_name(Option<String>):
    required: true
    

    The name of the managed node group to update.

    
    
  • version(impl Into<String>) / set_version(Option<String>):
    required: false
    

    The Kubernetes version to update to. If no version is specified, then the Kubernetes version of the node group does not change. You can specify the Kubernetes version of the cluster to update the node group to the latest AMI version of the cluster’s Kubernetes version. If you specify launchTemplate, and your launch template uses a custom AMI, then don’t specify version, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • release_version(impl Into<String>) / set_release_version(Option<String>):
    required: false
    

    The AMI version of the Amazon EKS optimized AMI to use for the update. By default, the latest available AMI version for the node group’s Kubernetes version is used. For information about Linux versions, see Amazon EKS optimized Amazon Linux AMI versions in the Amazon EKS User Guide. Amazon EKS managed node groups support the November 2022 and later releases of the Windows AMIs. For information about Windows versions, see Amazon EKS optimized Windows AMI versions in the Amazon EKS User Guide.

    If you specify launchTemplate, and your launch template uses a custom AMI, then don’t specify releaseVersion, or the node group update will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide.

    
    
  • launch_template(LaunchTemplateSpecification) / set_launch_template(Option<LaunchTemplateSpecification>):
    required: false
    

    An object representing a node group’s launch template specification. You can only update a node group using a launch template if the node group was originally deployed with a launch template.

    
    
  • force(bool) / set_force(Option<bool>):
    required: false
    

    Force the update if the existing node group’s pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdateNodegroupVersionOutput with field(s):
  • update(Option<Update>):

    An object representing an asynchronous update.

• On failure, responds with SdkError<UpdateNodegroupVersionError>

impl Client

pub fn update_pod_identity_association( &self ) -> UpdatePodIdentityAssociationFluentBuilder

Constructs a fluent builder for the UpdatePodIdentityAssociation operation.

• The fluent builder is configurable:
  • cluster_name(impl Into<String>) / set_cluster_name(Option<String>):
    required: true
    

    The name of the cluster that you want to update the association in.

    
    
  • association_id(impl Into<String>) / set_association_id(Option<String>):
    required: true
    

    The ID of the association to be updated.

    
    
  • role_arn(impl Into<String>) / set_role_arn(Option<String>):
    required: false
    

    The new IAM role to change the

    
    
  • client_request_token(impl Into<String>) / set_client_request_token(Option<String>):
    required: false
    

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    
    
• On success, responds with UpdatePodIdentityAssociationOutput with field(s):
  • association(Option<PodIdentityAssociation>):

    The full description of the EKS Pod Identity association that was updated.

• On failure, responds with SdkError<UpdatePodIdentityAssociationError>

impl Client

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

Panics

This method will panic in the following cases:

• Retries or timeouts are enabled without a sleep_impl configured.
• Identity caching is enabled without a sleep_impl and time_source configured.
• No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

pub fn config(&self) -> &Config

Returns the client’s configuration.

impl Client

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

Panics

• This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
• This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
• This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Client

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.