Add toggle to tfdoc to remove type hints (#3842)
* Add toggle to tfdoc to remove type hints * Update all readmes * Fix python formatting
This commit is contained in:
Julio Castillo
@@ -346,34 +346,34 @@ module "alloydb" {
|
||||
| [cluster_name](variables.tf#L84) | Name of the primary cluster. | <code>string</code> | ✓ | |
|
||||
| [instance_name](variables.tf#L211) | Name of primary instance. | <code>string</code> | ✓ | |
|
||||
| [location](variables.tf#L223) | Region or zone of the cluster and instance. | <code>string</code> | ✓ | |
|
||||
| [network_config](variables.tf#L268) | Network configuration for cluster and instance. Only one between psa_config and psc_config can be used. | <code title="object({ psa_config = optional(object({ network = string allocated_ip_range = optional(string) authorized_external_networks = optional(list(string), []) enable_public_ip = optional(bool, false) enable_outbound_public_ip = optional(bool, false) })) psc_config = optional(object({ allowed_consumer_projects = list(string) })) })">object({…})</code> | ✓ | |
|
||||
| [network_config](variables.tf#L268) | Network configuration for cluster and instance. Only one between psa_config and psc_config can be used. | <code>object({…})</code> | ✓ | |
|
||||
| [project_id](variables.tf#L303) | The ID of the project where this instances will be created. | <code>string</code> | ✓ | |
|
||||
| [annotations](variables.tf#L17) | Map FLAG_NAME=>VALUE for annotations which allow client tools to store small amount of arbitrary data. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [automated_backup_configuration](variables.tf#L23) | Automated backup settings for cluster. | <code title="object({ enabled = optional(bool, false) backup_window = optional(string, "1800s") location = optional(string) weekly_schedule = optional(object({ days_of_week = optional(list(string), [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]) start_times = optional(list(object({ hours = number })), [{ hours = 23 }]) }), {}) retention_count = optional(number, 7) retention_period = optional(string) })">object({…})</code> | | <code>{}</code> |
|
||||
| [automated_backup_configuration](variables.tf#L23) | Automated backup settings for cluster. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [availability_type](variables.tf#L61) | Availability type for the primary replica. Either `ZONAL` or `REGIONAL`. | <code>string</code> | | <code>"REGIONAL"</code> |
|
||||
| [client_connection_config](variables.tf#L67) | Client connection config. | <code title="object({ require_connectors = optional(bool, false) ssl_config = optional(object({ ssl_mode = string })) })">object({…})</code> | | <code>null</code> |
|
||||
| [client_connection_config](variables.tf#L67) | Client connection config. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [cluster_display_name](variables.tf#L78) | Display name of the primary cluster. | <code>string</code> | | <code>null</code> |
|
||||
| [continuous_backup_configuration](variables.tf#L90) | Continuous backup settings for cluster. | <code title="object({ enabled = optional(bool, true) recovery_window_days = optional(number, 14) })">object({…})</code> | | <code>{}</code> |
|
||||
| [cross_region_replication](variables.tf#L100) | Cross region replication config. | <code title="object({ enabled = optional(bool, false) promote_secondary = optional(bool, false) switchover_mode = optional(bool, false) region = optional(string) secondary_cluster_display_name = optional(string) secondary_cluster_name = optional(string) secondary_instance_display_name = optional(string) secondary_instance_name = optional(string) secondary_machine_config = optional(object({ cpu_count = number machine_type = optional(string) })) read_pool = optional(map(object({ display_name = optional(string) node_count = optional(number, 1) flags = optional(map(string)) client_connection_config = optional(object({ require_connectors = optional(bool, false) ssl_config = optional(object({ ssl_mode = string })) })) machine_config = optional(object({ cpu_count = optional(number, 2) machine_type = optional(string) }), {}) network_config = optional(object({ authorized_external_networks = optional(list(string), []) enable_public_ip = optional(bool, false) }), {}) query_insights_config = optional(object({ query_string_length = optional(number, 1024) record_application_tags = optional(bool, true) record_client_address = optional(bool, true) query_plans_per_minute = optional(number, 5) })) })), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [continuous_backup_configuration](variables.tf#L90) | Continuous backup settings for cluster. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [cross_region_replication](variables.tf#L100) | Cross region replication config. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [database_version](variables.tf#L157) | Database type and version to create. | <code>string</code> | | <code>"POSTGRES_15"</code> |
|
||||
| [deletion_policy](variables.tf#L163) | AlloyDB cluster and instance deletion policy. | <code>string</code> | | <code>null</code> |
|
||||
| [deletion_protection](variables.tf#L169) | Whether Terraform will be prevented from destroying the cluster. When the field is set to true or unset in Terraform state, a terraform apply or terraform destroy that would delete the cluster will fail. When the field is set to false, deleting the cluster is allowed. | <code>bool</code> | | <code>null</code> |
|
||||
| [display_name](variables.tf#L175) | AlloyDB instance display name. | <code>string</code> | | <code>null</code> |
|
||||
| [encryption_config](variables.tf#L181) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | <code title="object({ primary_kms_key_name = string secondary_kms_key_name = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [encryption_config](variables.tf#L181) | Set encryption configuration. KMS name format: 'projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]'. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [flags](variables.tf#L190) | Map FLAG_NAME=>VALUE for database-specific tuning. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [gce_zone](variables.tf#L196) | The GCE zone that the instance should serve from. This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. | <code>string</code> | | <code>null</code> |
|
||||
| [initial_user](variables.tf#L202) | AlloyDB cluster initial user credentials. | <code title="object({ user = optional(string, "postgres") password = optional(string) })">object({…})</code> | | <code>null</code> |
|
||||
| [initial_user](variables.tf#L202) | AlloyDB cluster initial user credentials. | <code>object({…})</code> | | <code>null</code> |
|
||||
| [labels](variables.tf#L217) | Labels to be attached to all instances. | <code>map(string)</code> | | <code>null</code> |
|
||||
| [machine_config](variables.tf#L229) | AlloyDB machine config. | <code title="object({ cpu_count = optional(number, 2) machine_type = optional(string) })">object({…})</code> | | <code>{}</code> |
|
||||
| [maintenance_config](variables.tf#L243) | Set maintenance window configuration. | <code title="object({ enabled = optional(bool, false) day = optional(string, "SUNDAY") start_time = optional(object({ hours = optional(number, 23) }), {}) })">object({…})</code> | | <code>{}</code> |
|
||||
| [machine_config](variables.tf#L229) | AlloyDB machine config. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [maintenance_config](variables.tf#L243) | Set maintenance window configuration. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [prefix](variables.tf#L293) | Optional prefix used to generate instance names. | <code>string</code> | | <code>null</code> |
|
||||
| [project_number](variables.tf#L308) | The project number of the project where this instances will be created. Only used for testing purposes. | <code>string</code> | | <code>null</code> |
|
||||
| [query_insights_config](variables.tf#L314) | Query insights config. | <code title="object({ query_string_length = optional(number, 1024) record_application_tags = optional(bool, true) record_client_address = optional(bool, true) query_plans_per_minute = optional(number, 5) })">object({…})</code> | | <code>{}</code> |
|
||||
| [read_pool](variables.tf#L325) | Map of read pool instances to create in the primary cluster. | <code title="map(object({ display_name = optional(string) node_count = optional(number, 1) flags = optional(map(string)) client_connection_config = optional(object({ require_connectors = optional(bool, false) ssl_config = optional(object({ ssl_mode = string })) })) machine_config = optional(object({ cpu_count = optional(number, 2) machine_type = optional(string) }), {}) network_config = optional(object({ authorized_external_networks = optional(list(string), []) enable_public_ip = optional(bool, false) }), {}) query_insights_config = optional(object({ query_string_length = optional(number, 1024) record_application_tags = optional(bool, true) record_client_address = optional(bool, true) query_plans_per_minute = optional(number, 5) })) }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [query_insights_config](variables.tf#L314) | Query insights config. | <code>object({…})</code> | | <code>{}</code> |
|
||||
| [read_pool](variables.tf#L325) | Map of read pool instances to create in the primary cluster. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
| [skip_await_major_version_upgrade](variables.tf#L370) | Set to true to skip awaiting on the major version upgrade of the cluster. | <code>bool</code> | | <code>true</code> |
|
||||
| [subscription_type](variables.tf#L376) | The subscription type of cluster. Possible values are: 'STANDARD' or 'TRIAL'. | <code>string</code> | | <code>"STANDARD"</code> |
|
||||
| [tag_bindings](variables.tf#L382) | Tag bindings for this service, in key => tag value id format. | <code>map(string)</code> | | <code>{}</code> |
|
||||
| [users](variables.tf#L389) | Map of users to create in the primary instance (and replicated to other replicas). Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'ALLOYDB_BUILT_IN' or 'ALLOYDB_IAM_USER'. | <code title="map(object({ password = optional(string) roles = optional(list(string), ["alloydbsuperuser"]) type = optional(string, "ALLOYDB_BUILT_IN") }))">map(object({…}))</code> | | <code>{}</code> |
|
||||
| [users](variables.tf#L389) | Map of users to create in the primary instance (and replicated to other replicas). Set PASSWORD to null if you want to get an autogenerated password. The user types available are: 'ALLOYDB_BUILT_IN' or 'ALLOYDB_IAM_USER'. | <code>map(object({…}))</code> | | <code>{}</code> |
|
||||
|
||||
## Outputs
|
||||
|
||||
|
||||
Reference in New Issue
Block a user