Interface ICfnFargateProfileProps

Properties for defining a CfnFargateProfile.

Namespace: Amazon.CDK.AWS.EKS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnFargateProfileProps

Syntax (vb)

Public Interface ICfnFargateProfileProps

Remarks

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

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 cfnFargateProfileProps = 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

Properties

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	Metadata that assists with categorization and organization.

Properties

ClusterName

The name of your cluster.

string ClusterName { get; }

Property Value

string

Remarks

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

FargateProfileName

The name of the Fargate profile.

string? FargateProfileName { get; }

Property Value

string

Remarks

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

PodExecutionRoleArn

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

string PodExecutionRoleArn { get; }

Property Value

string

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. For more information, see Pod execution role in the Amazon EKS User Guide .

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

Selectors

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

object Selectors { get; }

Property Value

object

Remarks

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.

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

Subnets

The IDs of subnets to launch a Pod into.

string[]? Subnets { get; }

Property Value

string[]

Remarks

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.

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