Skip to content

CreateFargateProfileRequest

Source code in docs_src/capo_eks/types/create_fargate_profile_request.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateFargateProfileRequest(TypedDict, closed=True):
    fargate_profile_name: "capo_eks.types.string.String"
    """<p>The name of the Fargate profile.</p>"""
    cluster_name: "capo_eks.types.string.String"
    """<p>The name of your cluster.</p>"""
    pod_execution_role_arn: "capo_eks.types.string.String"
    """<p>The Amazon Resource Name (ARN) of the <code>Pod</code> execution role to use for a <code>Pod</code> that matches the selectors in the Fargate profile. The <code>Pod</code> 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 <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. A <code>Pod</code> 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.</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. Each selector must have an associated Kubernetes <code>namespace</code>. Optionally, you can also specify <code>labels</code> for a <code>namespace</code>. You may specify up to five selectors in a Fargate profile.</p>"""
    client_request_token: NotRequired["capo_eks.types.string.String"]
    """<p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</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>"""

client_request_token instance-attribute 

client_request_token: NotRequired[String]

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

cluster_name instance-attribute 

cluster_name: String

The name of your cluster.

fargate_profile_name instance-attribute 

fargate_profile_name: String

The name of the Fargate profile.

pod_execution_role_arn instance-attribute 

pod_execution_role_arn: String

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 in the Amazon EKS User Guide.

selectors instance-attribute 

selectors: NotRequired[FargateProfileSelectors]

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.

subnets instance-attribute 

subnets: NotRequired[StringList]

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 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.