Skip to content

Commit

Permalink
docs: update copy related to null-label variables
Browse files Browse the repository at this point in the history
  • Loading branch information
sgtoj committed Aug 13, 2023
1 parent 3e89f78 commit b1fb300
Showing 1 changed file with 5 additions and 13 deletions.
18 changes: 5 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,13 @@ module "cognito_custom_sms_sender" {
}
```

## Requirements

- Terraform 0.13.0 or later
- AWS provider 5.0.0 or later
- Docker installed and running on the machine where Terraform is executed

## Inputs

In addition to the variables documented below, this module includes several
other optional variables (e.g., `name`, `tags`, etc.) provided by the
`cloudposse/label/null` module. Please refer to its [documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest)
for more details on these variables.

| Name | Description | Type | Default | Required |
|-----------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------:|:---------:|:--------:|
| `kms_key_alias_prefix` | The prefix for the KMS key alias. It must start with 'alias' and only include alphanumeric characters, dashes, underscores, colons or slashes, but doesn't end with a slash. | `string` | `"alias"` | no |
Expand All @@ -49,13 +48,6 @@ module "cognito_custom_sms_sender" {
| `aws_account_id` | The AWS account ID that the module will be deployed in. | `string` | `""` | no |
| `aws_region_name` | The AWS region name where the module will be deployed. | `string` | `""` | no |

### Note

This module uses the `cloudposse/label/null` module for naming and tagging
resources. As such, it also includes a `context.tf` file with additional
optional variables you can set. Refer to the [`cloudposse/label` documentation](https://registry.terraform.io/modules/cloudposse/label/null/latest)
for more details on these variables.

## Outputs

| Name | Description |
Expand Down

0 comments on commit b1fb300

Please sign in to comment.