Configuration

Manages an Amazon Managed Streaming for Kafka configuration. More information can be found on the MSK Developer Guide.

NOTE: The API does not support deleting MSK configurations. Removing this resource will only remove the this provider state for it.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Msk.Configuration("example", new Aws.Msk.ConfigurationArgs
        {
            KafkaVersions = 
            {
                "2.1.0",
            },
            ServerProperties = @"auto.create.topics.enable = true
delete.topic.enable = true

",
        });
    }

}

package main

import (
    "fmt"

    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/msk"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := msk.NewConfiguration(ctx, "example", &msk.ConfigurationArgs{
            KafkaVersions: pulumi.StringArray{
                pulumi.String("2.1.0"),
            },
            ServerProperties: pulumi.String(fmt.Sprintf("%v%v%v", "auto.create.topics.enable = true\n", "delete.topic.enable = true\n", "\n")),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.msk.Configuration("example",
    kafka_versions=["2.1.0"],
    server_properties="""auto.create.topics.enable = true
delete.topic.enable = true

""")

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

const example = new aws.msk.Configuration("example", {
    kafkaVersions: ["2.1.0"],
    serverProperties: `auto.create.topics.enable = true
delete.topic.enable = true
`,
});

Create a Configuration Resource

new Configuration(name: string, args: ConfigurationArgs, opts?: CustomResourceOptions);

def Configuration(resource_name, opts=None, description=None, kafka_versions=None, name=None, server_properties=None, __props__=None);

func NewConfiguration(ctx *Context, name string, args ConfigurationArgs, opts ...ResourceOption) (*Configuration, error)

public Configuration(string name, ConfigurationArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Configuration Resource Properties

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

Inputs

The Configuration resource accepts the following input properties:

KafkaVersions List<string>: List of Apache Kafka versions which can use this configuration.
ServerProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
Description string: Description of the configuration.
Name string: Name of the configuration.

KafkaVersions []string: List of Apache Kafka versions which can use this configuration.
ServerProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
Description string: Description of the configuration.
Name string: Name of the configuration.

kafkaVersions string[]: List of Apache Kafka versions which can use this configuration.
serverProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
description string: Description of the configuration.
name string: Name of the configuration.

kafka_versions List[str]: List of Apache Kafka versions which can use this configuration.
server_properties str: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
description str: Description of the configuration.
name str: Name of the configuration.

Outputs

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

Arn string: Amazon Resource Name (ARN) of the configuration.
Id string: The provider-assigned unique ID for this managed resource.
LatestRevision int: Latest revision of the configuration.

Arn string: Amazon Resource Name (ARN) of the configuration.
Id string: The provider-assigned unique ID for this managed resource.
LatestRevision int: Latest revision of the configuration.

arn string: Amazon Resource Name (ARN) of the configuration.
id string: The provider-assigned unique ID for this managed resource.
latestRevision number: Latest revision of the configuration.

arn str: Amazon Resource Name (ARN) of the configuration.
id str: The provider-assigned unique ID for this managed resource.
latest_revision float: Latest revision of the configuration.

Look up an Existing Configuration Resource

Get an existing Configuration 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?: ConfigurationState, opts?: CustomResourceOptions): Configuration

static get(resource_name, id, opts=None, arn=None, description=None, kafka_versions=None, latest_revision=None, name=None, server_properties=None, __props__=None);

func GetConfiguration(ctx *Context, name string, id IDInput, state *ConfigurationState, opts ...ResourceOption) (*Configuration, error)

public static Configuration Get(string name, Input<string> id, ConfigurationState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

Arn string: Amazon Resource Name (ARN) of the configuration.
Description string: Description of the configuration.
KafkaVersions List<string>: List of Apache Kafka versions which can use this configuration.
LatestRevision int: Latest revision of the configuration.
Name string: Name of the configuration.
ServerProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

Arn string: Amazon Resource Name (ARN) of the configuration.
Description string: Description of the configuration.
KafkaVersions []string: List of Apache Kafka versions which can use this configuration.
LatestRevision int: Latest revision of the configuration.
Name string: Name of the configuration.
ServerProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

arn string: Amazon Resource Name (ARN) of the configuration.
description string: Description of the configuration.
kafkaVersions string[]: List of Apache Kafka versions which can use this configuration.
latestRevision number: Latest revision of the configuration.
name string: Name of the configuration.
serverProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

arn str: Amazon Resource Name (ARN) of the configuration.
description str: Description of the configuration.
kafka_versions List[str]: List of Apache Kafka versions which can use this configuration.
latest_revision float: Latest revision of the configuration.
name str: Name of the configuration.
server_properties str: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud