CfnAddonPropsMixin

class aws_cdk.mixins_preview.aws_eks.mixins.CfnAddonPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon EKS add-on.

Amazon EKS add-ons help to automate the provisioning and lifecycle management of common operational software for Amazon EKS clusters. For more information, see Amazon EKS add-ons in the Amazon EKS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-addon.html
CloudformationResource:: AWS::EKS::Addon
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

cfn_addon_props_mixin = eks_mixins.CfnAddonPropsMixin(eks_mixins.CfnAddonMixinProps(
    addon_name="addonName",
    addon_version="addonVersion",
    cluster_name="clusterName",
    configuration_values="configurationValues",
    namespace_config=eks_mixins.CfnAddonPropsMixin.NamespaceConfigProperty(
        namespace="namespace"
    ),
    pod_identity_associations=[eks_mixins.CfnAddonPropsMixin.PodIdentityAssociationProperty(
        role_arn="roleArn",
        service_account="serviceAccount"
    )],
    preserve_on_delete=False,
    resolve_conflicts="resolveConflicts",
    service_account_role_arn="serviceAccountRoleArn",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EKS::Addon.

Parameters:

props (Union[CfnAddonMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['addonName', 'addonVersion', 'clusterName', 'configurationValues', 'namespaceConfig', 'podIdentityAssociations', 'preserveOnDelete', 'resolveConflicts', 'serviceAccountRoleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

NamespaceConfigProperty

class CfnAddonPropsMixin.NamespaceConfigProperty(*, namespace=None)

Bases: object

The custom namespace configuration to use with the add-on.

Parameters:: namespace (Optional[str]) – The custom namespace for creating the add-on.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-namespaceconfig.html
ExampleMetadata:: fixture=_generated

Example:

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

namespace_config_property = eks_mixins.CfnAddonPropsMixin.NamespaceConfigProperty(
    namespace="namespace"
)

Attributes

namespace

The custom namespace for creating the add-on.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-namespaceconfig.html#cfn-eks-addon-namespaceconfig-namespace

PodIdentityAssociationProperty

class CfnAddonPropsMixin.PodIdentityAssociationProperty(*, role_arn=None, service_account=None)

Bases: object

Amazon EKS Pod Identity associations provide the ability to manage credentials for your applications, similar to the way that Amazon EC2 instance profiles provide credentials to Amazon EC2 instances.

Parameters:

role_arn (Optional[str]) – The Amazon Resource Name (ARN) of the IAM role to associate with the service account. The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account.
service_account (Optional[str]) – The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html

ExampleMetadata:

fixture=_generated

Example:

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

pod_identity_association_property = eks_mixins.CfnAddonPropsMixin.PodIdentityAssociationProperty(
    role_arn="roleArn",
    service_account="serviceAccount"
)

Attributes

role_arn

The Amazon Resource Name (ARN) of the IAM role to associate with the service account.

The EKS Pod Identity agent manages credentials to assume this role for applications in the containers in the Pods that use this service account.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html#cfn-eks-addon-podidentityassociation-rolearn

service_account

The name of the Kubernetes service account inside the cluster to associate the IAM credentials with.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-addon-podidentityassociation.html#cfn-eks-addon-podidentityassociation-serviceaccount