Skip to content
v2.277.0

CfnServerlessClusterProps Struct ​

Properties for defining a CfnServerlessCluster.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const cfnServerlessClusterProps: msk.CfnServerlessClusterProps = {
  clientAuthentication: {
    sasl: {
      iam: {
        enabled: false,
      },
    },
  },
  clusterName: 'clusterName',
  vpcConfigs: [{
    subnetIds: ['subnetIds'],

    // the properties below are optional
    securityGroups: ['securityGroups'],
  }],

  // the properties below are optional
  tags: {
    tagsKey: 'tags',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_msk as msk

cfn_serverless_cluster_props = msk.CfnServerlessClusterProps(
    client_authentication=msk.CfnServerlessCluster.ClientAuthenticationProperty(
        sasl=msk.CfnServerlessCluster.SaslProperty(
            iam=msk.CfnServerlessCluster.IamProperty(
                enabled=False
            )
        )
    ),
    cluster_name="clusterName",
    vpc_configs=[msk.CfnServerlessCluster.VpcConfigProperty(
        subnet_ids=["subnetIds"],

        # the properties below are optional
        security_groups=["securityGroups"]
    )],

    # the properties below are optional
    tags={
        "tags_key": "tags"
    }
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.msk.*;

CfnServerlessClusterProps cfnServerlessClusterProps = CfnServerlessClusterProps.builder()
        .clientAuthentication(ClientAuthenticationProperty.builder()
                .sasl(SaslProperty.builder()
                        .iam(IamProperty.builder()
                                .enabled(false)
                                .build())
                        .build())
                .build())
        .clusterName("clusterName")
        .vpcConfigs(List.of(VpcConfigProperty.builder()
                .subnetIds(List.of("subnetIds"))

                // the properties below are optional
                .securityGroups(List.of("securityGroups"))
                .build()))

        // the properties below are optional
        .tags(Map.of(
                "tagsKey", "tags"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MSK;

var cfnServerlessClusterProps = new CfnServerlessClusterProps {
    ClientAuthentication = new ClientAuthenticationProperty {
        Sasl = new SaslProperty {
            Iam = new IamProperty {
                Enabled = false
            }
        }
    },
    ClusterName = "clusterName",
    VpcConfigs = new [] { new VpcConfigProperty {
        SubnetIds = new [] { "subnetIds" },

        // the properties below are optional
        SecurityGroups = new [] { "securityGroups" }
    } },

    // the properties below are optional
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnServerlessClusterProps := &CfnServerlessClusterProps{
	ClientAuthentication: &ClientAuthenticationProperty{
		Sasl: &SaslProperty{
			Iam: &IamProperty{
				Enabled: jsii.Boolean(false),
			},
		},
	},
	ClusterName: jsii.String("clusterName"),
	VpcConfigs: []interface{}{
		&VpcConfigProperty{
			SubnetIds: []*string{
				jsii.String("subnetIds"),
			},

			// the properties below are optional
			SecurityGroups: []*string{
				jsii.String("securityGroups"),
			},
		},
	},

	// the properties below are optional
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Properties ​

clientAuthenticationIResolvable | CfnServerlessCluster.ClientAuthenticationPropertyclient_authenticationtyping.Union[IResolvable, ClientAuthenticationProperty]clientAuthenticationIResolvableClientAuthenticationIResolvableClientAuthenticationinterface{} required #
Includes all client authentication related information.
clusterNamestringcluster_namestrclusterNameStringClusterNamestringClusterName*string required #
The name of the cluster.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string #
An arbitrary set of tags (key-value pairs) for the cluster.
vpcConfigsIResolvable | IResolvable | CfnServerlessCluster.VpcConfigProperty[]vpc_configstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, VpcConfigProperty]]]vpcConfigsIResolvableVpcConfigsIResolvableVpcConfigsinterface{} required #
VPC configuration information for the serverless cluster.