You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-eks/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,
  },
  logging: {
    cluster_logging: [
      {
        types: ["api"], # accepts api, audit, authenticator, controllerManager, scheduler
        enabled: false,
      },
    ],
  },
  client_request_token: "String",
  tags: {
    "TagKey" => "TagValue",
  },
}

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)


258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  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 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 Amazon CloudWatch Pricing.

Returns:



258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  include Aws::Structure
end

#nameString

The unique name to give to your cluster.

Returns:

  • (String)


258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  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.



258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  include Aws::Structure
end

#role_arnString

The Amazon Resource Name (ARN) of the IAM role that provides permissions for Amazon EKS to make calls to other AWS API operations on your behalf. For more information, see Amazon EKS Service IAM Role in the Amazon EKS User Guide .

Returns:

  • (String)


258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  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>)


258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  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)


258
259
260
261
262
263
264
265
266
267
# File 'gems/aws-sdk-eks/lib/aws-sdk-eks/types.rb', line 258

class CreateClusterRequest < Struct.new(
  :name,
  :version,
  :role_arn,
  :resources_vpc_config,
  :logging,
  :client_request_token,
  :tags)
  include Aws::Structure
end