software.amazon.awscdk.services.eks

Class CfnFargateProfile.Builder

java.lang.Object

software.amazon.awscdk.services.eks.CfnFargateProfile.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnFargateProfile>

Enclosing class:

CfnFargateProfile

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

A fluent builder for CfnFargateProfile.

Method Summary

Modifier and Type	Method and Description
CfnFargateProfile	build()
CfnFargateProfile.Builder	clusterName(String clusterName) The name of the Amazon EKS cluster to apply the Fargate profile to.
static CfnFargateProfile.Builder	create(Construct scope, String id)
CfnFargateProfile.Builder	fargateProfileName(String fargateProfileName) The name of the Fargate profile.
CfnFargateProfile.Builder	podExecutionRoleArn(String podExecutionRoleArn) The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
CfnFargateProfile.Builder	selectors(IResolvable selectors) The selectors to match for pods to use this Fargate profile.
CfnFargateProfile.Builder	selectors(List<? extends Object> selectors) The selectors to match for pods to use this Fargate profile.
CfnFargateProfile.Builder	subnets(List<String> subnets) The IDs of subnets to launch your pods into.
CfnFargateProfile.Builder	tags(List<? extends CfnTag> tags) The metadata to apply to the Fargate profile to assist with categorization and organization.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnFargateProfile.Builder create(Construct scope,
                                                                        String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnFargateProfile.LabelProperty.Builder.

clusterName

@Stability(value=Stable)
public CfnFargateProfile.Builder clusterName(String clusterName)

The name of the Amazon EKS cluster to apply the Fargate profile to.

Parameters:

clusterName - The name of the Amazon EKS cluster to apply the Fargate profile to. This parameter is required.

Returns:

this

podExecutionRoleArn

@Stability(value=Stable)
public CfnFargateProfile.Builder podExecutionRoleArn(String podExecutionRoleArn)

The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.

The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide .

Parameters:

podExecutionRoleArn - The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. This parameter is required.

Returns:

this

selectors

@Stability(value=Stable)
public CfnFargateProfile.Builder selectors(IResolvable selectors)

The selectors to match for pods to use this Fargate profile.

Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

Parameters:

selectors - The selectors to match for pods to use this Fargate profile. This parameter is required.

Returns:

this

selectors

@Stability(value=Stable)
public CfnFargateProfile.Builder selectors(List<? extends Object> selectors)

The selectors to match for pods to use this Fargate profile.

Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.

Parameters:

selectors - The selectors to match for pods to use this Fargate profile. This parameter is required.

Returns:

this

fargateProfileName

@Stability(value=Stable)
public CfnFargateProfile.Builder fargateProfileName(String fargateProfileName)

The name of the Fargate profile.

Parameters:

fargateProfileName - The name of the Fargate profile. This parameter is required.

Returns:

this

subnets

@Stability(value=Stable)
public CfnFargateProfile.Builder subnets(List<String> subnets)

The IDs of subnets to launch your pods into.

At this time, pods running on Fargate are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.

Parameters:

subnets - The IDs of subnets to launch your pods into. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnFargateProfile.Builder tags(List<? extends CfnTag> tags)

The metadata to apply to the Fargate profile to assist with categorization and organization.

Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

Parameters:

tags - The metadata to apply to the Fargate profile to assist with categorization and organization. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnFargateProfile build()

Specified by:

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