Show / Hide Table of Contents

Class FargateProfile

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

Inheritance
object
FargateProfile
Implements
ITaggable
Namespace: Amazon.CDK.AWS.Eks.V2.Alpha
Assembly: Amazon.CDK.AWS.Eks.V2.Alpha.dll
Syntax (csharp)
public class FargateProfile : Construct, ITaggable
Syntax (vb)
Public Class FargateProfile Inherits Construct Implements ITaggable
Remarks

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: Experimental

ExampleMetadata: infused

Examples
Cluster cluster;

             new FargateProfile(this, "MyProfile", new FargateProfileProps {
                 Cluster = cluster,
                 Selectors = new [] { new Selector { Namespace = "default" } }
             });

Synopsis

Constructors

FargateProfile(Construct, string, IFargateProfileProps)

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

Properties

FargateProfileArn

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

FargateProfileName

(experimental) The name of the Fargate profile.

PodExecutionRole

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

Tags

(experimental) Resource tags.

Constructors

FargateProfile(Construct, string, IFargateProfileProps)

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

public FargateProfile(Construct scope, string id, IFargateProfileProps props)
Parameters
scope Construct
id string
props IFargateProfileProps
Remarks

Stability: Experimental

Properties

FargateProfileArn

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

public virtual string FargateProfileArn { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

FargateProfileName

(experimental) The name of the Fargate profile.

public virtual string FargateProfileName { get; }
Property Value

string

Remarks

Stability: Experimental

Attribute: true

PodExecutionRole

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

public virtual IRole PodExecutionRole { get; }
Property Value

IRole

Remarks

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: Experimental

Tags

(experimental) Resource tags.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

Stability: Experimental

Implements

ITaggable
Back to top Generated by DocFX