Class: Aws::EKS::Types::CreateClusterRequest

Inherits:

Struct

Object
Struct
Aws::EKS::Types::CreateClusterRequest

show all

Defined in:: gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#access_config ⇒ Types::CreateAccessConfigRequest
The access configuration for the cluster.
#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.
#client_request_token ⇒ String
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
#compute_config ⇒ Types::ComputeConfigRequest
Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster.
#control_plane_scaling_config ⇒ Types::ControlPlaneScalingConfig
The control plane scaling tier configuration.
#deletion_protection ⇒ Boolean
Indicates whether to enable deletion protection for the cluster.
#encryption_config ⇒ Array<Types::EncryptionConfig>
The encryption configuration for the 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 unique name to give to your cluster.
#outpost_config ⇒ Types::OutpostConfigRequest
An object representing the configuration of your local Amazon EKS cluster on an Amazon Web Services Outpost.
#remote_network_config ⇒ Types::RemoteNetworkConfigRequest
The configuration in the cluster for EKS Hybrid Nodes.
#resources_vpc_config ⇒ Types::VpcConfigRequest
The VPC configuration that's used by the cluster control plane.
#role_arn ⇒ String
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.
#storage_config ⇒ Types::StorageConfigRequest
Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster.
#tags ⇒ Hash<String,String>
Metadata that assists with categorization and organization.
#upgrade_policy ⇒ Types::UpgradePolicyRequest
New clusters, by default, have extended support enabled.
#version ⇒ String
The desired Kubernetes version for your cluster.
#zonal_shift_config ⇒ Types::ZonalShiftConfigRequest
Enable or disable ARC zonal shift for the cluster.

Instance Attribute Details

#access_config ⇒ `Types::CreateAccessConfigRequest`

The access configuration for the cluster.

Returns:

(Types::CreateAccessConfigRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
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.

The default networking add-ons include vpc-cni, coredns, and kube-proxy.

Use this option when you plan to install third-party alternative add-ons or self-manage the default networking add-ons.

Returns:

(Boolean)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#compute_config ⇒ `Types::ComputeConfigRequest`

Enable or disable the compute capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the compute capability is enabled, EKS Auto Mode will create and delete EC2 Managed Instances in your Amazon Web Services account

Returns:

(Types::ComputeConfigRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#deletion_protection ⇒ `Boolean`

Indicates whether to enable deletion protection for the cluster. When enabled, the cluster cannot be deleted unless deletion protection is first disabled. This helps prevent accidental cluster deletion. Default value is false.

Returns:

(Boolean)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_config ⇒ `Array<Types::EncryptionConfig>`

The encryption configuration for the cluster.

Returns:

(Array<Types::EncryptionConfig>)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

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

Returns:

(String)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#outpost_config ⇒ `Types::OutpostConfigRequest`

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.

Returns:

(Types::OutpostConfigRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_vpc_config ⇒ `Types::VpcConfigRequest`

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.

Returns:

(Types::VpcConfigRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
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 Amazon Web Services API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Returns:

(String)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#storage_config ⇒ `Types::StorageConfigRequest`

Enable or disable the block storage capability of EKS Auto Mode when creating your EKS Auto Mode cluster. If the block storage capability is enabled, EKS Auto Mode will create and delete EBS volumes in your Amazon Web Services account.

Returns:

(Types::StorageConfigRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ `Hash<String,String>`

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or Amazon Web Services resources.

Returns:

(Hash<String,String>)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#upgrade_policy ⇒ `Types::UpgradePolicyRequest`

New clusters, by default, have extended support enabled. You can disable extended support when creating a cluster by setting this value to STANDARD.

Returns:

(Types::UpgradePolicyRequest)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

#version ⇒ `String`

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.

Returns:

(String)

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

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_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 Amazon 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 Amazon 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 2409

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config,
  :outpost_config,
  :access_config,
  :bootstrap_self_managed_addons,
  :upgrade_policy,
  :zonal_shift_config,
  :remote_network_config,
  :compute_config,
  :storage_config,
  :deletion_protection,
  :control_plane_scaling_config)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::EKS::Types::CreateClusterRequest

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#access_config ⇒ Types::CreateAccessConfigRequest

#bootstrap_self_managed_addons ⇒ Boolean

#client_request_token ⇒ String

#compute_config ⇒ Types::ComputeConfigRequest

#control_plane_scaling_config ⇒ Types::ControlPlaneScalingConfig

#deletion_protection ⇒ Boolean

#encryption_config ⇒ Array<Types::EncryptionConfig>

#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigRequest

#logging ⇒ Types::Logging

#name ⇒ String

#outpost_config ⇒ Types::OutpostConfigRequest

#remote_network_config ⇒ Types::RemoteNetworkConfigRequest

#resources_vpc_config ⇒ Types::VpcConfigRequest

#role_arn ⇒ String

#storage_config ⇒ Types::StorageConfigRequest

#tags ⇒ Hash<String,String>

#upgrade_policy ⇒ Types::UpgradePolicyRequest

#version ⇒ String

#zonal_shift_config ⇒ Types::ZonalShiftConfigRequest

#access_config ⇒ `Types::CreateAccessConfigRequest`

#bootstrap_self_managed_addons ⇒ `Boolean`

#client_request_token ⇒ `String`

#compute_config ⇒ `Types::ComputeConfigRequest`

#control_plane_scaling_config ⇒ `Types::ControlPlaneScalingConfig`

#deletion_protection ⇒ `Boolean`

#encryption_config ⇒ `Array<Types::EncryptionConfig>`

#kubernetes_network_config ⇒ `Types::KubernetesNetworkConfigRequest`

#logging ⇒ `Types::Logging`

#name ⇒ `String`

#outpost_config ⇒ `Types::OutpostConfigRequest`

#remote_network_config ⇒ `Types::RemoteNetworkConfigRequest`

#resources_vpc_config ⇒ `Types::VpcConfigRequest`

#role_arn ⇒ `String`

#storage_config ⇒ `Types::StorageConfigRequest`

#tags ⇒ `Hash<String,String>`

#upgrade_policy ⇒ `Types::UpgradePolicyRequest`

#version ⇒ `String`

#zonal_shift_config ⇒ `Types::ZonalShiftConfigRequest`