Package 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(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	Description
CfnFargateProfile	build()
CfnFargateProfile.Builder	clusterName(String clusterName)	The name of your cluster.
static CfnFargateProfile.Builder	create(software.constructs.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 a Pod that matches the selectors in the Fargate profile.
CfnFargateProfile.Builder	selectors(List<? extends Object> selectors)	The selectors to match for a Pod to use this Fargate profile.
CfnFargateProfile.Builder	selectors(IResolvable selectors)	The selectors to match for a Pod to use this Fargate profile.
CfnFargateProfile.Builder	subnets(List<String> subnets)	The IDs of subnets to launch a Pod into.
CfnFargateProfile.Builder	tags(List<? extends CfnTag> tags)	Metadata that assists with categorization and organization.

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 CfnFargateProfile.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 CfnFargateProfile.Builder.

clusterName

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

The name of your cluster.

Parameters:

clusterName - The name of your cluster. This parameter is required.

Returns:

this

See Also:

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

podExecutionRoleArn

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

The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches 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 a Pod that matches the selectors in the Fargate profile. This parameter is required.

Returns:

this

See Also:

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

selectors

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

The selectors to match for a Pod to use this Fargate profile.

Each selector must have an associated Kubernetes 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 a Pod to use this Fargate profile. This parameter is required.

Returns:

this

See Also:

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

selectors

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

The selectors to match for a Pod to use this Fargate profile.

Each selector must have an associated Kubernetes 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 a Pod to use this Fargate profile. This parameter is required.

Returns:

this

See Also:

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

fargateProfileName

@Stability(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

See Also:

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

subnets

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

The IDs of subnets to launch a Pod into.

A Pod running on Fargate isn't assigned a public IP address, 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 a Pod into. This parameter is required.

Returns:

this

See Also:

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

tags

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

Metadata that assists with categorization and organization.

Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

Parameters:

tags - Metadata that assists with categorization and organization. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnFargateProfile build()

Specified by:

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

Returns:

a newly built instance of CfnFargateProfile.