fargate_profiles

Creates, updates, deletes or gets a fargate_profile resource or lists fargate_profiles in a region

Overview

Name	fargate_profiles
Type	Resource
Description	Resource Schema for AWS::EKS::FargateProfile
Id	aws.eks.fargate_profiles

Fields

Name	Datatype	Description
cluster_name	string	Name of the Cluster
fargate_profile_name	string	Name of FargateProfile
pod_execution_role_arn	string	The IAM policy arn for pods
arn	string
subnets	array
selectors	array
tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ClusterName, PodExecutionRoleArn, Selectors, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all fargate_profiles in a region.

SELECT
region,
cluster_name,
fargate_profile_name,
pod_execution_role_arn,
arn,
subnets,
selectors,
tags
FROM aws.eks.fargate_profiles
WHERE region = 'us-east-1';

Gets all properties from an individual fargate_profile.

SELECT
region,
cluster_name,
fargate_profile_name,
pod_execution_role_arn,
arn,
subnets,
selectors,
tags
FROM aws.eks.fargate_profiles
WHERE region = 'us-east-1' AND data__Identifier = '<ClusterName>|<FargateProfileName>';

INSERT example

Use the following StackQL query and manifest file to create a new fargate_profile resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.eks.fargate_profiles (
 ClusterName,
 PodExecutionRoleArn,
 Selectors,
 region
)
SELECT 
'{{ ClusterName }}',
 '{{ PodExecutionRoleArn }}',
 '{{ Selectors }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.eks.fargate_profiles (
 ClusterName,
 FargateProfileName,
 PodExecutionRoleArn,
 Subnets,
 Selectors,
 Tags,
 region
)
SELECT 
 '{{ ClusterName }}',
 '{{ FargateProfileName }}',
 '{{ PodExecutionRoleArn }}',
 '{{ Subnets }}',
 '{{ Selectors }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: fargate_profile
    props:
      - name: ClusterName
        value: '{{ ClusterName }}'
      - name: FargateProfileName
        value: '{{ FargateProfileName }}'
      - name: PodExecutionRoleArn
        value: '{{ PodExecutionRoleArn }}'
      - name: Subnets
        value:
          - '{{ Subnets[0] }}'
      - name: Selectors
        value:
          - Namespace: '{{ Namespace }}'
            Labels:
              - Key: '{{ Key }}'
                Value: '{{ Value }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.eks.fargate_profiles
WHERE data__Identifier = '<ClusterName|FargateProfileName>'
AND region = 'us-east-1';

Permissions

To operate on the fargate_profiles resource, the following permissions are required:

Create

eks:CreateFargateProfile,
eks:DescribeFargateProfile,
iam:GetRole,
iam:PassRole,
iam:CreateServiceLinkedRole,
eks:TagResource

Read

eks:DescribeFargateProfile

Delete

eks:DeleteFargateProfile,
eks:DescribeFargateProfile

List

eks:ListFargateProfiles

Update

eks:DescribeFargateProfile,
eks:ListTagsForResource,
eks:TagResource,
eks:UntagResource