AWS Classic v5.41.0, May 15 23

aws.msk.Configuration

Explore with Pulumi AI

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

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Msk.Configuration("example", new()
    {
        KafkaVersions = new[]
        {
            "2.1.0",
        },
        ServerProperties = @"auto.create.topics.enable = true
delete.topic.enable = true

",
    });

});

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/msk"
	"github.com/pulumi/pulumi/sdk/v3/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("auto.create.topics.enable = true\ndelete.topic.enable = true\n\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.msk.Configuration;
import com.pulumi.aws.msk.ConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
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 Configuration("example", ConfigurationArgs.builder()        
            .kafkaVersions("2.1.0")
            .serverProperties("""
auto.create.topics.enable = true
delete.topic.enable = true

            """)
            .build());

    }
}

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

`,
});

resources:
  example:
    type: aws:msk:Configuration
    properties:
      kafkaVersions:
        - 2.1.0
      serverProperties: |+
        auto.create.topics.enable = true
        delete.topic.enable = true

Create Configuration Resource

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

@overload
def Configuration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  kafka_versions: Optional[Sequence[str]] = None,
                  name: Optional[str] = None,
                  server_properties: Optional[str] = None)
@overload
def Configuration(resource_name: str,
                  args: ConfigurationArgs,
                  opts: Optional[ResourceOptions] = None)

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

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

public Configuration(String name, ConfigurationArgs args)
public Configuration(String name, ConfigurationArgs args, CustomResourceOptions options)

type: aws:msk:Configuration
properties: # The arguments to resource properties.
options: # 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.

resource_name str: The unique name of the resource.
args ConfigurationArgs: 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 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.

name String: The unique name of the resource.
args ConfigurationArgs: The arguments to resource properties.
options 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 Architecture and Concepts docs.

Inputs

The Configuration resource accepts the following input properties:

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

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

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

serverProperties string: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
description string: Description of the configuration.
kafkaVersions string[]: List of Apache Kafka versions which can use this configuration.
name string: Name of the 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.
kafka_versions Sequence[str]: List of Apache Kafka versions which can use this configuration.
name str: Name of the configuration.

serverProperties String: Contents of the server.properties file. Supported properties are documented in the MSK Developer Guide.
description String: Description of the configuration.
kafkaVersions List<String>: List of Apache Kafka versions which can use this configuration.
name String: 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 Integer: 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 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.

Look up 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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        kafka_versions: Optional[Sequence[str]] = None,
        latest_revision: Optional[int] = None,
        name: Optional[str] = None,
        server_properties: Optional[str] = None) -> Configuration

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)

public static Configuration get(String name, Output<String> id, ConfigurationState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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: 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 List<String>: List of Apache Kafka versions which can use this configuration.
latestRevision Integer: 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 Sequence[str]: List of Apache Kafka versions which can use this configuration.
latest_revision int: 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.

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 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.

Import

MSK configurations can be imported using the configuration ARN, e.g.,

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

Package Details

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