ServiceAccountProps¶

class aws_cdk.aws_eks.ServiceAccountProps(*, annotations=None, labels=None, name=None, namespace=None, cluster)¶

Bases: aws_cdk.aws_eks.ServiceAccountOptions

Properties for defining service accounts.

Parameters

annotations (Optional[Mapping[str, str]]) – Additional annotations of the service account. Default: - no additional annotations
labels (Optional[Mapping[str, str]]) – Additional labels of the service account. Default: - no additional labels
name (Optional[str]) – 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/ Default: - If no name is given, it will use the id of the resource.
namespace (Optional[str]) – 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 Default: “default”
cluster (ICluster) – The cluster to apply the patch to.

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_eks as eks

# cluster: eks.Cluster

service_account_props = eks.ServiceAccountProps(
    cluster=cluster,

    # the properties below are optional
    annotations={
        "annotations_key": "annotations"
    },
    labels={
        "labels_key": "labels"
    },
    name="name",
    namespace="namespace"
)

Attributes

annotations¶

Additional annotations of the service account.

Default

no additional annotations

Return type

Optional[Mapping[str, str]]

cluster¶

The cluster to apply the patch to.

Return type: ICluster

labels¶

Additional labels of the service account.

Default

no additional labels

Return type

Optional[Mapping[str, str]]

name¶

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/

Default

If no name is given, it will use the id of the resource.

Return type

Optional[str]

namespace¶

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

Default: “default”
Return type: Optional[str]