Class: AWSCDK::EKS::CfnCluster

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSEKS::IClusterRef
Defined in:
eks/cfn_cluster.rb

Overview

Creates an Amazon EKS control plane.

The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd and the API server. The control plane runs in an account managed by AWS , and the Kubernetes API is exposed by the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single tenant and unique. It runs on its own set of Amazon EC2 instances.

The cluster control plane is provisioned across multiple Availability Zones and fronted by an ELB Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the nodes (for example, to support kubectl exec , logs , and proxy data flows).

Amazon EKS nodes run in your AWS account and connect to your cluster's control plane over the Kubernetes API server endpoint and a certificate file that is created for your cluster.

You can use the endpoint_public_access and endpoint_private_access parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. The endpoint domain name and IP address family depends on the value of the ip_family for the cluster. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .

You can use the logging parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing .

In most cases, it takes several minutes to create a cluster. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch nodes into your cluster. For more information, see Allowing users to access your cluster and Launching Amazon EKS nodes in the Amazon EKS User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCluster

Create a new AWS::EKS::Cluster.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::EKS::CfnClusterProps) —

    Resource properties.



32
33
34
35
36
37
38
 
# File 'eks/cfn_cluster.rb', line 32

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::EKS::CfnClusterProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzLkNmbkNsdXN0ZXJQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_cluster(resource) ⇒ String

Parameters:

Returns:

  • (String) 


111
112
113
114
 
# File 'eks/cfn_cluster.rb', line 111

