community / community.aws / 5.1.0 / module / msk_cluster Manage Amazon MSK clusters | "added in version" 2.0.0 of community.aws" Authors: Daniil Kupchenko (@oukooveu)community.aws.msk_cluster (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Create, delete and modify Amazon MSK (Managed Streaming for Apache Kafka) clusters.
Prior to release 5.0.0 this module was called C(community.aws.aws_msk_cluster). The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details. - community.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:123456789012:configuration/kafka-cluster-configuration/aaaaaaaa-bbbb-4444-3333-ccccccccc-1 configuration_revision: 1
- community.aws.msk_cluster: name: kafka-cluster state: absent
name: description: The name of the cluster. required: true type: str tags: aliases: - resource_tags description: - A dictionary representing the tags to be applied to the resource. - If the I(tags) parameter is not set then tags will not be modified. required: false 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. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. 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: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. 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). type: str access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). 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: - If I(purge_tags=true) and I(tags) is set, existing tags will be purged from the resource to match exactly what is defined by I(tags) parameter. - If the I(tags) parameter is not set then tags will not be modified, even if I(purge_tags=True). - Tag keys beginning with C(aws:) are reserved by Amazon and can not be modified. As such they will be ignored for the purposes of the I(purge_tags) parameter. See the Amazon documentation for more information U(https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html#tag-conventions). required: false type: bool secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str 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. - The C(AWS_CA_BUNDLE) environment variable may also be used. 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. type: str session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. 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 validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. 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: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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