CfnCluster

class aws_cdk.aws_eks.CfnCluster(scope, id, *, encryption_config=None, kubernetes_network_config=None, logging=None, name=None, resources_vpc_config, role_arn, tags=None, version=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::EKS::Cluster.

CloudformationResource

AWS::EKS::Cluster

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html

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

# provider is of type object

cfn_cluster = eks.CfnCluster(self, "MyCfnCluster",
    resources_vpc_config=eks.CfnCluster.ResourcesVpcConfigProperty(
        subnet_ids=["subnetIds"],

        # the properties below are optional
        endpoint_private_access=False,
        endpoint_public_access=False,
        public_access_cidrs=["publicAccessCidrs"],
        security_group_ids=["securityGroupIds"]
    ),
    role_arn="roleArn",

    # the properties below are optional
    encryption_config=[eks.CfnCluster.EncryptionConfigProperty(
        provider=provider,
        resources=["resources"]
    )],
    kubernetes_network_config=eks.CfnCluster.KubernetesNetworkConfigProperty(
        service_ipv4_cidr="serviceIpv4Cidr"
    ),
    logging=eks.CfnCluster.LoggingProperty(
        cluster_logging=eks.CfnCluster.ClusterLoggingProperty(
            enabled_types=[eks.CfnCluster.LoggingTypeConfigProperty(
                type="type"
            )]
        )
    ),
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    version="version"
)

Create a new AWS::EKS::Cluster.

Parameters

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}
Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::EKS::Cluster'
attr_arn

Arn

Type

cloudformationAttribute

Return type

str

attr_certificate_authority_data

CertificateAuthorityData

Type

cloudformationAttribute

Return type

str

attr_cluster_security_group_id

ClusterSecurityGroupId

Type

cloudformationAttribute

Return type

str

attr_encryption_config_key_arn

EncryptionConfigKeyArn

Type

cloudformationAttribute

Return type

str

attr_endpoint

Endpoint

Type

cloudformationAttribute

Return type

str

attr_open_id_connect_issuer_url

OpenIdConnectIssuerUrl

Type

cloudformationAttribute

Return type

str

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

encryption_config

AWS::EKS::Cluster.EncryptionConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-encryptionconfig

Return type

Union[IResolvable, List[Union[IResolvable, EncryptionConfigProperty]], None]

kubernetes_network_config

AWS::EKS::Cluster.KubernetesNetworkConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-kubernetesnetworkconfig

Return type

Union[IResolvable, KubernetesNetworkConfigProperty, None]

logging

AWS::EKS::Cluster.Logging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-logging

Return type

Union[IResolvable, LoggingProperty, None]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

name

AWS::EKS::Cluster.Name.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-name

Return type

Optional[str]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

resources_vpc_config

AWS::EKS::Cluster.ResourcesVpcConfig.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-resourcesvpcconfig

Return type

Union[ResourcesVpcConfigProperty, IResolvable]

role_arn

AWS::EKS::Cluster.RoleArn.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-rolearn

Return type

str

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

tags

AWS::EKS::Cluster.Tags.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-tags

Return type

TagManager

version

AWS::EKS::Cluster.Version.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-cluster.html#cfn-eks-cluster-version

Return type

Optional[str]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

ClusterLoggingProperty

class CfnCluster.ClusterLoggingProperty(*, enabled_types=None)

Bases: object

Parameters

enabled_types (Union[IResolvable, Sequence[Union[IResolvable, LoggingTypeConfigProperty]], None]) – CfnCluster.ClusterLoggingProperty.EnabledTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-clusterlogging.html

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_logging_property = eks.CfnCluster.ClusterLoggingProperty(
    enabled_types=[eks.CfnCluster.LoggingTypeConfigProperty(
        type="type"
    )]
)

Attributes

enabled_types

CfnCluster.ClusterLoggingProperty.EnabledTypes.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-clusterlogging.html#cfn-eks-cluster-clusterlogging-enabledtypes

Return type

Union[IResolvable, List[Union[IResolvable, LoggingTypeConfigProperty]], None]

EncryptionConfigProperty

class CfnCluster.EncryptionConfigProperty(*, provider=None, resources=None)

Bases: object

Parameters
  • provider (Optional[Any]) – CfnCluster.EncryptionConfigProperty.Provider.

  • resources (Optional[Sequence[str]]) – CfnCluster.EncryptionConfigProperty.Resources.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html

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

# provider is of type object

encryption_config_property = eks.CfnCluster.EncryptionConfigProperty(
    provider=provider,
    resources=["resources"]
)

