community.aws.aws_msk_cluster – Manage Amazon MSK clusters.

Note

This plugin is part of the community.aws collection (version 2.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_msk_cluster.

New in version 2.0.0: of community.aws

Synopsis

  • Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.15.0

  • botocore >= 1.18.0

Parameters

Parameter Choices/Defaults Comments
authentication
dictionary
Includes all client authentication related information.
Effective only for new cluster and can not be updated.
sasl_scram
boolean
    Choices:
  • no ←
  • yes
SASL/SCRAM authentication is enabled or not.
tls_ca_arn
list / elements=string
List of ACM Certificate Authority ARNs.
aws_access_key
string
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_access_key, access_key
aws_ca_bundle
path
The location of a CA Bundle to use when validating SSL certificates.
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
aws_config
dictionary
A dictionary to modify the botocore configuration.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
aws_secret_key
string
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: ec2_secret_key, secret_key
configuration_arn
string
ARN of the configuration to use.
This parameter is required when state=present.
configuration_revision
integer
The revision of the configuration to use.
This parameter is required when state=present.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
ebs_volume_size
integer
Default:
100
The size in GiB of the EBS volume for the data drive on each broker node.
ec2_url
string
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.

aliases: aws_endpoint_url, endpoint_url
encryption
dictionary
Includes all encryption-related information.
Effective only for new cluster and can not be updated.
in_transit
dictionary
The details for encryption in transit.
client_broker
string
    Choices:
  • TLS ←
  • TLS_PLAINTEXT
  • PLAINTEXT
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only.
in_cluster
boolean
    Choices:
  • no
  • yes ←
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.
kms_key_id
string
The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
enhanced_monitoring
string
    Choices:
  • DEFAULT ←
  • PER_BROKER
  • PER_TOPIC_PER_BROKER
  • PER_TOPIC_PER_PARTITION
Specifies the level of monitoring for the MSK cluster.
instance_type
string
    Choices:
  • kafka.t3.small ←
  • kafka.m5.large
  • kafka.m5.xlarge
  • kafka.m5.2xlarge
  • kafka.m5.4xlarge
The type of Amazon EC2 instances to use for Kafka brokers.
Update operation requires botocore version >= 1.19.58.
logging
dictionary
Logging configuration.
cloudwatch
dictionary
Details of the CloudWatch Logs destination for broker logs.
enabled
boolean
    Choices:
  • no ←
  • yes
Specifies whether broker logs get sent to the specified CloudWatch Logs destination.
log_group
string
The CloudWatch log group that is the destination for broker logs.
firehose
dictionary
Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs.
delivery_stream
string
The Kinesis Data Firehose delivery stream that is the destination for broker logs.
enabled
boolean
    Choices:
  • no ←
  • yes
Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream.
s3
dictionary
Details of the Amazon S3 destination for broker logs.
bucket
string
The name of the S3 bucket that is the destination for broker logs.
enabled
boolean
    Choices:
  • no ←
  • yes
Specifies whether broker logs get sent to the specified Amazon S3 destination.
prefix
string
The S3 prefix that is the destination for broker logs.
name
string / required
The name of the cluster.
nodes
integer
Default:
3
The number of broker nodes in the cluster. Should be greater or equal to two.
open_monitoring
dictionary
The settings for open monitoring.
jmx_exporter
boolean
    Choices:
  • no ←
  • yes
Indicates whether you want to enable or disable the JMX Exporter.
node_exporter
boolean
    Choices:
  • no ←
  • yes
Indicates whether you want to enable or disable the Node Exporter.
profile
string
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.

aliases: aws_profile
purge_tags
boolean
    Choices:
  • no
  • yes ←
Remove tags not listed in tags when tags is specified.
region
string
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region

aliases: aws_region, ec2_region
security_groups
list / elements=string
The AWS security groups to associate with the elastic network interfaces in order to specify who can connect to and communicate with the Amazon MSK cluster. If you don't specify a security group, Amazon MSK uses the default security group associated with the VPC.
security_token
string
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.

aliases: aws_security_token, access_token
state
string
    Choices:
  • present ←
  • absent
Create (present) or delete (absent) cluster.
subnets
list / elements=string
The list of subnets to connect to in the client virtual private cloud (VPC). AWS creates elastic network interfaces inside these subnets. Client applications use elastic network interfaces to produce and consume data.
Client subnets can't be in Availability Zone us-east-1e.
This parameter is required when state=present.
tags
dictionary
Tag dictionary to apply to the cluster.
validate_certs
boolean
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
version
string
The version of Apache Kafka.
This version should exist in given configuration.
This parameter is required when state=present.
Update operation requires botocore version >= 1.16.19.
wait
boolean
    Choices:
  • no ←
  • yes
Whether to wait for the cluster to be available or deleted.
wait_timeout
integer
Default:
3600
How many seconds to wait. Cluster creation can take up to 20-30 minutes.

Notes

Note

  • All operations are time consuming, for example create takes 20-30 minutes, update kafka version – more than one hour, update configuration – 10-15 minutes;

  • Cluster’s brokers get evenly distributed over a number of availability zones that’s equal to the number of subnets.

  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE

  • When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

  • Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.

  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- aws_msk_cluster:
    name: kafka-cluster
    state: present
    version: 2.6.1
    nodes: 6
    ebs_volume_size: "{{ aws_msk_options.ebs_volume_size }}"
    subnets:
      - subnet-e3b48ce7c25861eeb
      - subnet-2990c8b25b07ddd43
      - subnet-d9fbeaf46c54bfab6
    wait: true
    wait_timeout: 1800
    configuration_arn: arn:aws:kafka:us-east-1:000000000001:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1
    configuration_revision: 1

- aws_msk_cluster:
    name: kafka-cluster
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
bootstrap_broker_string
complex
state=present and cluster state is ACTIVE
A list of brokers that a client application can use to bootstrap.

 
plain
string
success
A string containing one or more hostname:port pairs.

 
tls
string
success
A string containing one or more DNS names (or IP) and TLS port pairs.

cluster_info
dictionary
state=present
Description of the MSK cluster.

response
dictionary
always
The response from actual API call.



Authors

  • Daniil Kupchenko (@oukooveu)