aws-cdk-lib.aws_eks.FargateProfileProps

FargateProfileProps Struct

Configuration props for EKS Fargate Profiles.

FargateProfileProps

extends

• FargateProfileOptions

used as props by

• FargateProfile

Source

aws-eks/lib/fargate-profile.ts

Example

declare const cluster: eks.Cluster;
new eks.FargateProfile(this, 'MyProfile', {
  cluster,
  selectors: [ { namespace: 'default' } ],
});

Properties

clusterClusterclusterClusterclusterClusterClusterClusterClusterClusterrequired#

The EKS cluster to apply the Fargate profile to.

[disable-awslint:ref-via-interface]

fargateProfileName?optionalstringfargate_profile_name?optionalstrfargateProfileName?optionalStringFargateProfileName?optionalstringFargateProfileName?optional*string= generated#

The name of the Fargate profile.

podExecutionRole?optionalIRolepod_execution_role?optionalIRolepodExecutionRole?optionalIRolePodExecutionRole?optionalIRolePodExecutionRole?optionalIRole#

The pod execution role to use for pods that match the selectors in the Fargate profile.

Default: a role will be automatically created

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.

removalPolicy?optionalRemovalPolicyremoval_policy?optionalRemovalPolicyremovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicyRemovalPolicy?optionalRemovalPolicy= RemovalPolicy.DESTROY#

The removal policy applied to the custom resource that manages the Fargate profile.

notes

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

• The resource is removed from the template, so CloudFormation stops managing it
• A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
• The stack is deleted, so CloudFormation stops managing all resources in it

selectorsSelector[]selectorstyping.List[Selector]selectorsList<Selector>SelectorsSelector[]Selectors*[]Selectorrequired#

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.

subnetSelection?optionalSubnetSelectionsubnet_selection?optionalSubnetSelectionsubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelectionSubnetSelection?optionalSubnetSelection#

Select which subnets to launch your pods into.

Default: all private subnets of the VPC are selected.

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

vpc?optionalIVpcvpc?optionalIVpcvpc?optionalIVpcVpc?optionalIVpcVpc?optionalIVpc#

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

Default: all private subnets used by the EKS cluster

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