Class: Aws::EKS::Types::CreateCapabilityRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capability_name ⇒ String

A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#client_request_token ⇒ String

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. This token is valid for 24 hours after creation. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

**A suitable default value is auto-generated.** You should normally not need to pass this option.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_name ⇒ String

The name of the Amazon EKS cluster where you want to create the capability.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ Types::CapabilityConfigurationRequest

The configuration settings for the capability. The structure of this object varies depending on the capability type. For Argo CD capabilities, you can configure IAM Identity CenterIAM; Identity Center integration, RBAC role mappings, and network access settings.

Returns:



2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#delete_propagation_policy ⇒ String

Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. Currently, the only supported value is ‘RETAIN` which retains all Kubernetes resources managed by the capability when the capability is deleted.

Because resources are retained, all Kubernetes resources created by the capability should be deleted from the cluster before deleting the capability itself. After the capability is deleted, these resources become difficult to manage because the controller is no longer available.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with Amazon Web Services services. This role must have a trust policy that allows the EKS service principal to assume it, and it must have the necessary permissions for the capability type you’re creating.

For ACK capabilities, the role needs permissions to manage the resources you want to control through Kubernetes. For Argo CD capabilities, the role needs permissions to access Git repositories and Secrets Manager. For KRO capabilities, the role needs permissions based on the resources you’ll be orchestrating.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value. You define them.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource – 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length – 128 Unicode characters in UTF-8

  • Maximum value length – 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use ‘aws:`, `AWS:`, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Returns:

  • (Hash<String,String>) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of capability to create. Valid values are:

  • ‘ACK` – Amazon Web Services Controllers for Kubernetes (ACK), which lets you manage resources directly from Kubernetes.

  • ‘ARGOCD` – Argo CD for GitOps-based continuous delivery.

  • ‘KRO` – Kube Resource Orchestrator (KRO) for composing and managing custom Kubernetes resources.

Returns:

  • (String) 


2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
 
# File 'lib/aws-sdk-eks/types.rb', line 2200

class CreateCapabilityRequest < Struct.new(
  :capability_name,
  :cluster_name,
  :client_request_token,
  :type,
  :role_arn,
  :configuration,
  :tags,
  :delete_propagation_policy)
  SENSITIVE = []
  include Aws::Structure
end