access_entries

Creates, updates, deletes or gets an access_entry resource or lists access_entries in a region

Overview

Name	access_entries
Type	Resource
Description	An object representing an Amazon EKS AccessEntry.
Id	awscc.eks.access_entries

Fields

get (all properties)

Name	Datatype	Description
cluster_name	string	The cluster that the access entry is created for.
principal_arn	string	The principal ARN that the access entry is created for.
username	string	The Kubernetes user that the access entry is associated with.
▶tags	array	An array of key-value pairs to apply to this resource.
access_entry_arn	string	The ARN of the access entry.
kubernetes_groups	array	The Kubernetes groups that the access entry is associated with.
▶access_policies	array	An array of access policies that are associated with the access entry.
type	string	The node type to associate with the access entry.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
cluster_name	string	The cluster that the access entry is created for.
principal_arn	string	The principal ARN that the access entry is created for.
region	string	AWS region.

For more information, see AWS::EKS::AccessEntry.

Methods

Name	Resource	Accessible by	Required Params
create_resource	access_entries	INSERT	PrincipalArn, ClusterName, region
delete_resource	access_entries	DELETE	Identifier, region
update_resource	access_entries	UPDATE	Identifier, PatchDocument, region
list_resources	access_entries_list_only	SELECT	region
get_resource	access_entries	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual access_entry.

SELECT
  region,
  cluster_name,
  principal_arn,
  username,
  tags,
  access_entry_arn,
  kubernetes_groups,
  access_policies,
  type
FROM awscc.eks.access_entries
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ principal_arn }}|{{ cluster_name }}';

list (identifiers only)

Lists all access_entries in a region.

SELECT
  region,
  principal_arn,
  cluster_name
FROM awscc.eks.access_entries_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.eks.access_entries (
  ClusterName,
  PrincipalArn,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ principal_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.eks.access_entries (
  ClusterName,
  PrincipalArn,
  Username,
  Tags,
  KubernetesGroups,
  AccessPolicies,
  Type,
  region
)
SELECT
  '{{ cluster_name }}',
  '{{ principal_arn }}',
  '{{ username }}',
  '{{ tags }}',
  '{{ kubernetes_groups }}',
  '{{ access_policies }}',
  '{{ type }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Manifest

version: 1
name: stack name
description: stack description
providers:
- aws
globals:
- name: region
  value: '{{ vars.AWS_REGION }}'
resources:
- name: access_entry
  props:
    - name: cluster_name
      value: '{{ cluster_name }}'
    - name: principal_arn
      value: '{{ principal_arn }}'
    - name: username
      value: '{{ username }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'
    - name: kubernetes_groups
      value:
        - '{{ kubernetes_groups[0] }}'
    - name: access_policies
      value:
        - policy_arn: '{{ policy_arn }}'
          access_scope:
            type: '{{ type }}'
            namespaces:
              - '{{ namespaces[0] }}'
    - name: type
      value: '{{ type }}'

UPDATE example

Use the following StackQL query and manifest file to update a access_entry resource, using stack-deploy.

/*+ update */
UPDATE awscc.eks.access_entries
SET PatchDocument = string('{{ {
    "Username": username,
    "Tags": tags,
    "KubernetesGroups": kubernetes_groups,
    "AccessPolicies": access_policies
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ principal_arn }}|{{ cluster_name }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.eks.access_entries
WHERE
  Identifier = '{{ principal_arn }}|{{ cluster_name }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

eks:CreateAccessEntry,
eks:DescribeAccessEntry,
eks:AssociateAccessPolicy,
eks:TagResource,
eks:ListAssociatedAccessPolicies

Read

eks:DescribeAccessEntry,
eks:ListAssociatedAccessPolicies

Update

eks:DescribeAccessEntry,
eks:ListAssociatedAccessPolicies,
eks:UpdateAccessEntry,
eks:AssociateAccessPolicy,
eks:DisassociateAccessPolicy,
eks:TagResource,
eks:UntagResource

Delete

eks:DeleteAccessEntry,
eks:DescribeAccessEntry

List

eks:ListAccessEntries