Class: Aws::EKS::Types::UpdateClusterConfigRequest

Inherits:

Struct

• Object
• Struct
• Aws::EKS::Types::UpdateClusterConfigRequest

Defined in:

gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_config ⇒ Types::UpdateAccessConfigRequest

  The access configuration for the cluster.

• #client_request_token ⇒ String

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

• #compute_config ⇒ Types::ComputeConfigRequest

  Update the configuration of the compute capability of your EKS Auto Mode cluster.

• #control_plane_scaling_config ⇒ Types::ControlPlaneScalingConfig

  The control plane scaling tier configuration.

• #deletion_protection ⇒ Boolean

  Specifies whether to enable or disable deletion protection for the cluster.

• #kube_api_server_config ⇒ Types::KubeApiServerConfigRequest

  The Kubernetes API server configuration for the updated cluster.

• #kube_controller_manager_config ⇒ Types::KubeControllerManagerConfigRequest

  The Kubernetes controller manager configuration for the updated cluster.

• #kube_scheduler_config ⇒ Types::KubeSchedulerConfigRequest

  The Kubernetes scheduler configuration for the updated cluster.

• #kubernetes_network_config ⇒ Types::KubernetesNetworkConfigRequest

  The Kubernetes network configuration for the cluster.

• #logging ⇒ Types::Logging

  Enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs .

• #name ⇒ String

  The name of the Amazon EKS cluster to update.

• #remote_network_config ⇒ Types::RemoteNetworkConfigRequest

  The configuration in the cluster for EKS Hybrid Nodes.

• #resources_vpc_config ⇒ Types::VpcConfigRequest

  An object representing the VPC configuration to use for the cluster update.

• #storage_config ⇒ Types::StorageConfigRequest

  Update the configuration of the block storage capability of your EKS Auto Mode cluster.

• #upgrade_policy ⇒ Types::UpgradePolicyRequest

  You can enable or disable extended support for clusters currently on standard support.

• #zonal_shift_config ⇒ Types::ZonalShiftConfigRequest

  Enable or disable ARC zonal shift for the cluster.

Instance Attribute Details

#access_config ⇒ Types::UpdateAccessConfigRequest

The access configuration for the cluster.

Returns:

• (Types::UpdateAccessConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#compute_config ⇒ Types::ComputeConfigRequest

Update the configuration of the compute capability of your EKS Auto Mode cluster. For example, enable the capability.

Returns:

• (Types::ComputeConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#control_plane_scaling_config ⇒ Types::ControlPlaneScalingConfig

The control plane scaling tier configuration. For more information, see EKS Provisioned Control Plane in the Amazon EKS User Guide.

Returns:

• (Types::ControlPlaneScalingConfig)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ Boolean

Specifies whether to enable or disable deletion protection for the cluster. When enabled (true), the cluster cannot be deleted until deletion protection is explicitly disabled. When disabled (false), the cluster can be deleted normally.

Returns:

• (Boolean)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_api_server_config ⇒ Types::KubeApiServerConfigRequest

The Kubernetes API server configuration for the updated cluster.

Returns:

• (Types::KubeApiServerConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_controller_manager_config ⇒ Types::KubeControllerManagerConfigRequest

The Kubernetes controller manager configuration for the updated cluster.

Returns:

• (Types::KubeControllerManagerConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kube_scheduler_config ⇒ Types::KubeSchedulerConfigRequest

The Kubernetes scheduler configuration for the updated cluster.

Returns:

• (Types::KubeSchedulerConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigRequest

The Kubernetes network configuration for the cluster.

Returns:

• (Types::KubernetesNetworkConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#logging ⇒ Types::Logging

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.

Returns:

• (Types::Logging)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the Amazon EKS cluster to update.

Returns:

• (String)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#remote_network_config ⇒ Types::RemoteNetworkConfigRequest

The configuration in the cluster for EKS Hybrid Nodes. You can add, change, or remove this configuration after the cluster is created.

Returns:

• (Types::RemoteNetworkConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_vpc_config ⇒ Types::VpcConfigRequest

An object representing the VPC configuration to use for the cluster update. You can use this parameter to update the control plane egress mode, the subnets used by the cluster, the security groups, and the endpoint access settings.

Returns:

• (Types::VpcConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#storage_config ⇒ Types::StorageConfigRequest

Update the configuration of the block storage capability of your EKS Auto Mode cluster. For example, enable the capability.

Returns:

• (Types::StorageConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_policy ⇒ Types::UpgradePolicyRequest

You can enable or disable extended support for clusters currently on standard support. You cannot disable extended support once it starts. You must enable extended support before your cluster exits standard support.

Returns:

• (Types::UpgradePolicyRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end

#zonal_shift_config ⇒ Types::ZonalShiftConfigRequest

Enable or disable ARC zonal shift for the cluster. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

Zonal shift is a feature of Amazon Application Recovery Controller (ARC). ARC zonal shift is designed to be a temporary measure that allows you to move traffic for a resource away from an impaired AZ until the zonal shift expires or you cancel it. You can extend the zonal shift if necessary.

You can start a zonal shift for an EKS cluster, or you can allow Amazon Web Services to do it for you by enabling zonal autoshift. This shift updates the flow of east-to-west network traffic in your cluster to only consider network endpoints for Pods running on worker nodes in healthy AZs. Additionally, any ALB or NLB handling ingress traffic for applications in your EKS cluster will automatically route traffic to targets in the healthy AZs. For more information about zonal shift in EKS, see Learn about Amazon Application Recovery Controller (ARC) Zonal Shift in Amazon EKS in the Amazon EKS User Guide .

Returns:

• (Types::ZonalShiftConfigRequest)

# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 8797

class UpdateClusterConfigRequest < Struct.new(
  :name,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :access_config,
  :upgrade_policy,
  :zonal_shift_config,
  :compute_config,
  :kubernetes_network_config,
  :storage_config,
  :remote_network_config,
  :deletion_protection,
  :control_plane_scaling_config,
  :kube_api_server_config,
  :kube_scheduler_config,
  :kube_controller_manager_config)
  SENSITIVE = []
  include Aws::Structure
end