CfnFargateProfileProps

class aws_cdk.aws_eks.CfnFargateProfileProps(*, cluster_name, pod_execution_role_arn, selectors, fargate_profile_name=None, subnets=None, tags=None)

Bases: object

Properties for defining a CfnFargateProfile.

Parameters:

cluster_name (str) – The name of your cluster.
pod_execution_role_arn (str) – The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches 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 <https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html>`_ in the Amazon EKS User Guide .
selectors (Union[IResolvable, Sequence[Union[IResolvable, SelectorProperty, Dict[str, Any]]]]) – 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.
fargate_profile_name (Optional[str]) – The name of the Fargate profile.
subnets (Optional[Sequence[str]]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

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

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_eks as eks

cfn_fargate_profile_props = eks.CfnFargateProfileProps(
    cluster_name="clusterName",
    pod_execution_role_arn="podExecutionRoleArn",
    selectors=[eks.CfnFargateProfile.SelectorProperty(
        namespace="namespace",

        # the properties below are optional
        labels=[eks.CfnFargateProfile.LabelProperty(
            key="key",
            value="value"
        )]
    )],

    # the properties below are optional
    fargate_profile_name="fargateProfileName",
    subnets=["subnets"],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

cluster_name

The name of your cluster.

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

fargate_profile_name

The name of the Fargate profile.

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

pod_execution_role_arn

The Amazon Resource Name (ARN) of the Pod execution role to use for a Pod that matches 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 <https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html>`_ 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.

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.

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

tags

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.

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