def self.arn_for_cluster(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19la3MuSUNsdXN0ZXJSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCluster", "arnForCluster", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


244
245
246
 
# File 'eks/cfn_cluster.rb', line 244

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_eks.CfnCluster", "CFN_RESOURCE_TYPE_NAME")
end

.from_cluster_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSEKS::IClusterRef

Creates a new IClusterRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



122
123
124
125
126
127
 
# File 'eks/cfn_cluster.rb', line 122

def self.from_cluster_arn(scope, id, arn)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCluster", "fromClusterArn", [scope, id, arn])
end

.from_cluster_name(scope, id, cluster_name) ⇒ AWSCDK::Interfaces::AWSEKS::IClusterRef

Creates a new IClusterRef from a clusterName.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • cluster_name (String)

Returns:



135
136
137
138
139
140
 
# File 'eks/cfn_cluster.rb', line 135

def self.from_cluster_name(scope, id, cluster_name)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(cluster_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "clusterName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCluster", "fromClusterName", [scope, id, cluster_name])
end

.is_cfn_cluster(x) ⇒ Boolean

Checks whether the given object is a CfnCluster.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'eks/cfn_cluster.rb', line 146

def self.is_cfn_cluster(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_eks.CfnCluster", "isCfnCluster", [x])
end

.jsii_overridable_methods ⇒ Object 



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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'eks/cfn_cluster.rb', line 40

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_arn => { kind: :property, name: "attrArn", is_optional: false },
    :attr_certificate_authority_data => { kind: :property, name: "attrCertificateAuthorityData", is_optional: false },
    :attr_cluster_security_group_id => { kind: :property, name: "attrClusterSecurityGroupId", is_optional: false },
    :attr_encryption_config_key_arn => { kind: :property, name: "attrEncryptionConfigKeyArn", is_optional: false },
    :attr_endpoint => { kind: :property, name: "attrEndpoint", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_kubernetes_network_config_service_ipv6_cidr => { kind: :property, name: "attrKubernetesNetworkConfigServiceIpv6Cidr", is_optional: false },
    :attr_open_id_connect_issuer_url => { kind: :property, name: "attrOpenIdConnectIssuerUrl", is_optional: false },
    :cluster_ref => { kind: :property, name: "clusterRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :resources_vpc_config => { kind: :property, name: "resourcesVpcConfig", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :access_config => { kind: :property, name: "accessConfig", is_optional: true },
    :bootstrap_self_managed_addons => { kind: :property, name: "bootstrapSelfManagedAddons", is_optional: true },
    :compute_config => { kind: :property, name: "computeConfig", is_optional: true },
    :control_plane_scaling_config => { kind: :property, name: "controlPlaneScalingConfig", is_optional: true },
    :deletion_protection => { kind: :property, name: "deletionProtection", is_optional: true },
    :encryption_config => { kind: :property, name: "encryptionConfig", is_optional: true },
    :force => { kind: :property, name: "force", is_optional: true },
    :kubernetes_network_config => { kind: :property, name: "kubernetesNetworkConfig", is_optional: true },
    :logging => { kind: :property, name: "logging", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :outpost_config => { kind: :property, name: "outpostConfig", is_optional: true },
    :remote_network_config => { kind: :property, name: "remoteNetworkConfig", is_optional: true },
    :storage_config => { kind: :property, name: "storageConfig", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :upgrade_policy => { kind: :property, name: "upgradePolicy", is_optional: true },
    :version => { kind: :property, name: "version", is_optional: true },
    :zonal_shift_config => { kind: :property, name: "zonalShiftConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#access_config ⇒ AWSCDK::IResolvable, ...

The access configuration for the cluster.

Returns:



354
355
356
 
# File 'eks/cfn_cluster.rb', line 354

def access_config()
  jsii_get_property("accessConfig")
end

#access_config=(value) ⇒ Object 



358
359
360
361
362
 
# File 'eks/cfn_cluster.rb', line 358

def access_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::AccessConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5BY2Nlc3NDb25maWdQcm9wZXJ0eSJ9XX19")), "accessConfig") unless value.nil?
  jsii_set_property("accessConfig", value)
end

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



602
603
604
605
 
# File 'eks/cfn_cluster.rb', line 602

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



614
615
616
617
 
# File 'eks/cfn_cluster.rb', line 614

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



624
625
626
627
 
# File 'eks/cfn_cluster.rb', line 624

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



635
636
637
638
639
 
# File 'eks/cfn_cluster.rb', line 635

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


692
693
694
695
696
 
# File 'eks/cfn_cluster.rb', line 692

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



702
703
704
705
 
# File 'eks/cfn_cluster.rb', line 702

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



714
715
716
717
718
 
# File 'eks/cfn_cluster.rb', line 714

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



727
728
729
730
 
# File 'eks/cfn_cluster.rb', line 727

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



749
750
751
752
753
754
 
# File 'eks/cfn_cluster.rb', line 749

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_arn ⇒ String

The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:cluster/prod .

Returns:

  • (String) 


251
252
253
 
# File 'eks/cfn_cluster.rb', line 251

def attr_arn()
  jsii_get_property("attrArn")
end

#attr_certificate_authority_data ⇒ String

The certificate-authority-data for your cluster.

Returns:

  • (String) 


258
259
260
 
# File 'eks/cfn_cluster.rb', line 258

def attr_certificate_authority_data()
  jsii_get_property("attrCertificateAuthorityData")
end

#attr_cluster_security_group_id ⇒ String

The cluster security group that was created by Amazon EKS for the cluster.

Managed node groups use this security group for control plane to data plane communication.

This parameter is only returned by Amazon EKS clusters that support managed node groups. For more information, see Managed node groups in the Amazon EKS User Guide .

Returns:

  • (String) 


269
270
271
 
# File 'eks/cfn_cluster.rb', line 269

def attr_cluster_security_group_id()
  jsii_get_property("attrClusterSecurityGroupId")
end

#attr_encryption_config_key_arn ⇒ String

Amazon Resource Name (ARN) or alias of the customer master key (CMK).

Returns:

  • (String) 


276
277
278
 
# File 'eks/cfn_cluster.rb', line 276

def attr_encryption_config_key_arn()
  jsii_get_property("attrEncryptionConfigKeyArn")
end

#attr_endpoint ⇒ String

The endpoint for your Kubernetes API server, such as https://5E1D0CEXAMPLEA591B746AFC5AB30262.yl4.us-west-2.eks.amazonaws.com .

Returns:

  • (String) 


283
284
285
 
# File 'eks/cfn_cluster.rb', line 283

def attr_endpoint()
  jsii_get_property("attrEndpoint")
end

#attr_id ⇒ String

The ID of your local Amazon EKS cluster on an AWS Outpost.

This property isn't available for an Amazon EKS cluster on the AWS cloud.

Returns:

  • (String) 


292
293
294
 
# File 'eks/cfn_cluster.rb', line 292

def attr_id()
  jsii_get_property("attrId")
end

#attr_kubernetes_network_config_service_ipv6_cidr ⇒ String

The CIDR block that Kubernetes Service IP addresses are assigned from if you created a 1.21 or later cluster with version >1.10.1 or later of the Amazon VPC CNI add-on and specified ipv6 for ipFamily when you created the cluster. Kubernetes assigns Service addresses from the unique local address range ( fc00::/7 ) because you can't specify a custom IPv6 CIDR block when you create the cluster.

Returns:

  • (String) 


299
300
301
 
# File 'eks/cfn_cluster.rb', line 299

def attr_kubernetes_network_config_service_ipv6_cidr()
  jsii_get_property("attrKubernetesNetworkConfigServiceIpv6Cidr")
end

#attr_open_id_connect_issuer_url ⇒ String

The issuer URL for the OIDC identity provider of the cluster, such as https://oidc.eks.us-west-2.amazonaws.com/id/EXAMPLED539D4633E53DE1B716D3041E . If you need to remove https:// from this output value, you can include the following code in your template.

!Select [1, !Split ["//", !GetAtt EKSCluster.OpenIdConnectIssuerUrl]]

Returns:

  • (String) 


308
309
310
 
# File 'eks/cfn_cluster.rb', line 308

def attr_open_id_connect_issuer_url()
  jsii_get_property("attrOpenIdConnectIssuerUrl")
end

#bootstrap_self_managed_addons ⇒ Boolean, ...

If you set this value to False when creating a cluster, the default networking add-ons will not be installed.

Returns:



367
368
369
 
# File 'eks/cfn_cluster.rb', line 367

def bootstrap_self_managed_addons()
  jsii_get_property("bootstrapSelfManagedAddons")
end

#bootstrap_self_managed_addons=(value) ⇒ Object 



371
372
373
374
 
# File 'eks/cfn_cluster.rb', line 371

def bootstrap_self_managed_addons=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "bootstrapSelfManagedAddons") unless value.nil?
  jsii_set_property("bootstrapSelfManagedAddons", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



197
198
199
 
# File 'eks/cfn_cluster.rb', line 197

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


202
203
204
 
# File 'eks/cfn_cluster.rb', line 202

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


758
759
760
761
 
# File 'eks/cfn_cluster.rb', line 758

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


207
208
209
 
# File 'eks/cfn_cluster.rb', line 207

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


214
215
216
 
# File 'eks/cfn_cluster.rb', line 214

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#cluster_ref ⇒ AWSCDK::Interfaces::AWSEKS::ClusterReference

A reference to a Cluster resource.

Returns:



315
316
317
 
# File 'eks/cfn_cluster.rb', line 315

def cluster_ref()
  jsii_get_property("clusterRef")
end

#compute_config ⇒ AWSCDK::IResolvable, ...

Indicates the current configuration of the compute capability on your EKS Auto Mode cluster.

Returns:



379
380
381
 
# File 'eks/cfn_cluster.rb', line 379

def compute_config()
  jsii_get_property("computeConfig")
end

#compute_config=(value) ⇒ Object 



383
384
385
386
387
 
# File 'eks/cfn_cluster.rb', line 383

def compute_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::ComputeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5Db21wdXRlQ29uZmlnUHJvcGVydHkifV19fQ==")), "computeConfig") unless value.nil?
  jsii_set_property("computeConfig", value)
end

#control_plane_scaling_config ⇒ AWSCDK::IResolvable, ...

The control plane scaling tier configuration.

Returns:



392
393
394
 
# File 'eks/cfn_cluster.rb', line 392

def control_plane_scaling_config()
  jsii_get_property("controlPlaneScalingConfig")
end

#control_plane_scaling_config=(value) ⇒ Object 



396
397
398
399
400
 
# File 'eks/cfn_cluster.rb', line 396

def control_plane_scaling_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::ControlPlaneScalingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5Db250cm9sUGxhbmVTY2FsaW5nQ29uZmlnUHJvcGVydHkifV19fQ==")), "controlPlaneScalingConfig") unless value.nil?
  jsii_set_property("controlPlaneScalingConfig", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


159
160
161
 
# File 'eks/cfn_cluster.rb', line 159

def creation_stack()
  jsii_get_property("creationStack")
end

#deletion_protection ⇒ Boolean, ...

The current deletion protection setting for the cluster.

Returns:



405
406
407
 
# File 'eks/cfn_cluster.rb', line 405

def deletion_protection()
  jsii_get_property("deletionProtection")
end

#deletion_protection=(value) ⇒ Object 



409
410
411
412
 
# File 'eks/cfn_cluster.rb', line 409

def deletion_protection=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "deletionProtection") unless value.nil?
  jsii_set_property("deletionProtection", value)
end

#encryption_config ⇒ AWSCDK::IResolvable, ...

The encryption configuration for the cluster.

Returns:



417
418
419
 
# File 'eks/cfn_cluster.rb', line 417

def encryption_config()
  jsii_get_property("encryptionConfig")
end

#encryption_config=(value) ⇒ Object 



421
422
423
424
 
# File 'eks/cfn_cluster.rb', line 421

def encryption_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWtzLkNmbkNsdXN0ZXIuRW5jcnlwdGlvbkNvbmZpZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "encryptionConfig") unless value.nil?
  jsii_set_property("encryptionConfig", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



219
220
221
 
# File 'eks/cfn_cluster.rb', line 219

def env()
  jsii_get_property("env")
end

#force ⇒ Boolean, ...

Set this value to true to override upgrade-blocking readiness checks when updating a cluster.

Returns:



429
430
431
 
# File 'eks/cfn_cluster.rb', line 429

def force()
  jsii_get_property("force")
end

#force=(value) ⇒ Object 



433
434
435
436
 
# File 'eks/cfn_cluster.rb', line 433

def force=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "force") unless value.nil?
  jsii_set_property("force", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



771
772
773
774
775
 
# File 'eks/cfn_cluster.rb', line 771

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



782
783
784
785
 
# File 'eks/cfn_cluster.rb', line 782

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



852
853
854
855
 
# File 'eks/cfn_cluster.rb', line 852

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kubernetes_network_config ⇒ AWSCDK::IResolvable, ...

The Kubernetes network configuration for the cluster.

Returns:



441
442
443
 
# File 'eks/cfn_cluster.rb', line 441

def kubernetes_network_config()
  jsii_get_property("kubernetesNetworkConfig")
end

#kubernetes_network_config=(value) ⇒ Object 



445
446
447
448
449
 
# File 'eks/cfn_cluster.rb', line 445

def kubernetes_network_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::KubernetesNetworkConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5LdWJlcm5ldGVzTmV0d29ya0NvbmZpZ1Byb3BlcnR5In1dfX0=")), "kubernetesNetworkConfig") unless value.nil?
  jsii_set_property("kubernetesNetworkConfig", value)
end

#logging ⇒ AWSCDK::IResolvable, ...

The logging configuration for your cluster.

Returns:



454
455
456
 
# File 'eks/cfn_cluster.rb', line 454

def logging()
  jsii_get_property("logging")
end

#logging=(value) ⇒ Object 



458
459
460
461
462
 
# File 'eks/cfn_cluster.rb', line 458

def logging=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::LoggingProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5Mb2dnaW5nUHJvcGVydHkifV19fQ==")), "logging") unless value.nil?
  jsii_set_property("logging", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


171
172
173
 
# File 'eks/cfn_cluster.rb', line 171

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The unique name to give to your cluster.

Returns:

  • (String, nil) 


467
468
469
 
# File 'eks/cfn_cluster.rb', line 467

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



471
472
473
474
 
# File 'eks/cfn_cluster.rb', line 471

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless value.nil?
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


154
155
156
 
# File 'eks/cfn_cluster.rb', line 154

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



793
794
795
 
# File 'eks/cfn_cluster.rb', line 793

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



800
801
802
 
# File 'eks/cfn_cluster.rb', line 800

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#outpost_config ⇒ AWSCDK::IResolvable, ...

An object representing the configuration of your local Amazon EKS cluster on an AWS Outpost.

Returns:



479
480
481
 
# File 'eks/cfn_cluster.rb', line 479

def outpost_config()
  jsii_get_property("outpostConfig")
end

#outpost_config=(value) ⇒ Object 



483
484
485
486
487
 
# File 'eks/cfn_cluster.rb', line 483

def outpost_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::OutpostConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5PdXRwb3N0Q29uZmlnUHJvcGVydHkifV19fQ==")), "outpostConfig") unless value.nil?
  jsii_set_property("outpostConfig", value)
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



593
594
595
596
 
# File 'eks/cfn_cluster.rb', line 593

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


190
191
192
 
# File 'eks/cfn_cluster.rb', line 190

def ref()
  jsii_get_property("ref")
end

#remote_network_config ⇒ AWSCDK::IResolvable, ...

The configuration in the cluster for EKS Hybrid Nodes.

Returns:



492
493
494
 
# File 'eks/cfn_cluster.rb', line 492

def remote_network_config()
  jsii_get_property("remoteNetworkConfig")
end

#remote_network_config=(value) ⇒ Object 



496
497
498
499
500
 
# File 'eks/cfn_cluster.rb', line 496

def remote_network_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::RemoteNetworkConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5SZW1vdGVOZXR3b3JrQ29uZmlnUHJvcGVydHkifV19fQ==")), "remoteNetworkConfig") unless value.nil?
  jsii_set_property("remoteNetworkConfig", value)
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



811
812
813
814
 
# File 'eks/cfn_cluster.rb', line 811

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


818
819
820
821
 
# File 'eks/cfn_cluster.rb', line 818

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



828
829
830
831
832
 
# File 'eks/cfn_cluster.rb', line 828

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#resources_vpc_config ⇒ AWSCDK::IResolvable, AWSCDK::EKS::CfnCluster::ResourcesVPCConfigProperty

The VPC configuration that's used by the cluster control plane.

Returns:



329
330
331
 
# File 'eks/cfn_cluster.rb', line 329

def resources_vpc_config()
  jsii_get_property("resourcesVpcConfig")
end

#resources_vpc_config=(value) ⇒ Object 



333
334
335
336
337
 
# File 'eks/cfn_cluster.rb', line 333

def resources_vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::ResourcesVPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5SZXNvdXJjZXNWcGNDb25maWdQcm9wZXJ0eSJ9XX19")), "resourcesVpcConfig")
  jsii_set_property("resourcesVpcConfig", value)
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that provides permissions for the Kubernetes control plane to make calls to AWS API operations on your behalf.

Returns:

  • (String) 


342
343
344
 
# File 'eks/cfn_cluster.rb', line 342

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



346
347
348
349
 
# File 'eks/cfn_cluster.rb', line 346

def role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "roleArn")
  jsii_set_property("roleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



837
838
839
 
# File 'eks/cfn_cluster.rb', line 837

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



180
181
182
 
# File 'eks/cfn_cluster.rb', line 180

def stack()
  jsii_get_property("stack")
end

#storage_config ⇒ AWSCDK::IResolvable, ...

Indicates the current configuration of the block storage capability on your EKS Auto Mode cluster.

Returns:



505
506
507
 
# File 'eks/cfn_cluster.rb', line 505

def storage_config()
  jsii_get_property("storageConfig")
end

#storage_config=(value) ⇒ Object 



509
510
511
512
513
 
# File 'eks/cfn_cluster.rb', line 509

def storage_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::StorageConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5TdG9yYWdlQ29uZmlnUHJvcGVydHkifV19fQ==")), "storageConfig") unless value.nil?
  jsii_set_property("storageConfig", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



322
323
324
 
# File 'eks/cfn_cluster.rb', line 322

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

The metadata that you apply to the cluster to assist with categorization and organization.

Returns:



518
519
520
 
# File 'eks/cfn_cluster.rb', line 518

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



522
523
524
525
526
 
# File 'eks/cfn_cluster.rb', line 522

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



569
570
571
 
# File 'eks/cfn_cluster.rb', line 569

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


227
228
229
 
# File 'eks/cfn_cluster.rb', line 227

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


237
238
239
 
# File 'eks/cfn_cluster.rb', line 237

def updated_properties()
  jsii_get_property("updatedProperties")
end

#upgrade_policy ⇒ AWSCDK::IResolvable, ...

This value indicates if extended support is enabled or disabled for the cluster.

Returns:



531
532
533
 
# File 'eks/cfn_cluster.rb', line 531

def upgrade_policy()
  jsii_get_property("upgradePolicy")
end

#upgrade_policy=(value) ⇒ Object 



535
536
537
538
539
 
# File 'eks/cfn_cluster.rb', line 535

def upgrade_policy=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::UpgradePolicyProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5VcGdyYWRlUG9saWN5UHJvcGVydHkifV19fQ==")), "upgradePolicy") unless value.nil?
  jsii_set_property("upgradePolicy", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


843
844
845
846
 
# File 'eks/cfn_cluster.rb', line 843

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#version ⇒ String?

The desired Kubernetes version for your cluster.

Returns:

  • (String, nil) 


544
545
546
 
# File 'eks/cfn_cluster.rb', line 544

def version()
  jsii_get_property("version")
end

#version=(value) ⇒ Object 



548
549
550
551
 
# File 'eks/cfn_cluster.rb', line 548

def version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "version") unless value.nil?
  jsii_set_property("version", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


582
583
584
585
586
587
 
# File 'eks/cfn_cluster.rb', line 582

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#zonal_shift_config ⇒ AWSCDK::IResolvable, ...

The configuration for zonal shift for the cluster.

Returns:



556
557
558
 
# File 'eks/cfn_cluster.rb', line 556

def zonal_shift_config()
  jsii_get_property("zonalShiftConfig")
end

#zonal_shift_config=(value) ⇒ Object 



560
561
562
563
564
 
# File 'eks/cfn_cluster.rb', line 560

def zonal_shift_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::EKS::CfnCluster::ZonalShiftConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19la3MuQ2ZuQ2x1c3Rlci5ab25hbFNoaWZ0Q29uZmlnUHJvcGVydHkifV19fQ==")), "zonalShiftConfig") unless value.nil?
  jsii_set_property("zonalShiftConfig", value)
end