-
Notifications
You must be signed in to change notification settings - Fork 162
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
57d5f25
commit 1f09fcf
Showing
10 changed files
with
1,424 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,221 @@ | ||
| --- | ||
| subcategory: "Distributed Message Service (DMS)" | ||
| --- | ||
|
|
||
| # huaweicloud\_dms\_kafka\_instance | ||
|
|
||
| ## Example Usage | ||
|
|
||
| ### Basic Instance | ||
|
|
||
| ```hcl | ||
| data "huaweicloud_dms_az" "test" {} | ||
| data "huaweicloud_vpc" "test" { | ||
| name = "vpc-default" | ||
| } | ||
| data "huaweicloud_vpc_subnet" "test" { | ||
| name = "subnet-default" | ||
| } | ||
| data "huaweicloud_dms_product" "test" { | ||
| engine = "kafka" | ||
| instance_type = "cluster" | ||
| version = "2.3.0" | ||
| } | ||
| resource "huaweicloud_networking_secgroup" "test" { | ||
| name = "secgroup_1" | ||
| description = "secgroup for kafka" | ||
| } | ||
| resource "huaweicloud_dms_kafka_instance" "test" { | ||
| name = "instance_1" | ||
| description = "kafka test" | ||
| access_user = "user" | ||
| password = "Kafkatest@123" | ||
| vpc_id = data.huaweicloud_vpc.test.id | ||
| subnet_id = data.huaweicloud_vpc_subnet.test.id | ||
| security_group_id = huaweicloud_networking_secgroup.test.id | ||
| available_zones = [data.huaweicloud_dms_az.test.id] | ||
| product_id = data.huaweicloud_dms_product.test.id | ||
| engine_version = data.huaweicloud_dms_product.test.version | ||
| specification = data.huaweicloud_dms_product.test.bandwidth | ||
| partition_num = data.huaweicloud_dms_product.test.partition_num | ||
| storage_space = data.huaweicloud_dms_product.test.storage | ||
| storage_spec_code = data.huaweicloud_dms_product.test.storage_spec_code | ||
| kafka_manager_user = "kafka-user" | ||
| kafka_manager_password = "Kafkatest@123" | ||
| tags = { | ||
| key = "value" | ||
| owner = "terraform" | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ## Argument Reference | ||
|
|
||
| The following arguments are supported: | ||
|
|
||
| * `region` - (Optional, String, ForceNew) The region in which to create the DMS kafka instance resource. | ||
| If omitted, the provider-level region will be used. Changing this creates a new instance resource. | ||
|
|
||
| * `name` - (Required, String) Specifies the name of the DMS kafka instance. An instance name starts with a letter, | ||
| consists of 4 to 64 characters, and supports only letters, digits, hyphens (-) and underscores (_). | ||
|
|
||
| * `description` - (Optional, String) Specifies the description of the DMS kafka instance. It is a character | ||
| string containing not more than 1024 characters. | ||
|
|
||
| * `engine_version` - (Required, String, ForceNew) Specifies the version of the kafka engine. | ||
| Valid values are "1.1.0" and "2.3.0". | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `specification` - (Required, String, ForceNew) Specifies the baseline bandwidth of the DMS kafka instance, | ||
| that is, the maximum amount of data transferred per unit time. Unit: byte/s. Options: 100MB, 300MB, 600MB, 1200MB. | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `storage_space` - (Required, Int, ForceNew) Specifies the message storage space. Value range: | ||
| - When specification is 100MB: 600–90000 GB | ||
| - When specification is 300MB: 1200–90000 GB | ||
| - When specification is 600MB: 2400–90000 GB | ||
| - When specification is 1200MB: 4800–90000 GB | ||
|
|
||
| Changing this creates a new instance resource. | ||
|
|
||
| * `storage_spec_code` - (Required, String, ForceNew) Specifies the storage I/O specification. Value range: | ||
| - When specification is 100MB: dms.physical.storage.high or dms.physical.storage.ultra | ||
| - When specification is 300MB: dms.physical.storage.high or dms.physical.storage.ultra | ||
| - When specification is 600MB: dms.physical.storage.ultra | ||
| - When specification is 1200MB: dms.physical.storage.ultra | ||
|
|
||
| Changing this creates a new instance resource. | ||
|
|
||
| * `partition_num` - (Required, Int, ForceNew) Specifies the maximum number of topics in the DMS kafka instance. | ||
| - When specification is 100MB: 300 | ||
| - When specification is 300MB: 900 | ||
| - When specification is 600MB: 1800 | ||
| - When specification is 1200MB: 1800 | ||
|
|
||
| Changing this creates a new instance resource. | ||
|
|
||
| * `access_user` - (Optional, String, ForceNew) Specifies a username. | ||
| A username consists of 4 to 64 characters and supports only letters, digits, and hyphens (-). | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `password` - (Optional, String, ForceNew) Specifies the password of the DMS kafka instance. A password | ||
| must meet the following complexity requirements: Must be 8 to 32 characters long. | ||
| Must contain at least 2 of the following character types: lowercase letters, uppercase | ||
| letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `vpc_id` - (Required, String, ForceNew) Specifies the ID of a VPC. Changing this creates a new instance resource. | ||
|
|
||
| * `subnet_id` - (Required, String, ForceNew) Specifies the ID of a subnet. | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `security_group_id` - (Required, String) Specifies the ID of a security group. | ||
|
|
||
| * `available_zones` - (Required, List, ForceNew) Specifies the ID of an AZ. The parameter value can not be | ||
| left blank or an empty array. Changing this creates a new instance resource. | ||
|
|
||
| * `product_id` - (Required, String, ForceNew) Specifies a product ID. Changing this creates a new instance resource. | ||
|
|
||
| * `kafka_manager_user` - (Required, String, ForceNew) Specifies the username for logging in to the Kafka Manager. | ||
| The username consists of 4 to 64 characters and can contain letters, digits, hyphens (-), and underscores (_). | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `kafka_manager_password` - (Required, String, ForceNew) Specifies the password for logging in to the Kafka Manager. | ||
| The password must meet the following complexity requirements: Must be 8 to 32 characters long. | ||
| Must contain at least 2 of the following character types: lowercase letters, uppercase | ||
| letters, digits, and special characters (`~!@#$%^&*()-_=+\|[{}]:'",<.>/?). | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `maintain_begin` - (Optional, String) Specifies the time at which a maintenance time window starts. | ||
| Format: HH:mm:ss. | ||
| The start time and end time of a maintenance time window must indicate the time segment of | ||
| a supported maintenance time window. The start time must be set to 22:00, 02:00, 06:00, 10:00, | ||
| 14:00, or 18:00. Parameters `maintain_begin` and `maintain_end` must be set in pairs. If | ||
| parameter `maintain_begin` is left blank, parameter `maintain_end` is also blank. In this case, | ||
| the system automatically allocates the default start time 02:00. | ||
|
|
||
| * `maintain_end` - (Optional, String) Specifies the time at which a maintenance time window ends. | ||
| Format: HH:mm:ss. | ||
| The start time and end time of a maintenance time window must indicate the time segment of | ||
| a supported maintenance time window. The end time is four hours later than the start time. | ||
| For example, if the start time is 22:00, the end time is 02:00. Parameters `maintain_begin` | ||
| and `maintain_end` must be set in pairs. If parameter `maintain_end` is left blank, parameter | ||
| `maintain_begin` is also blank. In this case, the system automatically allocates the default | ||
| end time 06:00. | ||
|
|
||
| * `public_ip_ids` - (Optional, List, ForceNew) Specifies the IDs of the elastic IP address (EIP) | ||
| bound to the DMS kafka instance. The num of IDs needed ranges: | ||
| - When specification is 100MB: 3 | ||
| - When specification is 300MB: 3 | ||
| - When specification is 600MB: 4 | ||
| - When specification is 1200MB: 8 | ||
|
|
||
| Changing this creates a new instance resource. | ||
|
|
||
| * `retention_policy` - (Optional, String) Specifies the action to be taken when the memory usage reaches | ||
| the disk capacity threshold. Value range: | ||
| - `time_base`: Automatically delete the earliest messages. | ||
| - `produce_reject`: Stop producing new messages. | ||
|
|
||
| * `connector_enable` - (Optional, Bool, ForceNew) Specifies whether to enable dumping. | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `enable_auto_topic` - (Optional, Bool, ForceNew) Specifies whether to enable automatic topic creation. Value range: | ||
| - `true`: enable | ||
| - `false`: disable | ||
|
|
||
| If automatic topic creation is enabled, a topic will be automatically created with 3 partitions and 3 replicas | ||
| when a message is produced to or consumed from a topic that does not exist. | ||
| Changing this creates a new instance resource. | ||
|
|
||
| * `enterprise_project_id` - (Optional, String) Specifies the enterprise project ID of the kafka instance. | ||
|
|
||
| * `tags` - (Optional, Map) The key/value pairs to associate with the DMS kafka instance. | ||
|
|
||
| ## Attributes Reference | ||
|
|
||
| In addition to all arguments above, the following attributes are exported: | ||
|
|
||
| * `id` - Specifies a resource ID in UUID format. | ||
| * `engine` - Indicates the message engine. | ||
| * `used_storage_space` - Indicates the used message storage space. Unit: GB | ||
| * `connect_address` - Indicates the IP address of the DMS kafka instance. | ||
| * `port` - Indicates the port number of the DMS kafka instance. | ||
| * `status` - Indicates the status of the DMS kafka instance. | ||
| * `ssl_enable` - Indicates whether the SSL-encrypted access is enabled. | ||
| * `enable_publicip` - Indicates whether public access to the DMS kafka instance is enabled. | ||
| * `resource_spec_code` - Indicates a resource specifications identifier. | ||
| * `type` - Indicates the DMS kafka instance type. | ||
| * `user_id` - Indicates a user ID. | ||
| * `user_name` - Indicates a username. | ||
| * `manegement_connect_address` - Indicates the connection address of the Kafka Manager of a Kafka instance. | ||
|
|
||
| ## Import | ||
|
|
||
| DMS kafka instance can be imported using the instance id, e.g. | ||
| ``` | ||
| $ terraform import huaweicloud_dms_kafka_instance.instance_1 8d3c7938-dc47-4937-a30f-c80de381c5e3 | ||
| ``` | ||
| Note that the imported state may not be identical to your resource definition, due to some attrubutes missing from | ||
| the API response, security or some other reason. The missing attributes include: | ||
| `password`, `kafka_manager_password` and `public_ip_ids`. | ||
| It is generally recommended running `terraform plan` after importing a DMS kafka instance. You can then decide if | ||
| changes should be applied to the instance, or the resource definition should be updated to align with the instance. | ||
| Also you can ignore changes as below. | ||
| ``` | ||
| resource "huaweicloud_dms_kafka_instance" "instance_1" { | ||
| ... | ||
| lifecycle { | ||
| ignore_changes = [ | ||
| password, kafka_manager_password, | ||
| ] | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.