Class: AWSCDK::EKSv2::ClusterCommonOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
ek_sv2/cluster_common_options.rb

Overview

Options for configuring an EKS cluster.

Direct Known Subclasses

ClusterProps, FargateClusterProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(version:, alb_controller: nil, cluster_logging: nil, cluster_name: nil, core_dns_compute_type: nil, endpoint_access: nil, ip_family: nil, kubectl_provider_options: nil, masters_role: nil, prune: nil, remote_node_networks: nil, remote_pod_networks: nil, removal_policy: nil, role: nil, secrets_encryption_key: nil, security_group: nil, service_ipv4_cidr: nil, tags: nil, vpc: nil, vpc_subnets: nil) ⇒ ClusterCommonOptions

Returns a new instance of ClusterCommonOptions.

Parameters:

  • version (AWSCDK::EKSv2::KubernetesVersion) —

    The Kubernetes version to run in the cluster.

  • alb_controller (AWSCDK::EKSv2::ALBControllerOptions, nil) (defaults to: nil) —

    Install the AWS Load Balancer Controller onto the cluster.

  • cluster_logging (Array<AWSCDK::EKSv2::ClusterLoggingTypes>, nil) (defaults to: nil) —

    The cluster log types which you want to enable.

  • cluster_name (String, nil) (defaults to: nil) —

    Name for the cluster.

  • core_dns_compute_type (AWSCDK::EKSv2::CoreDNSComputeType, nil) (defaults to: nil) —

    Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

  • endpoint_access (AWSCDK::EKSv2::EndpointAccess, nil) (defaults to: nil) —

    Configure access to the Kubernetes API server endpoint..

  • ip_family (AWSCDK::EKSv2::IPFamily, nil) (defaults to: nil) —

    Specify which IP family is used to assign Kubernetes pod and service IP addresses.

  • kubectl_provider_options (AWSCDK::EKSv2::KubectlProviderOptions, nil) (defaults to: nil) —

    Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.

  • masters_role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    An IAM role that will be added to the system:masters Kubernetes RBAC group.

  • prune (Boolean, nil) (defaults to: nil) —

    Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

  • remote_node_networks (Array<AWSCDK::EKSv2::RemoteNodeNetwork>, nil) (defaults to: nil) —

    IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.

  • remote_pod_networks (Array<AWSCDK::EKSv2::RemotePodNetwork>, nil) (defaults to: nil) —

    IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.

  • removal_policy (AWSCDK::RemovalPolicy, nil) (defaults to: nil) —

    The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.

  • role (AWSCDK::IAM::IRole, nil) (defaults to: nil) —

    Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

  • secrets_encryption_key (AWSCDK::Interfaces::AWSKMS::IKeyRef, nil) (defaults to: nil) —

    KMS secret for envelope encryption for Kubernetes secrets.

  • security_group (AWSCDK::EC2::ISecurityGroup, nil) (defaults to: nil) —

    Security Group to use for Control Plane ENIs.

  • service_ipv4_cidr (String, nil) (defaults to: nil) —

    The CIDR block to assign Kubernetes service IP addresses from.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    The tags assigned to the EKS cluster.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC in which to create the Cluster.

  • vpc_subnets (Array<AWSCDK::EC2::SubnetSelection>, nil) (defaults to: nil) —

    Where to place EKS Control Plane ENIs.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'ek_sv2/cluster_common_options.rb', line 27

