Skip to content

Commit c37a4f7

Browse files
committed
docs: update README using terraform-docs
1 parent fa3a9ec commit c37a4f7

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ You can configure centrally security by using IAM policies for access control, a
1515

1616
When creating a Service Network in the module, the following attributes are expected:
1717

18-
- `name` = (Optional|string) Name of the Service Network. If `create_service_network` is `true`, this value is required. **This attribute and `identifier` cannot be set at the same time.**
18+
- `name` = (Optional|string) Name of the Service Network. This attribute creates a **new** service network using the specified name. **This attribute and `identifier` cannot be set at the same time.**
1919
- `auth_type` = (Optional|string) Type of IAM policy to apply in the service network. Allowed values are `NONE` (default) `AWS_IAM`.
2020
- `auth_policy` = (Optional|any) Auth policy. The policy string in JSON must not contain newlines or blank lines. The auth policy resource will be created only if `auth_type` is set to `AWS_IAM`.
21-
- `identifier` = (Optional|string) The ID or ARN of an existing service network. If you are working in multi-AWS account environments, ARN is compulsory. **This attribute and `name` cannot be set at the same time.**
21+
- `identifier` = (Optional|string) The ID or ARN of an **existing** service network. If you are working in multi-AWS account environments, ARN is compulsory. **This attribute and `name` cannot be set at the same time.**
2222

23-
Example of creating a service network with `auth_type` equals to `NONE`:
23+
Example of creating a **new** service network with `auth_type` equals to `NONE`:
2424

2525
```hcl
2626
service_network = {
@@ -29,7 +29,7 @@ service_network = {
2929
}
3030
```
3131

32-
Example of creating a service network with `auth_type` equals to `AWS_IAM`:
32+
Example of creating a **new** service network with `auth_type` equals to `AWS_IAM`:
3333

3434
```hcl
3535
service_network = {
@@ -54,7 +54,7 @@ service_network = {
5454
}
5555
```
5656

57-
Example of referencing an existing service network into the module:
57+
Example of referencing an **existing** service network into the module:
5858

5959
```hcl
6060
service_network = {
@@ -340,7 +340,7 @@ services = {
340340

341341
| Name | Description | Type | Default | Required |
342342
|------|-------------|------|---------|:--------:|
343-
| <a name="input_service_network"></a> [service\_network](#input\_service\_network) | Amazon VPC Lattice Service Network information. You can either create a new Service Network or reference a current one (to associate Services or VPCs). The attribute `create_service_network` defines if you want to create or not a service network (`false` by default).<br>More information about the format of this variable can be found in the "Usage - Service Network" section of the README. | `any` | `{}` | no |
343+
| <a name="input_service_network"></a> [service\_network](#input\_service\_network) | Amazon VPC Lattice Service Network information. You can either create a new Service Network or reference a current one (to associate Services or VPCs). Setting the `name` attribute will create a **new** service network, while using the attribute `identifier` will reference an **existing** service network.<br>More information about the format of this variable can be found in the "Usage - Service Network" section of the README. | `any` | `{}` | no |
344344
| <a name="input_services"></a> [services](#input\_services) | Definition of the VPC Lattice Services to create. You can use this module to either create only Lattice services (not associated with any service network), or associated with a service network (if you create one or provide an identifier). You can define 1 or more Service using this module.<br>More information about the format of this variable can be found in the "Usage - Services" section of the README. | `any` | `{}` | no |
345345
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to apply to all the resources created in this module. | `map(string)` | `{}` | no |
346346
| <a name="input_target_groups"></a> [target\_groups](#input\_target\_groups) | Definitions of the Target Groups to create. You can define 1 or more Target Groups using this module.<br>More information about the format of this variable can be found in the "Usage - Target Groups" section of the README. | `any` | `{}` | no |

0 commit comments

Comments
 (0)