AwsAuth

class aws_cdk.aws_eks.AwsAuth(scope, id, *, cluster)

Bases: aws_cdk.core.Construct

(experimental) Manages mapping between IAM users and roles to Kubernetes RBAC configuration.

See

https://docs.aws.amazon.com/en_us/eks/latest/userguide/add-user-role.html

Stability

experimental

Parameters
  • scope (Construct) –

  • id (str) –

  • cluster (Cluster) – (experimental) The EKS cluster to apply this configuration to. [disable-awslint:ref-via-interface]

Stability

experimental

Methods

add_account(account_id)

(experimental) Additional AWS account to add to the aws-auth configmap.

Parameters

account_id (str) – account number.

Stability

experimental

Return type

None

add_masters_role(role, username=None)

(experimental) Adds the specified IAM role to the system:masters RBAC group, which means that anyone that can assume it will be able to administer this Kubernetes system.

Parameters
  • role (IRole) – The IAM role to add.

  • username (Optional[str]) – Optional user (defaults to the role ARN).

Stability

experimental

Return type

None

add_role_mapping(role, *, groups, username=None)

(experimental) Adds a mapping between an IAM role to a Kubernetes user and groups.

Parameters
  • role (IRole) – The IAM role to map.

  • groups (List[str]) – (experimental) A list of groups within Kubernetes to which the role is mapped.

  • username (Optional[str]) – (experimental) The user name within Kubernetes to map to the IAM role. Default: - By default, the user name is the ARN of the IAM role.

Stability

experimental

Return type

None

add_user_mapping(user, *, groups, username=None)

(experimental) Adds a mapping between an IAM user to a Kubernetes user and groups.

Parameters
  • user (IUser) – The IAM user to map.

  • groups (List[str]) – (experimental) A list of groups within Kubernetes to which the role is mapped.

  • username (Optional[str]) – (experimental) The user name within Kubernetes to map to the IAM role. Default: - By default, the user name is the ARN of the IAM role.

Stability

experimental

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Attributes

node

The construct tree node associated with this construct.

Return type

ConstructNode

Static Methods

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool