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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-eks/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #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.

• #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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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 addons 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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_config ⇒ Array<Types::EncryptionConfig>

The encryption configuration for the cluster.

Returns:

• (Array<Types::EncryptionConfig>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_network_config ⇒ Types::KubernetesNetworkConfigRequest

The Kubernetes network configuration for the cluster.

Returns:

• (Types::KubernetesNetworkConfigRequest)

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

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)
  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][1

in the <i> <i>Amazon EKS

User Guide</i> </i>.

<note markdown=“1”> CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see [CloudWatch Pricing].

</note>

[1]: docs.aws.amazon.com/eks/latest/userguide/control-plane-logs.html [2]: aws.amazon.com/cloudwatch/pricing/

Returns:

• (Types::Logging)

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

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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.

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

Returns:

• (Types::OutpostConfigRequest)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#remote_network_config ⇒ Types::RemoteNetworkConfigRequest

The configuration in the cluster for EKS Hybrid Nodes. You can’t change or update this configuration after the cluster is created.

Returns:

• (Types::RemoteNetworkConfigRequest)

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

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)
  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.

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

Returns:

• (Types::VpcConfigRequest)

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

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)
  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 .

[1]: docs.aws.amazon.com/eks/latest/userguide/service_IAM_role.html

Returns:

• (String)

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

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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 'lib/aws-sdk-eks/types.rb', line 1651

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)
  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.

<note markdown=“1”> The default version might not be the latest version available.

</note>

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#zonal_shift_config ⇒ Types::ZonalShiftConfigRequest

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

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

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

[1]: docs.aws.amazon.com/eks/latest/userguide/zone-shift.html

Returns:

• (Types::ZonalShiftConfigRequest)

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

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)
  SENSITIVE = []
  include Aws::Structure
end