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.

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

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

• #tags ⇒ Hash<String,String>

  Metadata that assists with categorization and organization.

• #version ⇒ String

  The desired Kubernetes version for your 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 1458

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

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

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

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

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

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

#name ⇒ String

The unique name to give to your cluster.

Returns:

• (String)

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

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

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

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

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

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

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