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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-eks/types.rb

Overview

Note:

When making an API call, you may pass CreateClusterRequest data as a hash:

{
  name: "ClusterName", # required
  version: "String",
  role_arn: "String", # required
  resources_vpc_config: { # required
    subnet_ids: ["String"],
    security_group_ids: ["String"],
    endpoint_public_access: false,
    endpoint_private_access: false,
    public_access_cidrs: ["String"],
  },
  kubernetes_network_config: {
    service_ipv_4_cidr: "String",
  },
  logging: {
    cluster_logging: [
      {
        types: ["api"], # accepts api, audit, authenticator, controllerManager, scheduler
        enabled: false,
      },
    ],
  },
  client_request_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
  encryption_config: [
    {
      resources: ["String"],
      provider: {
        key_arn: "String",
      },
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_request_tokenString

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)

728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_configArray<Types::EncryptionConfig>

The encryption configuration for the cluster.

Returns:


728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#kubernetes_network_configTypes::KubernetesNetworkConfigRequest

The Kubernetes network configuration for the cluster.


728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#loggingTypes::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:


728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The unique name to give to your cluster.

Returns:

  • (String)

728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#resources_vpc_configTypes::VpcConfigRequest

The VPC configuration 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, but 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


728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#role_arnString

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)

728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The metadata to apply to the cluster to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define.

Returns:

  • (Hash<String,String>)

728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end

#versionString

The desired Kubernetes version for your cluster. If you don't specify a value here, the latest version available in Amazon EKS is used.

Returns:

  • (String)

728
729
730
731
732
733
734
735
736
737
738
739
740
# File 'lib/aws-sdk-eks/types.rb', line 728

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :kubernetes_network_config,
  :logging,
  :client_request_token,
  :tags,
  :encryption_config)
  SENSITIVE = []
  include Aws::Structure
end