FargateProfile

class aws_cdk.aws_eks.FargateProfile(scope, id, *, cluster, selectors, fargate_profile_name=None, pod_execution_role=None, subnet_selection=None, vpc=None)

Bases: aws_cdk.core.Construct

Fargate profiles allows an administrator to declare which pods run on Fargate.

This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and optional labels. You must define a namespace for every selector. The label field consists of multiple optional key-value pairs. Pods that match a selector (by matching a namespace for the selector and all of the labels specified in the selector) are scheduled on Fargate. If a namespace selector is defined without any labels, Amazon EKS will attempt to schedule all pods that run in that namespace onto Fargate using the profile. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate.

If a pod matches multiple Fargate profiles, Amazon EKS picks one of the matches at random. In this case, you can specify which profile a pod should use by adding the following Kubernetes label to the pod specification: eks.amazonaws.com/fargate-profile: profile_name. However, the pod must still match a selector in that profile in order to be scheduled onto Fargate.

stability :stability: experimental

__init__(scope, id, *, cluster, selectors, fargate_profile_name=None, pod_execution_role=None, subnet_selection=None, vpc=None)
Parameters
  • scope (Construct) –

  • id (str) –

  • cluster (Cluster) – The EKS cluster to apply the Fargate profile to. [disable-awslint:ref-via-interface]

  • selectors (List[Selector]) – 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.

  • fargate_profile_name (Optional[str]) – The name of the Fargate profile. Default: - generated

  • pod_execution_role (Optional[IRole]) – 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

  • subnet_selection (Optional[SubnetSelection]) – 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. Default: - all private subnets of the VPC are selected.

  • vpc (Optional[IVpc]) – 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 theEKS cluster

stability :stability: experimental

Return type

None

Methods

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

fargate_profile_arn

The full Amazon Resource Name (ARN) of the Fargate profile.

stability :stability: experimental attribute: :attribute:: true

Return type

str

fargate_profile_name

The name of the Fargate profile.

stability :stability: experimental attribute: :attribute:: true

Return type

str

node

The construct tree node associated with this construct.

Return type

ConstructNode

pod_execution_role

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.

stability :stability: experimental

Return type

IRole

tags

Resource tags.

stability :stability: experimental

Return type

TagManager

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool