class ServiceAccount (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.Eks.V2.Alpha.ServiceAccount
Go	github.com/aws/aws-cdk-go/awscdkeks-v2alpha/v2#ServiceAccount
Java	software.amazon.awscdk.services.eks.v2.alpha.ServiceAccount
Python	aws_cdk.aws_eks_v2_alpha.ServiceAccount
TypeScript (source)	@aws-cdk/aws-eks-v2-alpha » ServiceAccount

Implements IConstruct, IDependable, IPrincipal, IGrantable

Service Account.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as eks_v2_alpha from '@aws-cdk/aws-eks-v2-alpha';

declare const cluster: eks_v2_alpha.Cluster;
const serviceAccount = new eks_v2_alpha.ServiceAccount(this, 'MyServiceAccount', {
  cluster: cluster,

  // the properties below are optional
  annotations: {
    annotationsKey: 'annotations',
  },
  identityType: eks_v2_alpha.IdentityType.IRSA,
  labels: {
    labelsKey: 'labels',
  },
  name: 'name',
  namespace: 'namespace',
});

Initializer

new ServiceAccount(scope: Construct, id: string, props: ServiceAccountProps)

Parameters

• scope Construct
• id string
• props ServiceAccountProps

Construct Props

Name	Type	Description
cluster🔹	ICluster	The cluster to apply the patch to.
annotations?🔹	{ [string]: string }	Additional annotations of the service account.
identityType?🔹	IdentityType	The identity type to use for the service account.
labels?🔹	{ [string]: string }	Additional labels of the service account.
name?🔹	string	The name of the service account.
namespace?🔹	string	The namespace of the service account.

---

cluster🔹

Type: ICluster

The cluster to apply the patch to.

---

annotations?🔹

Type: { [string]: string } (optional, default: no additional annotations)

Additional annotations of the service account.

---

identityType?🔹

Type: IdentityType (optional, default: IdentityType.IRSA)

The identity type to use for the service account.

---

labels?🔹

Type: { [string]: string } (optional, default: no additional labels)

Additional labels of the service account.

---

name?🔹

Type: string (optional, default: If no name is given, it will use the id of the resource.)

The name of the service account.

The name of a ServiceAccount object must be a valid DNS subdomain name. https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/

---

namespace?🔹

Type: string (optional, default: "default")

The namespace of the service account.

All namespace names must be valid RFC 1123 DNS labels. https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/#namespaces-and-dns

Properties

Name	Type	Description
assumeRoleAction🔹	string	When this Principal is used in an AssumeRole policy, the action to use.
grantPrincipal🔹	IPrincipal	The principal to grant permissions to.
node🔹	Node	The tree node.
policyFragment🔹	PrincipalPolicyFragment	Return the policy fragment that identifies this principal in a Policy.
role🔹	IRole	The role which is linked to the service account.
serviceAccountName🔹	string	The name of the service account.
serviceAccountNamespace🔹	string	The namespace where the service account is located in.

---

assumeRoleAction🔹

Type: string

When this Principal is used in an AssumeRole policy, the action to use.

---

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

---

node🔹

Type: Node

The tree node.

---

policyFragment🔹

Type: PrincipalPolicyFragment

Return the policy fragment that identifies this principal in a Policy.

---

role🔹

Type: IRole

The role which is linked to the service account.

---

serviceAccountName🔹

Type: string

The name of the service account.

---

serviceAccountNamespace🔹

Type: string

The namespace where the service account is located in.

Methods

Name	Description
addToPolicy(statement)⚠️	Add to the policy of this principal.
addToPrincipalPolicy(statement)🔹	Add to the policy of this principal.
toString()🔹	Returns a string representation of this construct.

---

addToPolicy(statement)⚠️

public addToPolicy(statement: PolicyStatement): boolean

⚠️ Deprecated: use addToPrincipalPolicy()

Parameters

• statement PolicyStatement

Returns

• boolean

Add to the policy of this principal.

---

addToPrincipalPolicy(statement)🔹

public addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult

Parameters

• statement PolicyStatement

Returns

• AddToPrincipalPolicyResult

Add to the policy of this principal.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.