CfnVirtualClusterPropsMixin

class aws_cdk.mixins_preview.aws_emrcontainers.mixins.CfnVirtualClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::EMRContainers::VirtualCluster resource specifies a virtual cluster.

A virtual cluster is a managed entity on Amazon EMR on EKS. You can create, describe, list, and delete virtual clusters. They do not consume any additional resources in your system. A single virtual cluster maps to a single Kubernetes namespace. Given this relationship, you can model virtual clusters the same way you model Kubernetes namespaces to meet your requirements.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-emrcontainers-virtualcluster.html
CloudformationResource:: AWS::EMRContainers::VirtualCluster
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_emrcontainers import mixins as emrcontainers_mixins

cfn_virtual_cluster_props_mixin = emrcontainers_mixins.CfnVirtualClusterPropsMixin(emrcontainers_mixins.CfnVirtualClusterMixinProps(
    container_provider=emrcontainers_mixins.CfnVirtualClusterPropsMixin.ContainerProviderProperty(
        id="id",
        info=emrcontainers_mixins.CfnVirtualClusterPropsMixin.ContainerInfoProperty(
            eks_info=emrcontainers_mixins.CfnVirtualClusterPropsMixin.EksInfoProperty(
                namespace="namespace"
            )
        ),
        type="type"
    ),
    name="name",
    security_configuration_id="securityConfigurationId",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::EMRContainers::VirtualCluster.

Parameters:

props (Union[CfnVirtualClusterMixinProps, 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 = ['containerProvider', 'name', 'securityConfigurationId', '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

ContainerInfoProperty

class CfnVirtualClusterPropsMixin.ContainerInfoProperty(*, eks_info=None)

Bases: object

The information about the container used for a job run or a managed endpoint.

Parameters:: eks_info (Union[IResolvable, EksInfoProperty, Dict[str, Any], None]) – The information about the Amazon EKS cluster.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerinfo.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_emrcontainers import mixins as emrcontainers_mixins

container_info_property = emrcontainers_mixins.CfnVirtualClusterPropsMixin.ContainerInfoProperty(
    eks_info=emrcontainers_mixins.CfnVirtualClusterPropsMixin.EksInfoProperty(
        namespace="namespace"
    )
)

Attributes

eks_info

The information about the Amazon EKS cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerinfo.html#cfn-emrcontainers-virtualcluster-containerinfo-eksinfo

ContainerProviderProperty

class CfnVirtualClusterPropsMixin.ContainerProviderProperty(*, id=None, info=None, type=None)

Bases: object

The information about the container provider.

Parameters:

id (Optional[str]) – The ID of the container cluster. Minimum : 1 Maximum : 100 Pattern : ^[0-9A-Za-z][A-Za-z0-9\-_]*
info (Union[IResolvable, ContainerInfoProperty, Dict[str, Any], None]) – The information about the container cluster.
type (Optional[str]) – The type of the container provider. Amazon EKS is the only supported type as of now.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.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_emrcontainers import mixins as emrcontainers_mixins

container_provider_property = emrcontainers_mixins.CfnVirtualClusterPropsMixin.ContainerProviderProperty(
    id="id",
    info=emrcontainers_mixins.CfnVirtualClusterPropsMixin.ContainerInfoProperty(
        eks_info=emrcontainers_mixins.CfnVirtualClusterPropsMixin.EksInfoProperty(
            namespace="namespace"
        )
    ),
    type="type"
)

Attributes

id

The ID of the container cluster.

Minimum : 1

Maximum : 100

Pattern : ^[0-9A-Za-z][A-Za-z0-9\-_]*

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-id

info

The information about the container cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-info

type

The type of the container provider.

Amazon EKS is the only supported type as of now.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-containerprovider.html#cfn-emrcontainers-virtualcluster-containerprovider-type

EksInfoProperty

class CfnVirtualClusterPropsMixin.EksInfoProperty(*, namespace=None)

Bases: object

The information about the Amazon EKS cluster.

Parameters:: namespace (Optional[str]) – The namespaces of the EKS cluster. Minimum : 1 Maximum : 63 Pattern : [a-z0-9]([-a-z0-9]*[a-z0-9])?
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.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_emrcontainers import mixins as emrcontainers_mixins

eks_info_property = emrcontainers_mixins.CfnVirtualClusterPropsMixin.EksInfoProperty(
    namespace="namespace"
)

Attributes

namespace

The namespaces of the EKS cluster.

Minimum : 1

Maximum : 63

Pattern : [a-z0-9]([-a-z0-9]*[a-z0-9])?

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-emrcontainers-virtualcluster-eksinfo.html#cfn-emrcontainers-virtualcluster-eksinfo-namespace