CfnFargateProfileProps Struct
Properties for defining a CfnFargateProfile.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eks_v2 as eks_v2 } from 'aws-cdk-lib';
const cfnFargateProfileProps: eks_v2.CfnFargateProfileProps = {
clusterName: 'clusterName',
podExecutionRoleArn: 'podExecutionRoleArn',
selectors: [{
namespace: 'namespace',
// the properties below are optional
labels: [{
key: 'key',
value: 'value',
}],
}],
// the properties below are optional
fargateProfileName: 'fargateProfileName',
subnets: ['subnets'],
tags: [{
key: 'key',
value: 'value',
}],
};
Properties
The name of your cluster.
fargateProfileNameoptionalstringfargate_profile_nameoptionalstrfargateProfileNameoptionalStringFargateProfileNameoptionalstringFargateProfileNameoptional*string#The name of the Fargate profile.
podExecutionRoleArnstringpod_execution_role_arnstrpodExecutionRoleArnStringPodExecutionRoleArnstringPodExecutionRoleArn*stringrequired#The Amazon Resource Name (ARN) of the `Pod` execution role to use for a `Pod` that matches the selectors in the Fargate profile.
notes
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 .
selectorsIResolvable | IResolvable | CfnFargateProfile.SelectorProperty[]selectorstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, SelectorProperty]]]selectorsIResolvableSelectorsIResolvableSelectorsinterface{}required#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.
subnetsoptionalstring[]subnetsoptionaltyping.List[str]subnetsoptionalList<String>Subnetsoptionalstring[]Subnetsoptional*[]*string#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.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#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.