ServerlessCluster class

Manages an Amazon MSK Serverless cluster.

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.msk.ServerlessCluster("example", {
    clientAuthentication: {
        sasl: {
            iam: {
                enabled: true,
            },
        },
    },
    vpcConfigs: [{
        subnetIds: exampleAwsSubnet.map(__item => __item.id),
        securityGroupIds: [exampleAwsSecurityGroup.id],
    }],
    clusterName: "Example",
});
import pulumi
import pulumi_aws as aws

example = aws.msk.ServerlessCluster("example",
    client_authentication={
        "sasl": {
            "iam": {
                "enabled": True,
            },
        },
    },
    vpc_configs=[{
        "subnet_ids": [__item["id"] for __item in example_aws_subnet],
        "security_group_ids": [example_aws_security_group["id"]],
    }],
    cluster_name="Example")
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var example = new Aws.Msk.ServerlessCluster("example", new()
    {
        ClientAuthentication = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationArgs
        {
            Sasl = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationSaslArgs
            {
                Iam = new Aws.Msk.Inputs.ServerlessClusterClientAuthenticationSaslIamArgs
                {
                    Enabled = true,
                },
            },
        },
        VpcConfigs = new[]
        {
            new Aws.Msk.Inputs.ServerlessClusterVpcConfigArgs
            {
                SubnetIds = exampleAwsSubnet.Select(__item => __item.Id).ToList(),
                SecurityGroupIds = new[]
                {
                    exampleAwsSecurityGroup.Id,
                },
            },
        },
        ClusterName = "Example",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := msk.NewServerlessCluster(ctx, "example", &msk.ServerlessClusterArgs{
ClientAuthentication: &msk.ServerlessClusterClientAuthenticationArgs{
Sasl: &msk.ServerlessClusterClientAuthenticationSaslArgs{
Iam: &msk.ServerlessClusterClientAuthenticationSaslIamArgs{
Enabled: pulumi.Bool(true),
},
},
},
VpcConfigs: msk.ServerlessClusterVpcConfigArray{
&msk.ServerlessClusterVpcConfigArgs{
SubnetIds: pulumi.StringArray(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:9,24-46)),
SecurityGroupIds: pulumi.StringArray{
exampleAwsSecurityGroup.Id,
},
},
},
ClusterName: pulumi.String("Example"),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_msk_serverlesscluster" "example" {
  client_authentication = {
    sasl = {
      iam = {
        enabled = true
      }
    }
  }
  vpc_configs {
    subnet_ids         = exampleAwsSubnet[*].id
    security_group_ids = [exampleAwsSecurityGroup.id]
  }
  cluster_name = "Example"
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.ServerlessCluster;
import com.pulumi.aws.msk.ServerlessClusterArgs;
import com.pulumi.aws.msk.inputs.ServerlessClusterClientAuthenticationArgs;
import com.pulumi.aws.msk.inputs.ServerlessClusterClientAuthenticationSaslArgs;
import com.pulumi.aws.msk.inputs.ServerlessClusterClientAuthenticationSaslIamArgs;
import com.pulumi.aws.msk.inputs.ServerlessClusterVpcConfigArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ServerlessCluster("example", ServerlessClusterArgs.builder()
            .clientAuthentication(ServerlessClusterClientAuthenticationArgs.builder()
                .sasl(ServerlessClusterClientAuthenticationSaslArgs.builder()
                    .iam(ServerlessClusterClientAuthenticationSaslIamArgs.builder()
                        .enabled(true)
                        .build())
                    .build())
                .build())
            .vpcConfigs(ServerlessClusterVpcConfigArgs.builder()
                .subnetIds(exampleAwsSubnet.stream().map(element -> element.id()).collect(toList()))
                .securityGroupIds(exampleAwsSecurityGroup.id())
                .build())
            .clusterName("Example")
            .build());

    }
}

Import

Identity Schema

Required

  • arn (String) ARN of the MSK serverless cluster.

Using pulumi import, import MSK serverless cluster using the cluster ARN. For example:

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

Constructors

ServerlessCluster(String name, {ServerlessClusterArgs? args, CustomResourceOptions? options})
Creates a new ServerlessCluster. name The Pulumi resource name. args Arguments used to configure this ServerlessCluster. The set of arguments for ServerlessCluster. options Resource options controlling this resource's behavior.
ServerlessCluster.reference(String urn)
Creates a typed reference to an existing ServerlessCluster resource.

Properties

arn ↔ Output<String>
The ARN of the serverless cluster.
latefinal
bootstrapBrokersSaslIam ↔ Output<String>
One or more DNS names (or IP addresses) and SASL IAM port pairs. For example, boot-abcdefg.c2.kafka-serverless.eu-central-1.amazonaws.com:9098. The resource sorts the list alphabetically. AWS may not always return all endpoints so the values may not be stable across applies.
latefinal
childResources → Set<Resource>
finalinherited
clientAuthentication ↔ Output<ServerlessClusterClientAuthentication>
Specifies client authentication information for the serverless cluster. See below.
latefinal
clusterName ↔ Output<String>
The name of the serverless cluster.
latefinal
clusterUuid ↔ Output<String>
UUID of the serverless cluster, for use in IAM policies.
latefinal
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited
vpcConfigs ↔ Output<List<ServerlessClusterVpcConfig>>
VPC configuration information. See below.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ServerlessClusterState? state, CustomResourceOptions? options}) → ServerlessCluster
Gets an existing ServerlessCluster resource's state with the given name and id.