Skip to content

FargateProfile

Source code in docs_src/capo_eks/types/fargate_profile.py
class FargateProfile(TypedDict, closed=True):
    fargate_profile_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of the Fargate profile.</p>"""
    fargate_profile_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The full Amazon Resource Name (ARN) of the Fargate profile.</p>"""
    cluster_name: NotRequired["capo_eks.types.string.String"]
    """<p>The name of your cluster.</p>"""
    created_at: NotRequired["capo_eks.types.timestamp.Timestamp"]
    """<p>The Unix epoch timestamp at object creation.</p>"""
    pod_execution_role_arn: NotRequired["capo_eks.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the <code>Pod</code> execution role to use for any <code>Pod</code> that matches the selectors in the Fargate profile. For more information, see <a href="https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html"> <code>Pod</code> execution role</a> in the <i>Amazon EKS User Guide</i>.</p>"""
    subnets: NotRequired["capo_eks.types.string_list.StringList"]
    """<p>The IDs of subnets to launch a <code>Pod</code> into.</p>"""
    selectors: NotRequired[
        "capo_eks.types.fargate_profile_selectors.FargateProfileSelectors"
    ]
    """<p>The selectors to match for a <code>Pod</code> to use this Fargate profile.</p>"""
    status: NotRequired["capo_eks.types.fargate_profile_status.FargateProfileStatus"]
    """<p>The current status of the Fargate profile.</p>"""
    tags: NotRequired["capo_eks.types.tag_map.TagMap"]
    """<p>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 Amazon Web Services resources.</p>"""
    health: NotRequired["capo_eks.types.fargate_profile_health.FargateProfileHealth"]
    """<p>The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.</p>"""

cluster_name instance-attribute

cluster_name: NotRequired[String]

The name of your cluster.

created_at instance-attribute

created_at: NotRequired[Timestamp]

The Unix epoch timestamp at object creation.

fargate_profile_arn instance-attribute

fargate_profile_arn: NotRequired[String]

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

fargate_profile_name instance-attribute

fargate_profile_name: NotRequired[String]

The name of the Fargate profile.

health instance-attribute

health: NotRequired[FargateProfileHealth]

The health status of the Fargate profile. If there are issues with your Fargate profile's health, they are listed here.

pod_execution_role_arn instance-attribute

pod_execution_role_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the Pod execution role to use for any Pod that matches the selectors in the Fargate profile. For more information, see Pod execution role in the Amazon EKS User Guide.

selectors instance-attribute

selectors: NotRequired[FargateProfileSelectors]

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

status instance-attribute

status: NotRequired[FargateProfileStatus]

The current status of the Fargate profile.

subnets instance-attribute

subnets: NotRequired[StringList]

The IDs of subnets to launch a Pod into.

tags instance-attribute

tags: NotRequired[TagMap]

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 Amazon Web Services resources.