Package software.amazon.awscdk.services.eks

Interface FargateProfileOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

FargateProfileProps

All Known Implementing Classes:

FargateProfileOptions.Jsii$Proxy, FargateProfileProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:18.764Z")
@Stability(Stable)
public interface FargateProfileOptions
extends software.amazon.jsii.JsiiSerializable

Options for defining EKS Fargate Profiles.

Example:

 Cluster cluster;
 cluster.addFargateProfile("MyProfile", FargateProfileOptions.builder()
         .selectors(List.of(Selector.builder().namespace("default").build()))
         .build());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FargateProfileOptions.Builder	builder()
default String	getFargateProfileName()	The name of the Fargate profile.
default IRole	getPodExecutionRole()	The pod execution role to use for pods that match the selectors in the Fargate profile.
List<Selector>	getSelectors()	The selectors to match for pods to use this Fargate profile.
default SubnetSelection	getSubnetSelection()	Select which subnets to launch your pods into.
default IVpc	getVpc()	The VPC from which to select subnets to launch your pods into.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSelectors

@Stability(Stable)
@NotNull
List<Selector> getSelectors()

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.

At least one selector is required and you may specify up to five selectors.

getFargateProfileName

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

The name of the Fargate profile.

Default: - generated

getPodExecutionRole

@Stability(Stable)
@Nullable
default IRole getPodExecutionRole()

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.

Default: - a role will be automatically created

See Also:

• https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html

getSubnetSelection

@Stability(Stable)
@Nullable
default SubnetSelection getSubnetSelection()

Select which 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 allowed.

You must specify the VPC to customize the subnet selection

Default: - all private subnets of the VPC are selected.

getVpc

@Stability(Stable)
@Nullable
default IVpc getVpc()

The VPC from which to select subnets to launch your pods into.

By default, all private subnets are selected. You can customize this using subnetSelection.

Default: - all private subnets used by the EKS cluster

builder

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

Returns:

a FargateProfileOptions.Builder of FargateProfileOptions