Attributes

provider

CfnCluster.EncryptionConfigProperty.Provider.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html#cfn-eks-cluster-encryptionconfig-provider

Return type

Any

resources

CfnCluster.EncryptionConfigProperty.Resources.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-encryptionconfig.html#cfn-eks-cluster-encryptionconfig-resources

Return type

Optional[List[str]]

KubernetesNetworkConfigProperty

class CfnCluster.KubernetesNetworkConfigProperty(*, service_ipv4_cidr=None)

Bases: object

Parameters

service_ipv4_cidr (Optional[str]) – CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html

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

kubernetes_network_config_property = eks.CfnCluster.KubernetesNetworkConfigProperty(
    service_ipv4_cidr="serviceIpv4Cidr"
)

Attributes

service_ipv4_cidr

CfnCluster.KubernetesNetworkConfigProperty.ServiceIpv4Cidr.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-kubernetesnetworkconfig.html#cfn-eks-cluster-kubernetesnetworkconfig-serviceipv4cidr

Return type

Optional[str]

LoggingProperty

class CfnCluster.LoggingProperty(*, cluster_logging=None)

Bases: object

Parameters

cluster_logging (Union[IResolvable, ClusterLoggingProperty, None]) – CfnCluster.LoggingProperty.ClusterLogging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-logging.html

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

logging_property = eks.CfnCluster.LoggingProperty(
    cluster_logging=eks.CfnCluster.ClusterLoggingProperty(
        enabled_types=[eks.CfnCluster.LoggingTypeConfigProperty(
            type="type"
        )]
    )
)

Attributes

cluster_logging

CfnCluster.LoggingProperty.ClusterLogging.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-logging.html#cfn-eks-cluster-logging-clusterlogging

Return type

Union[IResolvable, ClusterLoggingProperty, None]

LoggingTypeConfigProperty

class CfnCluster.LoggingTypeConfigProperty(*, type=None)

Bases: object

Parameters

type (Optional[str]) – CfnCluster.LoggingTypeConfigProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-loggingtypeconfig.html

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

logging_type_config_property = eks.CfnCluster.LoggingTypeConfigProperty(
    type="type"
)

Attributes

type

CfnCluster.LoggingTypeConfigProperty.Type.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-loggingtypeconfig.html#cfn-eks-cluster-loggingtypeconfig-type

Return type

Optional[str]

ResourcesVpcConfigProperty

class CfnCluster.ResourcesVpcConfigProperty(*, endpoint_private_access=None, endpoint_public_access=None, public_access_cidrs=None, security_group_ids=None, subnet_ids)

Bases: object

Parameters
  • endpoint_private_access (Union[bool, IResolvable, None]) – CfnCluster.ResourcesVpcConfigProperty.EndpointPrivateAccess.

  • endpoint_public_access (Union[bool, IResolvable, None]) – CfnCluster.ResourcesVpcConfigProperty.EndpointPublicAccess.

  • public_access_cidrs (Optional[Sequence[str]]) – CfnCluster.ResourcesVpcConfigProperty.PublicAccessCidrs.

  • security_group_ids (Optional[Sequence[str]]) – CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds.

  • subnet_ids (Sequence[str]) – CfnCluster.ResourcesVpcConfigProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html

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

resources_vpc_config_property = eks.CfnCluster.ResourcesVpcConfigProperty(
    subnet_ids=["subnetIds"],

    # the properties below are optional
    endpoint_private_access=False,
    endpoint_public_access=False,
    public_access_cidrs=["publicAccessCidrs"],
    security_group_ids=["securityGroupIds"]
)

Attributes

endpoint_private_access

CfnCluster.ResourcesVpcConfigProperty.EndpointPrivateAccess.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-endpointprivateaccess

Return type

Union[bool, IResolvable, None]

endpoint_public_access

CfnCluster.ResourcesVpcConfigProperty.EndpointPublicAccess.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-endpointpublicaccess

Return type

Union[bool, IResolvable, None]

public_access_cidrs

CfnCluster.ResourcesVpcConfigProperty.PublicAccessCidrs.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-publicaccesscidrs

Return type

Optional[List[str]]

security_group_ids

CfnCluster.ResourcesVpcConfigProperty.SecurityGroupIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-securitygroupids

Return type

Optional[List[str]]

subnet_ids

CfnCluster.ResourcesVpcConfigProperty.SubnetIds.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eks-cluster-resourcesvpcconfig.html#cfn-eks-cluster-resourcesvpcconfig-subnetids

Return type

List[str]