CfnServerlessClusterPropsMixin

class aws_cdk.mixins_preview.aws_msk.mixins.CfnServerlessClusterPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies the properties required for creating a serverless cluster.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-serverlesscluster.html
CloudformationResource:: AWS::MSK::ServerlessCluster
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_msk import mixins as msk_mixins

cfn_serverless_cluster_props_mixin = msk_mixins.CfnServerlessClusterPropsMixin(msk_mixins.CfnServerlessClusterMixinProps(
    client_authentication=msk_mixins.CfnServerlessClusterPropsMixin.ClientAuthenticationProperty(
        sasl=msk_mixins.CfnServerlessClusterPropsMixin.SaslProperty(
            iam=msk_mixins.CfnServerlessClusterPropsMixin.IamProperty(
                enabled=False
            )
        )
    ),
    cluster_name="clusterName",
    tags={
        "tags_key": "tags"
    },
    vpc_configs=[msk_mixins.CfnServerlessClusterPropsMixin.VpcConfigProperty(
        security_groups=["securityGroups"],
        subnet_ids=["subnetIds"]
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::MSK::ServerlessCluster.

Parameters:

props (Union[CfnServerlessClusterMixinProps, 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 = ['clientAuthentication', 'clusterName', 'tags', 'vpcConfigs']

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

ClientAuthenticationProperty

class CfnServerlessClusterPropsMixin.ClientAuthenticationProperty(*, sasl=None)

Bases: object

Includes all client authentication information.

Parameters:: sasl (Union[IResolvable, SaslProperty, Dict[str, Any], None]) – Details for client authentication using SASL. To turn on SASL, you must also turn on EncryptionInTransit by setting inCluster to true. You must set clientBroker to either TLS or TLS_PLAINTEXT . If you choose TLS_PLAINTEXT , then you must also set unauthenticated to true.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.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_msk import mixins as msk_mixins

client_authentication_property = msk_mixins.CfnServerlessClusterPropsMixin.ClientAuthenticationProperty(
    sasl=msk_mixins.CfnServerlessClusterPropsMixin.SaslProperty(
        iam=msk_mixins.CfnServerlessClusterPropsMixin.IamProperty(
            enabled=False
        )
    )
)

Attributes

sasl

Details for client authentication using SASL.

To turn on SASL, you must also turn on EncryptionInTransit by setting inCluster to true. You must set clientBroker to either TLS or TLS_PLAINTEXT . If you choose TLS_PLAINTEXT , then you must also set unauthenticated to true.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-clientauthentication.html#cfn-msk-serverlesscluster-clientauthentication-sasl

IamProperty

class CfnServerlessClusterPropsMixin.IamProperty(*, enabled=None)

Bases: object

Details for SASL/IAM client authentication.

Parameters:: enabled (Union[bool, IResolvable, None]) – SASL/IAM authentication is enabled or not.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.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_msk import mixins as msk_mixins

iam_property = msk_mixins.CfnServerlessClusterPropsMixin.IamProperty(
    enabled=False
)

Attributes

enabled

SASL/IAM authentication is enabled or not.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-iam.html#cfn-msk-serverlesscluster-iam-enabled

SaslProperty

class CfnServerlessClusterPropsMixin.SaslProperty(*, iam=None)

Bases: object

Details for client authentication using SASL.

To turn on SASL, you must also turn on EncryptionInTransit by setting inCluster to true. You must set clientBroker to either TLS or TLS_PLAINTEXT . If you choose TLS_PLAINTEXT , then you must also set unauthenticated to true.

Parameters:: iam (Union[IResolvable, IamProperty, Dict[str, Any], None]) – Details for ClientAuthentication using IAM.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.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_msk import mixins as msk_mixins

sasl_property = msk_mixins.CfnServerlessClusterPropsMixin.SaslProperty(
    iam=msk_mixins.CfnServerlessClusterPropsMixin.IamProperty(
        enabled=False
    )
)

Attributes

iam

Details for ClientAuthentication using IAM.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-sasl.html#cfn-msk-serverlesscluster-sasl-iam

VpcConfigProperty

class CfnServerlessClusterPropsMixin.VpcConfigProperty(*, security_groups=None, subnet_ids=None)

Bases: object

Parameters:

security_groups (Optional[Sequence[str]])
subnet_ids (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.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_msk import mixins as msk_mixins

vpc_config_property = msk_mixins.CfnServerlessClusterPropsMixin.VpcConfigProperty(
    security_groups=["securityGroups"],
    subnet_ids=["subnetIds"]
)

Attributes

security_groups

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html#cfn-msk-serverlesscluster-vpcconfig-securitygroups

Type:: see

subnet_ids

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-msk-serverlesscluster-vpcconfig.html#cfn-msk-serverlesscluster-vpcconfig-subnetids

Type:: see