community / community.aws / 3.4.0 / module / aws_msk_cluster Manage Amazon MSK clusters. | "added in version" 2.0.0 of community.aws" Authors: Daniil Kupchenko (@oukooveu)community.aws.aws_msk_cluster (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters.
# 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
name: description: The name of the cluster. required: true type: str tags: description: Tag dictionary to apply to the cluster. type: dict wait: default: false description: Whether to wait for the cluster to be available or deleted. type: bool nodes: default: 3 description: The number of broker nodes in the cluster. Should be greater or equal to two. type: int state: choices: - present - absent default: present description: Create (C(present)) or delete (C(absent)) cluster. type: str region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str logging: description: Logging configuration. suboptions: cloudwatch: description: Details of the CloudWatch Logs destination for broker logs. suboptions: enabled: default: false description: Specifies whether broker logs get sent to the specified CloudWatch Logs destination. type: bool log_group: description: The CloudWatch log group that is the destination for broker logs. required: false type: str type: dict firehose: description: Details of the Kinesis Data Firehose delivery stream that is the destination for broker logs. suboptions: delivery_stream: description: The Kinesis Data Firehose delivery stream that is the destination for broker logs. required: false type: str enabled: default: false description: Specifies whether broker logs get send to the specified Kinesis Data Firehose delivery stream. type: bool type: dict s3: description: Details of the Amazon S3 destination for broker logs. suboptions: bucket: description: The name of the S3 bucket that is the destination for broker logs. required: false type: str enabled: default: false description: Specifies whether broker logs get sent to the specified Amazon S3 destination. type: bool prefix: description: The S3 prefix that is the destination for broker logs. required: false type: str type: dict type: dict profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str subnets: description: - 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 I(state=present). elements: str type: list version: description: - The version of Apache Kafka. - This version should exist in given configuration. - This parameter is required when I(state=present). - Update operation requires botocore version >= 1.16.19. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict encryption: description: - Includes all encryption-related information. - Effective only for new cluster and can not be updated. suboptions: in_transit: description: The details for encryption in transit. suboptions: client_broker: choices: - TLS - TLS_PLAINTEXT - PLAINTEXT default: TLS description: - 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. type: str in_cluster: default: true description: - 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. type: bool type: dict kms_key_id: default: null description: - 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. type: str type: dict purge_tags: default: true description: Remove tags not listed in I(tags) when tags is specified. type: bool wait_timeout: default: 3600 description: How many seconds to wait. Cluster creation can take up to 20-30 minutes. type: int aws_ca_bundle: description: - 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.' type: path instance_type: choices: - kafka.t3.small - kafka.m5.large - kafka.m5.xlarge - kafka.m5.2xlarge - kafka.m5.4xlarge default: kafka.t3.small description: - The type of Amazon EC2 instances to use for Kafka brokers. - Update operation requires botocore version >= 1.19.58. type: str authentication: description: - Includes all client authentication related information. - Effective only for new cluster and can not be updated. suboptions: sasl_scram: default: false description: SASL/SCRAM authentication is enabled or not. type: bool tls_ca_arn: description: List of ACM Certificate Authority ARNs. elements: str type: list type: dict aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool ebs_volume_size: default: 100 description: The size in GiB of the EBS volume for the data drive on each broker node. type: int open_monitoring: description: The settings for open monitoring. suboptions: jmx_exporter: default: false description: Indicates whether you want to enable or disable the JMX Exporter. type: bool node_exporter: default: false description: Indicates whether you want to enable or disable the Node Exporter. type: bool type: dict security_groups: description: - 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. elements: str type: list configuration_arn: description: - ARN of the configuration to use. - This parameter is required when I(state=present). type: str enhanced_monitoring: choices: - DEFAULT - PER_BROKER - PER_TOPIC_PER_BROKER - PER_TOPIC_PER_PARTITION default: DEFAULT description: Specifies the level of monitoring for the MSK cluster. type: str configuration_revision: description: - The revision of the configuration to use. - This parameter is required when I(state=present). type: int debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
bootstrap_broker_string: contains: plain: description: A string containing one or more hostname:port pairs. type: str tls: description: A string containing one or more DNS names (or IP) and TLS port pairs. type: str description: A list of brokers that a client application can use to bootstrap. returned: I(state=present) and cluster state is I(ACTIVE) type: complex cluster_info: description: Description of the MSK cluster. returned: I(state=present) type: dict response: description: The response from actual API call. returned: always sample: {} type: dict