Class: Aws::EKS::Types::VpcConfigRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

Note:

When making an API call, you may pass VpcConfigRequest data as a hash:

{
  subnet_ids: ["String"],
  security_group_ids: ["String"],
  endpoint_public_access: false,
  endpoint_private_access: false,
  public_access_cidrs: ["String"],
}

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#endpoint_private_accessBoolean

Set this value to `true` to enable private access for your cluster's Kubernetes API server endpoint. If you enable private access, Kubernetes API requests from within your cluster's VPC use the private VPC endpoint. The default value for this parameter is `false`, which disables private access for your Kubernetes API server. If you disable private access and you have nodes or AWS Fargate pods in the cluster, then ensure that `publicAccessCidrs` includes the necessary CIDR blocks for communication with the nodes or Fargate pods. For more information, see [Amazon EKS Cluster Endpoint Access Control] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

Returns:

  • (Boolean)

3937
3938
3939
3940
3941
3942
3943
3944
3945
# File 'lib/aws-sdk-eks/types.rb', line 3937

class VpcConfigRequest < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_public_accessBoolean

Set this value to `false` to disable public access to your cluster's Kubernetes API server endpoint. If you disable public access, your cluster's Kubernetes API server can only receive requests from within the cluster VPC. The default value for this parameter is `true`, which enables public access for your Kubernetes API server. For more information, see [Amazon EKS Cluster Endpoint Access Control] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

Returns:

  • (Boolean)

3937
3938
3939
3940
3941
3942
3943
3944
3945
# File 'lib/aws-sdk-eks/types.rb', line 3937

class VpcConfigRequest < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#public_access_cidrsArray<String>

The CIDR blocks that are allowed access to your cluster's public Kubernetes API server endpoint. Communication to the endpoint from addresses outside of the CIDR blocks that you specify is denied. The default value is `0.0.0.0/0`. If you've disabled private endpoint access and you have nodes or AWS Fargate pods in the cluster, then ensure that you specify the necessary CIDR blocks. For more information, see [Amazon EKS Cluster Endpoint Access Control] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/cluster-endpoint.html

Returns:

  • (Array<String>)

3937
3938
3939
3940
3941
3942
3943
3944
3945
# File 'lib/aws-sdk-eks/types.rb', line 3937

class VpcConfigRequest < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#security_group_idsArray<String>

Specify one or more security groups for the cross-account elastic network interfaces that Amazon EKS creates to use to allow communication between your nodes and the Kubernetes control plane. If you don't specify any security groups, then familiarize yourself with the difference between Amazon EKS defaults for clusters deployed with Kubernetes:

  • 1.14 Amazon EKS platform version `eks.2` and earlier

  • 1.14 Amazon EKS platform version `eks.3` and later

For more information, see [Amazon EKS security group considerations] in the Amazon EKS User Guide .

[1]: docs.aws.amazon.com/eks/latest/userguide/sec-group-reqs.html

Returns:

  • (Array<String>)

3937
3938
3939
3940
3941
3942
3943
3944
3945
# File 'lib/aws-sdk-eks/types.rb', line 3937

class VpcConfigRequest < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<String>

Specify subnets for your Amazon EKS nodes. Amazon EKS creates cross-account elastic network interfaces in these subnets to allow communication between your nodes and the Kubernetes control plane.

Returns:

  • (Array<String>)

3937
3938
3939
3940
3941
3942
3943
3944
3945
# File 'lib/aws-sdk-eks/types.rb', line 3937

class VpcConfigRequest < Struct.new(
  :subnet_ids,
  :security_group_ids,
  :endpoint_public_access,
  :endpoint_private_access,
  :public_access_cidrs)
  SENSITIVE = []
  include Aws::Structure
end