KubectlProviderProps

class aws_cdk.aws_eks.KubectlProviderProps(*, cluster, removal_policy=None)

Bases: object

Properties for a KubectlProvider.

Parameters:

cluster (ICluster) – The cluster to control.
removal_policy (Optional[RemovalPolicy]) – The removal policy applied to the custom resource that provides kubectl. The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations: - The resource is removed from the template, so CloudFormation stops managing it - A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it - The stack is deleted, so CloudFormation stops managing all resources in it Default: RemovalPolicy.DESTROY

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 as cdk
from aws_cdk import aws_eks as eks

# cluster: eks.Cluster

kubectl_provider_props = eks.KubectlProviderProps(
    cluster=cluster,

    # the properties below are optional
    removal_policy=cdk.RemovalPolicy.DESTROY
)

Attributes

cluster: The cluster to control.

removal_policy

The removal policy applied to the custom resource that provides kubectl.

The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations:

The resource is removed from the template, so CloudFormation stops managing it
A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it
The stack is deleted, so CloudFormation stops managing all resources in it

Default:: RemovalPolicy.DESTROY