1. Packages
  2. AWS
  3. API Docs
  4. msk
  5. ServerlessCluster
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

aws.msk.ServerlessCluster

aws logo
Viewing docs for AWS v5.43.0 (Older version)
published on Tuesday, Mar 10, 2026 by Pulumi
Go to latest version
Schema (JSON)
pulumi/pulumi-aws

    Manages an Amazon MSK Serverless cluster.

    Note: To manage a provisioned Amazon MSK cluster, use the aws.msk.Cluster resource.

    Create ServerlessCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ServerlessCluster(name: string, args: ServerlessClusterArgs, opts?: CustomResourceOptions);
    @overload
def ServerlessCluster(resource_name: str,
                      args: ServerlessClusterArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def ServerlessCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      client_authentication: Optional[ServerlessClusterClientAuthenticationArgs] = None,
                      vpc_configs: Optional[Sequence[ServerlessClusterVpcConfigArgs]] = None,
                      cluster_name: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewServerlessCluster(ctx *Context, name string, args ServerlessClusterArgs, opts ...ResourceOption) (*ServerlessCluster, error)
    public ServerlessCluster(string name, ServerlessClusterArgs args, CustomResourceOptions? opts = null)
    public ServerlessCluster(String name, ServerlessClusterArgs args)
public ServerlessCluster(String name, ServerlessClusterArgs args, CustomResourceOptions options)

    type: aws:msk:ServerlessCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServerlessClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var serverlessClusterResource = new Aws.Msk.ServerlessCluster("serverlessClusterResource", new()
{
    ClientAuthentication = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationArgs
    {
        Sasl = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationSaslArgs
        {
            Iam = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationSaslIamArgs
            {
                Enabled = false,
            },
        },
    },
    VpcConfigs = new[]
    {
        new Aws.Msk.Inputs.ServerlessClusterVpcConfigArgs
        {
            SubnetIds = new[]
            {
                "string",
            },
            SecurityGroupIds = new[]
            {
                "string",
            },
        },
    },
    ClusterName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := msk.NewServerlessCluster(ctx, "serverlessClusterResource", &msk.ServerlessClusterArgs{
	ClientAuthentication: &msk.ServerlessClusterClientAuthenticationArgs{
		Sasl: &msk.ServerlessClusterClientAuthenticationSaslArgs{
			Iam: &msk.ServerlessClusterClientAuthenticationSaslIamArgs{
				Enabled: pulumi.Bool(false),
			},
		},
	},
	VpcConfigs: msk.ServerlessClusterVpcConfigArray{
		&msk.ServerlessClusterVpcConfigArgs{
			SubnetIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			SecurityGroupIds: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	ClusterName: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var serverlessClusterResource = new ServerlessCluster("serverlessClusterResource", ServerlessClusterArgs.builder()
    .clientAuthentication(ServerlessClusterClientAuthenticationArgs.builder()
        .sasl(ServerlessClusterClientAuthenticationSaslArgs.builder()
            .iam(ServerlessClusterClientAuthenticationSaslIamArgs.builder()
                .enabled(false)
                .build())
            .build())
        .build())
    .vpcConfigs(ServerlessClusterVpcConfigArgs.builder()
        .subnetIds("string")
        .securityGroupIds("string")
        .build())
    .clusterName("string")
    .tags(Map.of("string", "string"))
    .build());

    serverless_cluster_resource = aws.msk.ServerlessCluster("serverlessClusterResource",
    client_authentication={
        "sasl": {
            "iam": {
                "enabled": False,
            },
        },
    },
    vpc_configs=[{
        "subnet_ids": ["string"],
        "security_group_ids": ["string"],
    }],
    cluster_name="string",
    tags={
        "string": "string",
    })

    const serverlessClusterResource = new aws.msk.ServerlessCluster("serverlessClusterResource", {
    clientAuthentication: {
        sasl: {
            iam: {
                enabled: false,
            },
        },
    },
    vpcConfigs: [{
        subnetIds: ["string"],
        securityGroupIds: ["string"],
    }],
    clusterName: "string",
    tags: {
        string: "string",
    },
});

    type: aws:msk:ServerlessCluster
properties:
    clientAuthentication:
        sasl:
            iam:
                enabled: false
    clusterName: string
    tags:
        string: string
    vpcConfigs:
        - securityGroupIds:
            - string
          subnetIds:
            - string

    ServerlessCluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The ServerlessCluster resource accepts the following input properties:

    ClientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    VpcConfigs List<ServerlessClusterVpcConfig>
    VPC configuration information. See below.
    ClusterName string
    The name of the serverless cluster.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    ClientAuthentication ServerlessClusterClientAuthenticationArgs
    Specifies client authentication information for the serverless cluster. See below.
    VpcConfigs []ServerlessClusterVpcConfigArgs
    VPC configuration information. See below.
    ClusterName string
    The name of the serverless cluster.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    vpcConfigs List<ServerlessClusterVpcConfig>
    VPC configuration information. See below.
    clusterName String
    The name of the serverless cluster.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    vpcConfigs ServerlessClusterVpcConfig[]
    VPC configuration information. See below.
    clusterName string
    The name of the serverless cluster.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    client_authentication ServerlessClusterClientAuthenticationArgs
    Specifies client authentication information for the serverless cluster. See below.
    vpc_configs Sequence[ServerlessClusterVpcConfigArgs]
    VPC configuration information. See below.
    cluster_name str
    The name of the serverless cluster.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    clientAuthentication Property Map
    Specifies client authentication information for the serverless cluster. See below.
    vpcConfigs List<Property Map>
    VPC configuration information. See below.
    clusterName String
    The name of the serverless cluster.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ServerlessCluster resource produces the following output properties:

    Arn string
    The ARN of the serverless cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    Arn string
    The ARN of the serverless cluster.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the serverless cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn string
    The ARN of the serverless cluster.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn str
    The ARN of the serverless cluster.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    arn String
    The ARN of the serverless cluster.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Look up Existing ServerlessCluster Resource

    Get an existing ServerlessCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ServerlessClusterState, opts?: CustomResourceOptions): ServerlessCluster
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        client_authentication: Optional[ServerlessClusterClientAuthenticationArgs] = None,
        cluster_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        vpc_configs: Optional[Sequence[ServerlessClusterVpcConfigArgs]] = None) -> ServerlessCluster
    func GetServerlessCluster(ctx *Context, name string, id IDInput, state *ServerlessClusterState, opts ...ResourceOption) (*ServerlessCluster, error)
    public static ServerlessCluster Get(string name, Input<string> id, ServerlessClusterState? state, CustomResourceOptions? opts = null)
    public static ServerlessCluster get(String name, Output<String> id, ServerlessClusterState state, CustomResourceOptions options)
    resources:  _:    type: aws:msk:ServerlessCluster    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string
    The ARN of the serverless cluster.
    ClientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    ClusterName string
    The name of the serverless cluster.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    VpcConfigs List<ServerlessClusterVpcConfig>
    VPC configuration information. See below.
    Arn string
    The ARN of the serverless cluster.
    ClientAuthentication ServerlessClusterClientAuthenticationArgs
    Specifies client authentication information for the serverless cluster. See below.
    ClusterName string
    The name of the serverless cluster.
    Tags map[string]string
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    VpcConfigs []ServerlessClusterVpcConfigArgs
    VPC configuration information. See below.
    arn String
    The ARN of the serverless cluster.
    clientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    clusterName String
    The name of the serverless cluster.
    tags Map<String,String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vpcConfigs List<ServerlessClusterVpcConfig>
    VPC configuration information. See below.
    arn string
    The ARN of the serverless cluster.
    clientAuthentication ServerlessClusterClientAuthentication
    Specifies client authentication information for the serverless cluster. See below.
    clusterName string
    The name of the serverless cluster.
    tags {[key: string]: string}
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vpcConfigs ServerlessClusterVpcConfig[]
    VPC configuration information. See below.
    arn str
    The ARN of the serverless cluster.
    client_authentication ServerlessClusterClientAuthenticationArgs
    Specifies client authentication information for the serverless cluster. See below.
    cluster_name str
    The name of the serverless cluster.
    tags Mapping[str, str]
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vpc_configs Sequence[ServerlessClusterVpcConfigArgs]
    VPC configuration information. See below.
    arn String
    The ARN of the serverless cluster.
    clientAuthentication Property Map
    Specifies client authentication information for the serverless cluster. See below.
    clusterName String
    The name of the serverless cluster.
    tags Map<String>
    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.
    vpcConfigs List<Property Map>
    VPC configuration information. See below.

    Supporting Types

    ServerlessClusterClientAuthentication, ServerlessClusterClientAuthenticationArgs

    Sasl ServerlessClusterClientAuthenticationSasl
    Details for client authentication using SASL. See below.
    Sasl ServerlessClusterClientAuthenticationSasl
    Details for client authentication using SASL. See below.
    sasl ServerlessClusterClientAuthenticationSasl
    Details for client authentication using SASL. See below.
    sasl ServerlessClusterClientAuthenticationSasl
    Details for client authentication using SASL. See below.
    sasl ServerlessClusterClientAuthenticationSasl
    Details for client authentication using SASL. See below.
    sasl Property Map
    Details for client authentication using SASL. See below.

    ServerlessClusterClientAuthenticationSasl, ServerlessClusterClientAuthenticationSaslArgs

    Iam ServerlessClusterClientAuthenticationSaslIam
    Details for client authentication using IAM. See below.
    Iam ServerlessClusterClientAuthenticationSaslIam
    Details for client authentication using IAM. See below.
    iam ServerlessClusterClientAuthenticationSaslIam
    Details for client authentication using IAM. See below.
    iam ServerlessClusterClientAuthenticationSaslIam
    Details for client authentication using IAM. See below.
    iam ServerlessClusterClientAuthenticationSaslIam
    Details for client authentication using IAM. See below.
    iam Property Map
    Details for client authentication using IAM. See below.

    ServerlessClusterClientAuthenticationSaslIam, ServerlessClusterClientAuthenticationSaslIamArgs

    Enabled bool
    Whether SASL/IAM authentication is enabled or not.
    Enabled bool
    Whether SASL/IAM authentication is enabled or not.
    enabled Boolean
    Whether SASL/IAM authentication is enabled or not.
    enabled boolean
    Whether SASL/IAM authentication is enabled or not.
    enabled bool
    Whether SASL/IAM authentication is enabled or not.
    enabled Boolean
    Whether SASL/IAM authentication is enabled or not.

    ServerlessClusterVpcConfig, ServerlessClusterVpcConfigArgs

    SubnetIds List<string>
    A list of subnets in at least two different Availability Zones that host your client applications.
    SecurityGroupIds List<string>
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.
    SubnetIds []string
    A list of subnets in at least two different Availability Zones that host your client applications.
    SecurityGroupIds []string
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.
    subnetIds List<String>
    A list of subnets in at least two different Availability Zones that host your client applications.
    securityGroupIds List<String>
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.
    subnetIds string[]
    A list of subnets in at least two different Availability Zones that host your client applications.
    securityGroupIds string[]
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.
    subnet_ids Sequence[str]
    A list of subnets in at least two different Availability Zones that host your client applications.
    security_group_ids Sequence[str]
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.
    subnetIds List<String>
    A list of subnets in at least two different Availability Zones that host your client applications.
    securityGroupIds List<String>
    Specifies up to five security groups that control inbound and outbound traffic for the serverless cluster.

    Import

    MSK serverless clusters can be imported using the cluster arn, e.g.,

     $ pulumi import aws:msk/serverlessCluster:ServerlessCluster example arn:aws:kafka:us-west-2:123456789012:cluster/example/279c0212-d057-4dba-9aa9-1c4e5a25bfc7-3

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    Viewing docs for AWS v5.43.0 (Older version)
    published on Tuesday, Mar 10, 2026 by Pulumi
    Go to latest version
    Schema (JSON)
    pulumi/pulumi-aws
      Try Pulumi Cloud free. Your team will thank you.