FargateProfile
eks.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | eks-controller/apis/v1alpha1#FargateProfile |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | FargateProfile |
| ListKind | FargateProfileList |
| Plural | fargateprofiles |
| Singular | fargateprofile |
An object representing an Fargate profile.
Spec
clientRequestToken: string
clusterName: string
clusterRef:
from:
name: string
name: string
podExecutionRoleARN: string
podExecutionRoleRef:
from:
name: string
selectors:
labels: {}
namespace: string
subnetRefs:
from:
name: string
subnets:
- string
tags: {}
| Field | Description |
|---|---|
| clientRequestToken Optional | string Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. |
| clusterName Optional | string The name of the Amazon EKS cluster to apply the Fargate profile to. |
| clusterRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| clusterRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| clusterRef.from.name Optional | string |
| name Required | string The name of the Fargate profile. |
| podExecutionRoleARN Optional | string 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 (https://docs.aws.amazon.com/eks/latest/userguide/pod-execution-role.html) in the Amazon EKS User Guide. |
| podExecutionRoleRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| podExecutionRoleRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| podExecutionRoleRef.from.name Optional | string |
| selectors Optional | array 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. |
| selectors.[] Required | object An object representing an Fargate profile selector. |
| selectors.[].namespace Optional | string |
| subnetRefs Optional | array |
| subnetRefs.[] Required | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: |
| from: name: my-api | |
| subnetRefs.[].from.name Optional | string |
| subnets Optional | array 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. |
| subnets.[] Required | string |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdAt: string
status: string
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata member that is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. TODO(vijat@): Find a better strategy for resources that do not have ARN in CreateOutputResponse https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRS managed by ACK have a common Status.Conditions member that contains a collection of ackv1alpha1.Condition objects that describe the various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service controllers to indicate terminal states of the CR and its backend AWS service API resource |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdAt Optional | string The Unix epoch timestamp in seconds for when the Fargate profile was created. |
| status Optional | string The current status of the Fargate profile. |