Interface CreateCapabilityRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>, EksRequest.Builder, SdkBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCapabilityRequest
@Mutable @NotThreadSafe public static interface CreateCapabilityRequest.Builder extends EksRequest.Builder, SdkPojo, CopyableBuilder<CreateCapabilityRequest.Builder,CreateCapabilityRequest>

  • Method Details

    • capabilityName

      CreateCapabilityRequest.Builder capabilityName(String capabilityName)

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

      Parameters:
      capabilityName - A unique name for the capability. The name must be unique within your cluster and can contain alphanumeric characters, hyphens, and underscores.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clusterName

      CreateCapabilityRequest.Builder clusterName(String clusterName)

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

      Parameters:
      clusterName - The name of the Amazon EKS cluster where you want to create the capability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientRequestToken

      CreateCapabilityRequest.Builder clientRequestToken(String clientRequestToken)

      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.

      Parameters:
      clientRequestToken - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      CreateCapabilityRequest.Builder type(String type)

      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.

      Parameters:
      type - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      CreateCapabilityRequest.Builder type(CapabilityType type)

      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.

      Parameters:
      type - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      CreateCapabilityRequest.Builder roleArn(String roleArn)

      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.

      Parameters:
      roleArn - 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:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      CreateCapabilityRequest.Builder configuration(CapabilityConfigurationRequest configuration)

      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.

      Parameters:
      configuration - 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:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default CreateCapabilityRequest.Builder configuration(Consumer<CapabilityConfigurationRequest.Builder> configuration)

      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.

      This is a convenience method that creates an instance of the CapabilityConfigurationRequest.Builder avoiding the need to create one manually via CapabilityConfigurationRequest.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configuration(CapabilityConfigurationRequest).

      Parameters:
      configuration - a consumer that will call methods on CapabilityConfigurationRequest.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateCapabilityRequest.Builder tags(Map<String,String> tags)
      Sets the value of the Tags property for this object.
      Parameters:
      tags - The new value for the Tags property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletePropagationPolicy

      CreateCapabilityRequest.Builder deletePropagationPolicy(String deletePropagationPolicy)

      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.

      Parameters:
      deletePropagationPolicy - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • deletePropagationPolicy

      CreateCapabilityRequest.Builder deletePropagationPolicy(CapabilityDeletePropagationPolicy deletePropagationPolicy)

      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.

      Parameters:
      deletePropagationPolicy - 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:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateCapabilityRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateCapabilityRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.