Skip to content

Commit 4d6e065

Browse files
committed
docs: fix formatting and incorrect indentation
1 parent f671912 commit 4d6e065

File tree

2 files changed

+12
-14
lines changed

2 files changed

+12
-14
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -450,11 +450,10 @@ For details please see the [attributes docs].
450450
- [**`domain`**](#var-domain): *(Optional `string`)*<a name="var-domain"></a>
451451

452452
The domain name that should be used. Can be set to a FQDN or prefix.
453-
If no FQDN and `certificate_arn` are set, the domain prefix will be used for
454-
the sign-up and sign-in pages that are hosted by Amazon Cognito,
455-
e.g. `https://{YOUR_PREFIX}.auth.eu-west-1.amazoncognito.com`.
456-
The prefix must be unique across the selected AWS Region.
457-
Domain names can only contain lower-case letters, numbers, and hyphens.
453+
If no FQDN and `certificate_arn` are set, the domain prefix will be used for the sign-up and sign-in pages that are hosted by Amazon Cognito,
454+
e.g. `https://{YOUR_PREFIX}.auth.eu-west-1.amazoncognito.com`.
455+
The prefix must be unique across the selected AWS Region.
456+
Domain names can only contain lower-case letters, numbers, and hyphens.
458457

459458
- [**`certificate_arn`**](#var-certificate_arn): *(Optional `string`)*<a name="var-certificate_arn"></a>
460459

@@ -769,10 +768,10 @@ This value will be overridden if you have entered a value in 'default_client_tok
769768
The following attributes are exported by the module:
770769

771770
- **`user_pool`**: The `cognito_user_pool` object.
772-
-**`domain`**: The full `aws_cognito_user_pool` object.
771+
- **`domain`**: The full `aws_cognito_user_pool` object.
773772
- **`clients`**: A map of `cognito_user_pool_client` objects. The map is keyed by the `name` of the created clients. Client secrets are filtered out of this map and are available through the `client_secrets` output variable and flagged as sensitive.
774773
- **`client_secrets`**: A sensitive map of client secrets for all created `cognito_user_pool_client` resources. The map is keyed by the `name` of the created clients.
775-
-**module_enabled**: Whether the module is enabled.
774+
- **module_enabled**: Whether the module is enabled.
776775

777776
## External Documentation
778777

README.tfdoc.hcl

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -585,11 +585,10 @@ section {
585585
type = string
586586
description = <<-END
587587
The domain name that should be used. Can be set to a FQDN or prefix.
588-
If no FQDN and `certificate_arn` are set, the domain prefix will be used for
589-
the sign-up and sign-in pages that are hosted by Amazon Cognito,
590-
e.g. `https://{YOUR_PREFIX}.auth.eu-west-1.amazoncognito.com`.
591-
The prefix must be unique across the selected AWS Region.
592-
Domain names can only contain lower-case letters, numbers, and hyphens.
588+
If no FQDN and `certificate_arn` are set, the domain prefix will be used for the sign-up and sign-in pages that are hosted by Amazon Cognito,
589+
e.g. `https://{YOUR_PREFIX}.auth.eu-west-1.amazoncognito.com`.
590+
The prefix must be unique across the selected AWS Region.
591+
Domain names can only contain lower-case letters, numbers, and hyphens.
593592
END
594593
}
595594

@@ -1064,10 +1063,10 @@ section {
10641063
The following attributes are exported by the module:
10651064
10661065
- **`user_pool`**: The `cognito_user_pool` object.
1067-
-**`domain`**: The full `aws_cognito_user_pool` object.
1066+
- **`domain`**: The full `aws_cognito_user_pool` object.
10681067
- **`clients`**: A map of `cognito_user_pool_client` objects. The map is keyed by the `name` of the created clients. Client secrets are filtered out of this map and are available through the `client_secrets` output variable and flagged as sensitive.
10691068
- **`client_secrets`**: A sensitive map of client secrets for all created `cognito_user_pool_client` resources. The map is keyed by the `name` of the created clients.
1070-
-**module_enabled**: Whether the module is enabled.
1069+
- **module_enabled**: Whether the module is enabled.
10711070
END
10721071
}
10731072

0 commit comments

Comments
 (0)