Class CfnFargateProfile

Creates an AWS Fargate profile for your Amazon EKS cluster.

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnFargateProfile
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.EKS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFargateProfile : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFargateProfile
    Inherits CfnResource
    Implements IInspectable, ITaggable
Remarks

You must have at least one Fargate profile in a cluster to be able to run pods on Fargate.

The Fargate profile allows an administrator to declare which pods run on Fargate and specify which pods run on which Fargate profile. This declaration is done through the profile's selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is run on Fargate.

When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet that is running on the Fargate infrastructure can register with your Amazon EKS cluster so that it can appear in your cluster as a node. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide .

Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.

If any Fargate profiles in a cluster are in the DELETING status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.

For more information, see AWS Fargate profile in the Amazon EKS User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-fargateprofile.html

CloudformationResource: AWS::EKS::FargateProfile

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EKS;

var cfnFargateProfile = new CfnFargateProfile(this, "MyCfnFargateProfile", new CfnFargateProfileProps {
    ClusterName = "clusterName",
    PodExecutionRoleArn = "podExecutionRoleArn",
    Selectors = new [] { new SelectorProperty {
        Namespace = "namespace",

        // the properties below are optional
        Labels = new [] { new LabelProperty {
            Key = "key",
            Value = "value"
        } }
    } },

    // the properties below are optional
    FargateProfileName = "fargateProfileName",
    Subnets = new [] { "subnets" },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnFargateProfile(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnFargateProfile(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
CfnFargateProfile(Construct, String, ICfnFargateProfileProps)

Properties

AttrArn

The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:fargateprofile/myCluster/myFargateProfile/1cb1a11a-1dc1-1d11-cf11-1111f11fa111 .
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties
ClusterName

The name of your cluster.
FargateProfileName

The name of the Fargate profile.
PodExecutionRoleArn

The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches the selectors in the Fargate profile.
Selectors

The selectors to match for a Pod to use this Fargate profile.
Subnets

The IDs of subnets to launch a Pod into.
Tags

Tag Manager which manages the tags for this resource.
TagsRaw

Metadata that assists with categorization and organization.

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnFargateProfile(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnFargateProfile(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnFargateProfile(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnFargateProfile(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnFargateProfile(Construct, String, ICfnFargateProfileProps)

public CfnFargateProfile(Construct scope, string id, ICfnFargateProfileProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

Construct identifier for this resource (unique in its scope).

props ICfnFargateProfileProps

Resource properties.

Properties

AttrArn

The ARN of the cluster, such as arn:aws:eks:us-west-2:666666666666:fargateprofile/myCluster/myFargateProfile/1cb1a11a-1dc1-1d11-cf11-1111f11fa111 .

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

ClusterName

The name of your cluster.

public virtual string ClusterName { get; set; }
Property Value

System.String

FargateProfileName

The name of the Fargate profile.

public virtual string FargateProfileName { get; set; }
Property Value

System.String

PodExecutionRoleArn

The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches the selectors in the Fargate profile.

public virtual string PodExecutionRoleArn { get; set; }
Property Value

System.String

Selectors

The selectors to match for a Pod to use this Fargate profile.

public virtual object Selectors { get; set; }
Property Value

System.Object

Subnets

The IDs of subnets to launch a Pod into.

public virtual string[] Subnets { get; set; }
Property Value

System.String[]

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

Metadata that assists with categorization and organization.

public virtual ICfnTag[] TagsRaw { get; set; }
Property Value

ICfnTag[]

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

Implements