Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. msk
  5. Configuration

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.msk.Configuration

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::MSK::Configuration

    Create Configuration Resource

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

    Constructor syntax

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

@overload
def Configuration(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  server_properties: Optional[str] = None,
                  description: Optional[str] = None,
                  kafka_versions_list: Optional[Sequence[str]] = None,
                  latest_revision: Optional[ConfigurationLatestRevisionArgs] = None,
                  name: Optional[str] = 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-native:msk:Configuration
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 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

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

    The Configuration resource accepts the following input properties:

    ServerProperties string
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    Description string
    The description of the configuration.
    KafkaVersionsList List<string>

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    LatestRevision Pulumi.AwsNative.Msk.Inputs.ConfigurationLatestRevision
    Latest revision of the MSK configuration.
    Name string
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
    ServerProperties string
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    Description string
    The description of the configuration.
    KafkaVersionsList []string

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    LatestRevision ConfigurationLatestRevisionArgs
    Latest revision of the MSK configuration.
    Name string
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
    serverProperties String
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    description String
    The description of the configuration.
    kafkaVersionsList List<String>

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    latestRevision ConfigurationLatestRevision
    Latest revision of the MSK configuration.
    name String
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
    serverProperties string
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    description string
    The description of the configuration.
    kafkaVersionsList string[]

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    latestRevision ConfigurationLatestRevision
    Latest revision of the MSK configuration.
    name string
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
    server_properties str
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    description str
    The description of the configuration.
    kafka_versions_list Sequence[str]

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    latest_revision ConfigurationLatestRevisionArgs
    Latest revision of the MSK configuration.
    name str
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".
    serverProperties String
    Contents of the server.properties file. When using this property, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the AWS CLI , the contents of server.properties can be in plaintext.
    description String
    The description of the configuration.
    kafkaVersionsList List<String>

    The versions of Apache Kafka with which you can use this MSK configuration.

    When you update the KafkaVersionsList property, AWS CloudFormation recreates a new configuration with the updated property before deleting the old configuration. Such an update requires a resource replacement . To successfully update KafkaVersionsList , you must also update the Name property in the same operation.

    If your configuration is attached with any clusters created using the AWS Management Console or AWS CLI , you'll need to manually delete the old configuration from the console after the update completes.

    For more information, see Can’t update KafkaVersionsList in MSK configuration in the Amazon MSK Developer Guide .

    latestRevision Property Map
    Latest revision of the MSK configuration.
    name String
    The name of the configuration. Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the configuration.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ConfigurationLatestRevision, ConfigurationLatestRevisionArgs

    CreationTime string
    The time when the configuration revision was created.
    Description string
    The description of the configuration revision.
    Revision int
    The revision number.
    CreationTime string
    The time when the configuration revision was created.
    Description string
    The description of the configuration revision.
    Revision int
    The revision number.
    creationTime String
    The time when the configuration revision was created.
    description String
    The description of the configuration revision.
    revision Integer
    The revision number.
    creationTime string
    The time when the configuration revision was created.
    description string
    The description of the configuration revision.
    revision number
    The revision number.
    creation_time str
    The time when the configuration revision was created.
    description str
    The description of the configuration revision.
    revision int
    The revision number.
    creationTime String
    The time when the configuration revision was created.
    description String
    The description of the configuration revision.
    revision Number
    The revision number.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
    pulumi/pulumi-aws-native