create-configuration¶

Description¶

Creates a new MSK configuration.

Synopsis¶

  create-configuration
[--description <value>]
[--kafka-versions <value>]
--name <value>
--server-properties <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--description (string)

The description of the configuration.

--kafka-versions (list)

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

(string)

Syntax:

"string" "string" ...

--name (string)

The name of the configuration.

--server-properties (blob)

Contents of the server.propertiesfile. When using the API, you must ensure that the contents of the file are base64 encoded. When using the AWS Management Console, the SDK, or the AWS CLI, the contents of server.propertiescan be in plaintext.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To create a custom Amazon MSK configuration

The following create-configuration example creates a custom MSK configuration with the server properties that are specified in the input file.

aws kafka create-configuration \
    --name "CustomConfiguration" \
    --description "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms." \
    --kafka-versions "2.2.1" \
    --server-properties fileb://configuration.txt

Contents of configuration.txt:

auto.create.topics.enable = true
zookeeper.connection.timeout.ms = 2000
log.roll.ms = 604800000

This command produces no output. Output:

{
    "Arn": "arn:aws:kafka:us-west-2:123456789012:configuration/CustomConfiguration/a1b2c3d4-5678-90ab-cdef-11111EXAMPLE-2",
    "CreationTime": "2019-10-09T15:26:05.548Z",
    "LatestRevision":
        {
            "CreationTime": "2019-10-09T15:26:05.548Z",
            "Description": "Topic autocreation enabled; Apache ZooKeeper timeout 2000 ms; Log rolling 604800000 ms.",
            "Revision": 1
        },
    "Name": "CustomConfiguration"
}

For more information, see Amazon MSK Configuration Operations in the Amazon Managed Streaming for Apache Kafka Developer Guide.

Output¶

Arn -> (string)

The Amazon Resource Name (ARN) of the configuration.

CreationTime -> (timestamp)

The time when the configuration was created.

LatestRevision -> (structure)

Latest revision of the configuration.

CreationTime -> (timestamp)

The time when the configuration revision was created.

Description -> (string)

The description of the configuration revision.

Revision -> (long)

The revision number.

Name -> (string)

The name of the configuration.

State -> (string)

The state of the configuration. The possible states are ACTIVE, DELETING, and DELETE_FAILED.

Table of Contents

Feedback

User Guide