Package software.amazon.awscdk.services.eks

Interface CfnFargateProfileProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFargateProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.109.0 (build c221850)",
           date="2025-03-14T03:24:58.042Z")
@Stability(Stable)
public interface CfnFargateProfileProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFargateProfile.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.eks.*;
 CfnFargateProfileProps cfnFargateProfileProps = CfnFargateProfileProps.builder()
         .clusterName("clusterName")
         .podExecutionRoleArn("podExecutionRoleArn")
         .selectors(List.of(SelectorProperty.builder()
                 .namespace("namespace")
                 // the properties below are optional
                 .labels(List.of(LabelProperty.builder()
                         .key("key")
                         .value("value")
                         .build()))
                 .build()))
         // the properties below are optional
         .fargateProfileName("fargateProfileName")
         .subnets(List.of("subnets"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFargateProfileProps.Builder	A builder for CfnFargateProfileProps
static final class	CfnFargateProfileProps.Jsii$Proxy	An implementation for CfnFargateProfileProps

Method Summary

Modifier and Type	Method	Description
static CfnFargateProfileProps.Builder	builder()
String	getClusterName()	The name of your cluster.
default String	getFargateProfileName()	The name of the Fargate profile.
String	getPodExecutionRoleArn()	The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches the selectors in the Fargate profile.
Object	getSelectors()	The selectors to match for a Pod to use this Fargate profile.
default List<String>	getSubnets()	The IDs of subnets to launch a Pod into.
default List<CfnTag>	getTags()	Metadata that assists with categorization and organization.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getClusterName

@Stability(Stable)
@NotNull
String getClusterName()

The name of your cluster.

See Also:

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

getPodExecutionRoleArn

@Stability(Stable)
@NotNull
String getPodExecutionRoleArn()

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 .

See Also:

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

getSelectors

@Stability(Stable)
@NotNull
Object getSelectors()

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.

See Also:

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

getFargateProfileName

@Stability(Stable)
@Nullable
default String getFargateProfileName()

The name of the Fargate profile.

See Also:

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

getSubnets

@Stability(Stable)
@Nullable
default List<String> getSubnets()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnFargateProfileProps.Builder builder()

Returns:

a CfnFargateProfileProps.Builder of CfnFargateProfileProps