1.204.0

interface CfnFargateProfileProps

LanguageType name
.NETAmazon.CDK.AWS.EKS.Legacy.CfnFargateProfileProps
Javasoftware.amazon.awscdk.services.eks.legacy.CfnFargateProfileProps
Pythonaws_cdk.aws_eks_legacy.CfnFargateProfileProps
TypeScript @aws-cdk/aws-eks-legacy » CfnFargateProfileProps

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 * as eks_legacy from '@aws-cdk/aws-eks-legacy';
const cfnFargateProfileProps: eks_legacy.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

NameTypeDescription
clusterNamestringThe name of the Amazon EKS cluster to apply the Fargate profile to.
podExecutionRoleArnstringThe Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile.
selectorsIResolvable | IResolvable | SelectorProperty[]The selectors to match for pods to use this Fargate profile.
fargateProfileName?stringThe name of the Fargate profile.
subnets?string[]The IDs of subnets to launch your pods into.
tags?CfnTag[]The metadata to apply to the Fargate profile to assist with categorization and organization.

clusterName

Type: string

The name of the Amazon EKS cluster to apply the Fargate profile to.

podExecutionRoleArn

Type: string

The Amazon Resource Name (ARN) of 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. For more information, see Pod Execution Role in the Amazon EKS User Guide .

selectors

Type: IResolvable | IResolvable | SelectorProperty[]

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. You may specify up to five selectors in a Fargate profile.

fargateProfileName?

Type: string (optional)

The name of the Fargate profile.

subnets?

Type: string[] (optional)

The IDs of 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 accepted for this parameter.

tags?

Type: CfnTag[] (optional)

The metadata to apply to the Fargate profile to assist with categorization and organization.

Each tag consists of a key and an optional value. You define both. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.

← PreviousNext →