Package software.amazon.awscdk.services.eks

Class CfnCapability.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnCapability.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCapability>

Enclosing class:

CfnCapability

@Stability(Stable)
public static final class CfnCapability.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCapability>

A fluent builder for CfnCapability.

Method Summary

Modifier and Type	Method	Description
CfnCapability	build()
CfnCapability.Builder	capabilityName(String capabilityName)	A unique name for the capability.
CfnCapability.Builder	clusterName(String clusterName)	The name of the EKS cluster where you want to create the capability.
CfnCapability.Builder	configuration(IResolvable configuration)	Configuration settings for a capability.
CfnCapability.Builder	configuration(CfnCapability.CapabilityConfigurationProperty configuration)	Configuration settings for a capability.
static CfnCapability.Builder	create(software.constructs.Construct scope, String id)
CfnCapability.Builder	deletePropagationPolicy(String deletePropagationPolicy)	Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted.
CfnCapability.Builder	roleArn(String roleArn)	The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services.
CfnCapability.Builder	tags(List<? extends CfnTag> tags)	An array of key-value pairs to apply to this resource.
CfnCapability.Builder	type(String type)	The type of capability to create.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnCapability.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnCapability.Builder.

capabilityName

@Stability(Stable)
public CfnCapability.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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-capabilityname

clusterName

@Stability(Stable)
public CfnCapability.Builder clusterName(String clusterName)

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

Parameters:

clusterName - The name of the EKS cluster where you want to create the capability. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-clustername

deletePropagationPolicy

@Stability(Stable)
public CfnCapability.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.

Parameters:

deletePropagationPolicy - Specifies how Kubernetes resources managed by the capability should be handled when the capability is deleted. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-deletepropagationpolicy

roleArn

@Stability(Stable)
public CfnCapability.Builder roleArn(String roleArn)

The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS 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.

Parameters:

roleArn - The Amazon Resource Name (ARN) of the IAM role that the capability uses to interact with AWS services. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-rolearn

type

@Stability(Stable)
public CfnCapability.Builder type(String type)

The type of capability to create.

Valid values are: ACK (AWS Controllers for Kubernetes, which lets you manage AWS resources directly from Kubernetes), ARGOCD (Argo CD for GitOps-based continuous delivery), or KRO (Kube Resource Orchestrator for composing and managing custom Kubernetes resources).

Parameters:

type - The type of capability to create. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-type

configuration

@Stability(Stable)
public CfnCapability.Builder configuration(IResolvable configuration)

Configuration settings for a capability.

The structure of this object varies depending on the capability type.

Parameters:

configuration - Configuration settings for a capability. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-configuration

configuration

@Stability(Stable)
public CfnCapability.Builder configuration(CfnCapability.CapabilityConfigurationProperty configuration)

Configuration settings for a capability.

The structure of this object varies depending on the capability type.

Parameters:

configuration - Configuration settings for a capability. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-configuration

tags

@Stability(Stable)
public CfnCapability.Builder tags(List<? extends CfnTag> tags)

An array of key-value pairs to apply to this resource.

Parameters:

tags - An array of key-value pairs to apply to this resource. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-capability.html#cfn-eks-capability-tags

build

@Stability(Stable)
public CfnCapability build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnCapability>

Returns:

a newly built instance of CfnCapability.