FargateProfile

eks.services.k8s.aws/v1alpha1

TypeLink
GoDoceks-controller/apis/v1alpha1#FargateProfile

Metadata

PropertyValue
ScopeNamespaced
KindFargateProfile
ListKindFargateProfileList
Pluralfargateprofiles
Singularfargateprofile

An object representing an Fargate profile.

Spec

clientRequestToken: string
clusterName: string
clusterRef: 
  from: 
    name: string
    namespace: string
name: string
podExecutionRoleARN: string
podExecutionRoleRef: 
  from: 
    name: string
    namespace: string
selectors:
  labels: {}
  namespace: string
subnetRefs:
  from: 
    name: string
    namespace: string
subnets:
- string
tags: {}
FieldDescription
clientRequestToken
Optional
string
A unique, case-sensitive identifier that you provide to ensure the idempotency
of the request.
clusterName
Optional
string
The name of your cluster.
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
clusterRef.from.namespace
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 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.
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
podExecutionRoleRef.from.namespace
Optional
string
selectors
Optional
array
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.
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**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |

| subnetRefs.[].from.name
Optional | string
| | subnetRefs.[].from.namespace
Optional | string
| | subnets
Optional | array
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. | | subnets.[]
Required | string
|| tags
Optional | object
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. |

Status

ackResourceMetadata: 
  arn: string
  ownerAccountID: string
  region: string
conditions:
- lastTransitionTime: string
  message: string
  reason: string
  status: string
  type: string
createdAt: string
health: 
  issues:
  - code: string
    message: string
    resourceIDs:
    - string
status: string
FieldDescription
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.
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 at object creation.
health
Optional
object
The health status of the Fargate profile. If there are issues with your Fargate
profile’s health, they are listed here.
health.issues
Optional
array
health.issues.[]
Required
object
An issue that is associated with the Fargate profile.
health.issues.[].message
Optional
string
health.issues.[].resourceIDs
Optional
array
health.issues.[].resourceIDs.[]
Required
string