def initialize(version:, alb_controller: nil, cluster_logging: nil, cluster_name: nil, core_dns_compute_type: nil, endpoint_access: nil, ip_family: nil, kubectl_provider_options: nil, masters_role: nil, prune: nil, remote_node_networks: nil, remote_pod_networks: nil, removal_policy: nil, role: nil, secrets_encryption_key: nil, security_group: nil, service_ipv4_cidr: nil, tags: nil, vpc: nil, vpc_subnets: nil)
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLkt1YmVybmV0ZXNWZXJzaW9uIn0=")), "version")
  @alb_controller = alb_controller.is_a?(Hash) ? ::AWSCDK::EKSv2::ALBControllerOptions.new(**alb_controller.transform_keys(&:to_sym)) : alb_controller
  Jsii::Type.check_type(@alb_controller, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLkFsYkNvbnRyb2xsZXJPcHRpb25zIn0=")), "albController") unless @alb_controller.nil?
  @cluster_logging = cluster_logging
  Jsii::Type.check_type(@cluster_logging, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3NfdjIuQ2x1c3RlckxvZ2dpbmdUeXBlcyJ9LCJraW5kIjoiYXJyYXkifX0=")), "clusterLogging") unless @cluster_logging.nil?
  @cluster_name = cluster_name
  Jsii::Type.check_type(@cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName") unless @cluster_name.nil?
  @core_dns_compute_type = core_dns_compute_type
  Jsii::Type.check_type(@core_dns_compute_type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLkNvcmVEbnNDb21wdXRlVHlwZSJ9")), "coreDnsComputeType") unless @core_dns_compute_type.nil?
  @endpoint_access = endpoint_access
  Jsii::Type.check_type(@endpoint_access, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLkVuZHBvaW50QWNjZXNzIn0=")), "endpointAccess") unless @endpoint_access.nil?
  @ip_family = ip_family
  Jsii::Type.check_type(@ip_family, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLklwRmFtaWx5In0=")), "ipFamily") unless @ip_family.nil?
  @kubectl_provider_options = kubectl_provider_options.is_a?(Hash) ? ::AWSCDK::EKSv2::KubectlProviderOptions.new(**kubectl_provider_options.transform_keys(&:to_sym)) : kubectl_provider_options
  Jsii::Type.check_type(@kubectl_provider_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzX3YyLkt1YmVjdGxQcm92aWRlck9wdGlvbnMifQ==")), "kubectlProviderOptions") unless @kubectl_provider_options.nil?
  @masters_role = masters_role
  Jsii::Type.check_type(@masters_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "mastersRole") unless @masters_role.nil?
  @prune = prune
  Jsii::Type.check_type(@prune, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "prune") unless @prune.nil?
  @remote_node_networks = remote_node_networks.is_a?(Array) ? remote_node_networks.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EKSv2::RemoteNodeNetwork.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : remote_node_networks
  Jsii::Type.check_type(@remote_node_networks, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3NfdjIuUmVtb3RlTm9kZU5ldHdvcmsifSwia2luZCI6ImFycmF5In19")), "remoteNodeNetworks") unless @remote_node_networks.nil?
  @remote_pod_networks = remote_pod_networks.is_a?(Array) ? remote_pod_networks.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EKSv2::RemotePodNetwork.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : remote_pod_networks
  Jsii::Type.check_type(@remote_pod_networks, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3NfdjIuUmVtb3RlUG9kTmV0d29yayJ9LCJraW5kIjoiYXJyYXkifX0=")), "remotePodNetworks") unless @remote_pod_networks.nil?
  @removal_policy = removal_policy
  Jsii::Type.check_type(@removal_policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "removalPolicy") unless @removal_policy.nil?
  @role = role
  Jsii::Type.check_type(@role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklSb2xlIn0=")), "role") unless @role.nil?
  @secrets_encryption_key = secrets_encryption_key
  Jsii::Type.check_type(@secrets_encryption_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9")), "secretsEncryptionKey") unless @secrets_encryption_key.nil?
  @security_group = security_group
  Jsii::Type.check_type(@security_group, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklTZWN1cml0eUdyb3VwIn0=")), "securityGroup") unless @security_group.nil?
  @service_ipv4_cidr = service_ipv4_cidr
  Jsii::Type.check_type(@service_ipv4_cidr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceIpv4Cidr") unless @service_ipv4_cidr.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
  @vpc_subnets = vpc_subnets.is_a?(Array) ? vpc_subnets.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::EC2::SubnetSelection.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : vpc_subnets
  Jsii::Type.check_type(@vpc_subnets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lYzIuU3VibmV0U2VsZWN0aW9uIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "vpcSubnets") unless @vpc_subnets.nil?
end

Instance Attribute Details

#alb_controller ⇒ AWSCDK::EKSv2::ALBControllerOptions? (readonly)

Note:

Default: - The controller is not installed.

Install the AWS Load Balancer Controller onto the cluster.

Returns:

See Also:



79
80
81
 
# File 'ek_sv2/cluster_common_options.rb', line 79

def alb_controller
  @alb_controller
end

#cluster_logging ⇒ Array<AWSCDK::EKSv2::ClusterLoggingTypes>? (readonly)

Note:

Default: - none

The cluster log types which you want to enable.

Returns:



84
85
86
 
# File 'ek_sv2/cluster_common_options.rb', line 84

def cluster_logging
  @cluster_logging
end

#cluster_name ⇒ String? (readonly)

Note:

Default: - Automatically generated name

Name for the cluster.

Returns:

  • (String, nil) 


89
90
91
 
# File 'ek_sv2/cluster_common_options.rb', line 89

def cluster_name
  @cluster_name
end

#core_dns_compute_type ⇒ AWSCDK::EKSv2::CoreDNSComputeType? (readonly)

Note:

Default: CoreDnsComputeType.EC2 (for FargateCluster the default is FARGATE)

Controls the "eks.amazonaws.com/compute-type" annotation in the CoreDNS configuration on your cluster to determine which compute type to use for CoreDNS.

Returns:



94
95
96
 
# File 'ek_sv2/cluster_common_options.rb', line 94

def core_dns_compute_type
  @core_dns_compute_type
end

#endpoint_access ⇒ AWSCDK::EKSv2::EndpointAccess? (readonly)

Note:

Default: EndpointAccess.PUBLIC_AND_PRIVATE

Configure access to the Kubernetes API server endpoint..

Returns:

See Also:



100
101
102
 
# File 'ek_sv2/cluster_common_options.rb', line 100

def endpoint_access
  @endpoint_access
end

#ip_family ⇒ AWSCDK::EKSv2::IPFamily? (readonly)

Note:

Default: IpFamily.IP_V4

Specify which IP family is used to assign Kubernetes pod and service IP addresses.

Returns:

See Also:



106
107
108
 
# File 'ek_sv2/cluster_common_options.rb', line 106

def ip_family
  @ip_family
end

#kubectl_provider_options ⇒ AWSCDK::EKSv2::KubectlProviderOptions? (readonly)

Note:

Default: - kubectl provider will not be created

Options for creating the kubectl provider - a lambda function that executes kubectl and helm against the cluster.

If defined, kubectl_layer is a required property.

Returns:



113
114
115
 
# File 'ek_sv2/cluster_common_options.rb', line 113

def kubectl_provider_options
  @kubectl_provider_options
end

#masters_role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - no masters role.

An IAM role that will be added to the system:masters Kubernetes RBAC group.

Returns:

See Also:



119
120
121
 
# File 'ek_sv2/cluster_common_options.rb', line 119

def masters_role
  @masters_role
end

#prune ⇒ Boolean? (readonly)

Note:

Default: true

Indicates whether Kubernetes resources added through addManifest() can be automatically pruned.

When this is enabled (default), prune labels will be allocated and injected to each resource. These labels will then be used when issuing the kubectl apply operation with the --prune switch.

Returns:

  • (Boolean, nil) 


128
129
130
 
# File 'ek_sv2/cluster_common_options.rb', line 128

def prune
  @prune
end

#remote_node_networks ⇒ Array<AWSCDK::EKSv2::RemoteNodeNetwork>? (readonly)

Note:

Default: - none

IPv4 CIDR blocks defining the expected address range of hybrid nodes that will join the cluster.

Returns:



133
134
135
 
# File 'ek_sv2/cluster_common_options.rb', line 133

def remote_node_networks
  @remote_node_networks
end

#remote_pod_networks ⇒ Array<AWSCDK::EKSv2::RemotePodNetwork>? (readonly)

Note:

Default: - none

IPv4 CIDR blocks for Pods running Kubernetes webhooks on hybrid nodes.

Returns:



138
139
140
 
# File 'ek_sv2/cluster_common_options.rb', line 138

def remote_pod_networks
  @remote_pod_networks
end

#removal_policy ⇒ AWSCDK::RemovalPolicy? (readonly)

Note:

Default: - Resources will be deleted.

The removal policy applied to all CloudFormation resources created by this construct when they are no longer managed by CloudFormation.

This can happen in one of three situations:

  • The resource is removed from the template, so CloudFormation stops managing it;
  • A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it;
  • The stack is deleted, so CloudFormation stops managing all resources in it.

This affects the EKS cluster itself, associated IAM roles, node groups, security groups, VPC and any other CloudFormation resources managed by this construct.

Returns:



152
153
154
 
# File 'ek_sv2/cluster_common_options.rb', line 152

def removal_policy
  @removal_policy
end

#role ⇒ AWSCDK::IAM::IRole? (readonly)

Note:

Default: - A role is automatically created for you

Role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Returns:



157
158
159
 
# File 'ek_sv2/cluster_common_options.rb', line 157

def role
  @role
end

#secrets_encryption_key ⇒ AWSCDK::Interfaces::AWSKMS::IKeyRef? (readonly)

Note:

Default: - By default, Kubernetes stores all secret object data within etcd and all etcd volumes used by Amazon EKS are encrypted at the disk-level using AWS-Managed encryption keys.

KMS secret for envelope encryption for Kubernetes secrets.

Returns:



162
163
164
 
# File 'ek_sv2/cluster_common_options.rb', line 162

def secrets_encryption_key
  @secrets_encryption_key
end

#security_group ⇒ AWSCDK::EC2::ISecurityGroup? (readonly)

Note:

Default: - A security group is automatically created

Security Group to use for Control Plane ENIs.

Returns:



167
168
169
 
# File 'ek_sv2/cluster_common_options.rb', line 167

def security_group
  @security_group
end

#service_ipv4_cidr ⇒ String? (readonly)

Note:

Default: - Kubernetes assigns addresses from either the 10.100.0.0/16 or 172.20.0.0/16 CIDR blocks

The CIDR block to assign Kubernetes service IP addresses from.

Returns:

  • (String, nil)

See Also:



173
174
175
 
# File 'ek_sv2/cluster_common_options.rb', line 173

def service_ipv4_cidr
  @service_ipv4_cidr
end

#tags ⇒ Hash{String => String}? (readonly)

Note:

Default: - none

The tags assigned to the EKS cluster.

Returns:

  • (Hash{String => String}, nil) 


178
179
180
 
# File 'ek_sv2/cluster_common_options.rb', line 178

def tags
  @tags
end

#version ⇒ AWSCDK::EKSv2::KubernetesVersion (readonly)

The Kubernetes version to run in the cluster.

Returns:



73
74
75
 
# File 'ek_sv2/cluster_common_options.rb', line 73

def version
  @version
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - a VPC with default configuration will be created and can be accessed through cluster.vpc.

The VPC in which to create the Cluster.

Returns:



183
184
185
 
# File 'ek_sv2/cluster_common_options.rb', line 183

def vpc
  @vpc
end

#vpc_subnets ⇒ Array<AWSCDK::EC2::SubnetSelection>? (readonly)

Note:

Default: - All public and private subnets

Where to place EKS Control Plane ENIs.

For example, to only select private subnets, supply the following:

vpcSubnets: [{ subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS }]

Returns:



192
193
194
 
# File 'ek_sv2/cluster_common_options.rb', line 192

def vpc_subnets
  @vpc_subnets
end

Class Method Details

.jsii_properties ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'ek_sv2/cluster_common_options.rb', line 194

def self.jsii_properties
  {
    :version => "version",
    :alb_controller => "albController",
    :cluster_logging => "clusterLogging",
    :cluster_name => "clusterName",
    :core_dns_compute_type => "coreDnsComputeType",
    :endpoint_access => "endpointAccess",
    :ip_family => "ipFamily",
    :kubectl_provider_options => "kubectlProviderOptions",
    :masters_role => "mastersRole",
    :prune => "prune",
    :remote_node_networks => "remoteNodeNetworks",
    :remote_pod_networks => "remotePodNetworks",
    :removal_policy => "removalPolicy",
    :role => "role",
    :secrets_encryption_key => "secretsEncryptionKey",
    :security_group => "securityGroup",
    :service_ipv4_cidr => "serviceIpv4Cidr",
    :tags => "tags",
    :vpc => "vpc",
    :vpc_subnets => "vpcSubnets",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'ek_sv2/cluster_common_options.rb', line 219

def to_jsii
  result = {}
  result.merge!({
    "version" => @version,
    "albController" => @alb_controller,
    "clusterLogging" => @cluster_logging,
    "clusterName" => @cluster_name,
    "coreDnsComputeType" => @core_dns_compute_type,
    "endpointAccess" => @endpoint_access,
    "ipFamily" => @ip_family,
    "kubectlProviderOptions" => @kubectl_provider_options,
    "mastersRole" => @masters_role,
    "prune" => @prune,
    "remoteNodeNetworks" => @remote_node_networks,
    "remotePodNetworks" => @remote_pod_networks,
    "removalPolicy" => @removal_policy,
    "role" => @role,
    "secretsEncryptionKey" => @secrets_encryption_key,
    "securityGroup" => @security_group,
    "serviceIpv4Cidr" => @service_ipv4_cidr,
    "tags" => @tags,
    "vpc" => @vpc,
    "vpcSubnets" => @vpc_subnets,
  })
  result.compact
end