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 the Amazon EKS cluster to apply the Fargate profile to.

  • pod_execution_role_arn (str) – 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 (Union[IResolvable, Sequence[Union[IResolvable, SelectorProperty, Dict[str, Any]]]]) – 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.

  • fargate_profile_name (Optional[str]) – The name of the Fargate profile.

  • subnets (Optional[Sequence[str]]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

Link

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.
import aws_cdk.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 the Amazon EKS cluster to apply the Fargate profile to.

Link

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

Return type

str

fargate_profile_name

The name of the Fargate profile.

Link

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

Return type

Optional[str]

pod_execution_role_arn

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 .

Link

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

Return type

str

selectors

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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, SelectorProperty]]]

subnets

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.

Link

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

Return type

Optional[List[str]]

tags

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.

Link

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

Return type

Optional[List[CfnTag]]