Skip to content

Commit 260f37c

Browse files
abbas-khan10abbas-khan10
committed
update descriptions
1 parent 1e01a48 commit 260f37c

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

‎infrastructure/README.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -363,25 +363,25 @@
363363

364364
| Name | Description | Type | Default | Required |
365365
|------|-------------|------|---------|:--------:|
366-
| <a name="input_auth_session_dynamodb_table_name"></a> [auth\_session\_dynamodb\_table\_name](#input\_auth\_session\_dynamodb\_table\_name) | The name of dynamodb table to store user login sessions | `string` | `"AuthSessionReferenceMetadata"` | no |
367-
| <a name="input_auth_state_dynamodb_table_name"></a> [auth\_state\_dynamodb\_table\_name](#input\_auth\_state\_dynamodb\_table\_name) | The name of dynamodb table to store the state values (for CIS2 authorisation) | `string` | `"AuthStateReferenceMetadata"` | no |
366+
| <a name="input_auth_session_dynamodb_table_name"></a> [auth\_session\_dynamodb\_table\_name](#input\_auth\_session\_dynamodb\_table\_name) | The name of the dynamodb table to store user login sessions | `string` | `"AuthSessionReferenceMetadata"` | no |
367+
| <a name="input_auth_state_dynamodb_table_name"></a> [auth\_state\_dynamodb\_table\_name](#input\_auth\_state\_dynamodb\_table\_name) | The name of the dynamodb table to store the state values (for CIS2 authorisation) | `string` | `"AuthStateReferenceMetadata"` | no |
368368
| <a name="input_availability_zones"></a> [availability\_zones](#input\_availability\_zones) | This is a list that specifies all the Availability Zones that will have a pair of public and private subnets | `list(string)` | <pre>[<br/> "eu-west-2a",<br/> "eu-west-2b",<br/> "eu-west-2c"<br/>]</pre> | no |
369-
| <a name="input_bulk_upload_report_dynamodb_table_name"></a> [bulk\_upload\_report\_dynamodb\_table\_name](#input\_bulk\_upload\_report\_dynamodb\_table\_name) | The name of dynamodb table to store bulk upload status | `string` | `"BulkUploadReport"` | no |
369+
| <a name="input_bulk_upload_report_dynamodb_table_name"></a> [bulk\_upload\_report\_dynamodb\_table\_name](#input\_bulk\_upload\_report\_dynamodb\_table\_name) | The name of the dynamodb table to store bulk upload status | `string` | `"BulkUploadReport"` | no |
370370
| <a name="input_certificate_domain"></a> [certificate\_domain](#input\_certificate\_domain) | n/a | `string` | n/a | yes |
371371
| <a name="input_certificate_subdomain_name_prefix"></a> [certificate\_subdomain\_name\_prefix](#input\_certificate\_subdomain\_name\_prefix) | Prefix to add to subdomains on certification configurations, dev envs use api-{env}, prod envs use api.{env} | `string` | `"api-"` | no |
372372
| <a name="input_cloud_only_service_instances"></a> [cloud\_only\_service\_instances](#input\_cloud\_only\_service\_instances) | n/a | `number` | `1` | no |
373-
| <a name="input_cloudfront_edge_table_name"></a> [cloudfront\_edge\_table\_name](#input\_cloudfront\_edge\_table\_name) | The name of dynamodb table to store the presigned url reference of CloudFront requests | `string` | `"CloudFrontEdgeReference"` | no |
373+
| <a name="input_cloudfront_edge_table_name"></a> [cloudfront\_edge\_table\_name](#input\_cloudfront\_edge\_table\_name) | The name of the dynamodb table to store the presigned url reference of CloudFront requests | `string` | `"CloudFrontEdgeReference"` | no |
374374
| <a name="input_cloudwatch_alarm_evaluation_periods"></a> [cloudwatch\_alarm\_evaluation\_periods](#input\_cloudwatch\_alarm\_evaluation\_periods) | n/a | `any` | n/a | yes |
375375
| <a name="input_disable_message_header_validation"></a> [disable\_message\_header\_validation](#input\_disable\_message\_header\_validation) | if true then relaxes the restrictions on MESH message headers | `string` | `"true"` | no |
376-
| <a name="input_docstore_bucket_name"></a> [docstore\_bucket\_name](#input\_docstore\_bucket\_name) | The name of S3 bucket to store ARF documents | `string` | `"ndr-document-store"` | no |
377-
| <a name="input_docstore_dynamodb_table_name"></a> [docstore\_dynamodb\_table\_name](#input\_docstore\_dynamodb\_table\_name) | The name of dynamodb table to store the metadata of ARF documents | `string` | `"DocumentReferenceMetadata"` | no |
376+
| <a name="input_docstore_bucket_name"></a> [docstore\_bucket\_name](#input\_docstore\_bucket\_name) | The name of the S3 bucket to store ARF documents | `string` | `"ndr-document-store"` | no |
377+
| <a name="input_docstore_dynamodb_table_name"></a> [docstore\_dynamodb\_table\_name](#input\_docstore\_dynamodb\_table\_name) | The name of the dynamodb table to store the metadata of ARF documents | `string` | `"DocumentReferenceMetadata"` | no |
378378
| <a name="input_domain"></a> [domain](#input\_domain) | n/a | `string` | n/a | yes |
379379
| <a name="input_enable_dns_hostnames"></a> [enable\_dns\_hostnames](#input\_enable\_dns\_hostnames) | Enable DNS hostnames for VPC | `bool` | `true` | no |
380380
| <a name="input_enable_dns_support"></a> [enable\_dns\_support](#input\_enable\_dns\_support) | Enable DNS support for VPC | `bool` | `true` | no |
381381
| <a name="input_enable_private_routes"></a> [enable\_private\_routes](#input\_enable\_private\_routes) | Controls whether the internet gateway can connect to private subnets | `bool` | `false` | no |
382382
| <a name="input_environment"></a> [environment](#input\_environment) | Tag Variables | `string` | n/a | yes |
383-
| <a name="input_lloyd_george_bucket_name"></a> [lloyd\_george\_bucket\_name](#input\_lloyd\_george\_bucket\_name) | The name of S3 bucket to store Lloyd George documents | `string` | `"lloyd-george-store"` | no |
384-
| <a name="input_lloyd_george_dynamodb_table_name"></a> [lloyd\_george\_dynamodb\_table\_name](#input\_lloyd\_george\_dynamodb\_table\_name) | The name of dynamodb table to store the metadata of Lloyd George documents | `string` | `"LloydGeorgeReferenceMetadata"` | no |
383+
| <a name="input_lloyd_george_bucket_name"></a> [lloyd\_george\_bucket\_name](#input\_lloyd\_george\_bucket\_name) | The name of the S3 bucket to store Lloyd George documents | `string` | `"lloyd-george-store"` | no |
384+
| <a name="input_lloyd_george_dynamodb_table_name"></a> [lloyd\_george\_dynamodb\_table\_name](#input\_lloyd\_george\_dynamodb\_table\_name) | The name of the dynamodb table to store the metadata of Lloyd George documents | `string` | `"LloydGeorgeReferenceMetadata"` | no |
385385
| <a name="input_log_level"></a> [log\_level](#input\_log\_level) | n/a | `string` | `"debug"` | no |
386386
| <a name="input_mesh_ca_cert_ssm_param_name"></a> [mesh\_ca\_cert\_ssm\_param\_name](#input\_mesh\_ca\_cert\_ssm\_param\_name) | Name of SSM parameter containing MESH CA certificate | `string` | n/a | yes |
387387
| <a name="input_mesh_client_cert_ssm_param_name"></a> [mesh\_client\_cert\_ssm\_param\_name](#input\_mesh\_client\_cert\_ssm\_param\_name) | Name of SSM parameter containing MESH client certificate | `string` | n/a | yes |
@@ -401,10 +401,10 @@
401401
| <a name="input_staging_store_bucket_name"></a> [staging\_store\_bucket\_name](#input\_staging\_store\_bucket\_name) | n/a | `string` | `"staging-bulk-store"` | no |
402402
| <a name="input_standalone_vpc_ig_tag"></a> [standalone\_vpc\_ig\_tag](#input\_standalone\_vpc\_ig\_tag) | This is the tag assigned to the standalone vpc internet gateway that should be created manaully before the first run of the infrastructure | `string` | n/a | yes |
403403
| <a name="input_standalone_vpc_tag"></a> [standalone\_vpc\_tag](#input\_standalone\_vpc\_tag) | This is the tag assigned to the standalone vpc that should be created manaully before the first run of the infrastructure | `string` | n/a | yes |
404-
| <a name="input_statistical_reports_bucket_name"></a> [statistical\_reports\_bucket\_name](#input\_statistical\_reports\_bucket\_name) | The name of S3 bucket to store weekly generated statistical reports | `string` | `"statistical-reports"` | no |
405-
| <a name="input_statistics_dynamodb_table_name"></a> [statistics\_dynamodb\_table\_name](#input\_statistics\_dynamodb\_table\_name) | The name of dynamodb table to store application statistics | `string` | `"ApplicationStatistics"` | no |
404+
| <a name="input_statistical_reports_bucket_name"></a> [statistical\_reports\_bucket\_name](#input\_statistical\_reports\_bucket\_name) | The name of the S3 bucket to store weekly generated statistical reports | `string` | `"statistical-reports"` | no |
405+
| <a name="input_statistics_dynamodb_table_name"></a> [statistics\_dynamodb\_table\_name](#input\_statistics\_dynamodb\_table\_name) | The name of the dynamodb table to store application statistics | `string` | `"ApplicationStatistics"` | no |
406406
| <a name="input_stitch_metadata_dynamodb_table_name"></a> [stitch\_metadata\_dynamodb\_table\_name](#input\_stitch\_metadata\_dynamodb\_table\_name) | n/a | `string` | `"LloydGeorgeStitchJobMetadata"` | no |
407-
| <a name="input_unstitched_lloyd_george_dynamodb_table_name"></a> [unstitched\_lloyd\_george\_dynamodb\_table\_name](#input\_unstitched\_lloyd\_george\_dynamodb\_table\_name) | The name of dynamodb table to store the metadata of un-stitched Lloyd George documents | `string` | `"UnstitchedLloydGeorgeReferenceMetadata"` | no |
407+
| <a name="input_unstitched_lloyd_george_dynamodb_table_name"></a> [unstitched\_lloyd\_george\_dynamodb\_table\_name](#input\_unstitched\_lloyd\_george\_dynamodb\_table\_name) | The name of the dynamodb table to store the metadata of un-stitched Lloyd George documents | `string` | `"UnstitchedLloydGeorgeReferenceMetadata"` | no |
408408
| <a name="input_zip_store_bucket_name"></a> [zip\_store\_bucket\_name](#input\_zip\_store\_bucket\_name) | n/a | `string` | `"zip-request-store"` | no |
409409
| <a name="input_zip_store_dynamodb_table_name"></a> [zip\_store\_dynamodb\_table\_name](#input\_zip\_store\_dynamodb\_table\_name) | n/a | `string` | `"ZipStoreReferenceMetadata"` | no |
410410

‎infrastructure/variable.tf‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ variable "certificate_subdomain_name_prefix" {
2121
# Bucket Variables
2222
variable "docstore_bucket_name" {
2323
type = string
24-
description = "The name of S3 bucket to store ARF documents"
24+
description = "The name of the S3 bucket to store ARF documents"
2525
default = "ndr-document-store"
2626
}
2727

@@ -37,38 +37,38 @@ variable "staging_store_bucket_name" {
3737

3838
variable "lloyd_george_bucket_name" {
3939
type = string
40-
description = "The name of S3 bucket to store Lloyd George documents"
40+
description = "The name of the S3 bucket to store Lloyd George documents"
4141
default = "lloyd-george-store"
4242
}
4343

4444
variable "statistical_reports_bucket_name" {
4545
type = string
46-
description = "The name of S3 bucket to store weekly generated statistical reports"
46+
description = "The name of the S3 bucket to store weekly generated statistical reports"
4747
default = "statistical-reports"
4848
}
4949

5050
# DynamoDB Table Variables
5151
variable "docstore_dynamodb_table_name" {
5252
type = string
53-
description = "The name of dynamodb table to store the metadata of ARF documents"
53+
description = "The name of the dynamodb table to store the metadata of ARF documents"
5454
default = "DocumentReferenceMetadata"
5555
}
5656

5757
variable "lloyd_george_dynamodb_table_name" {
5858
type = string
59-
description = "The name of dynamodb table to store the metadata of Lloyd George documents"
59+
description = "The name of the dynamodb table to store the metadata of Lloyd George documents"
6060
default = "LloydGeorgeReferenceMetadata"
6161
}
6262

6363
variable "unstitched_lloyd_george_dynamodb_table_name" {
6464
type = string
65-
description = "The name of dynamodb table to store the metadata of un-stitched Lloyd George documents"
65+
description = "The name of the dynamodb table to store the metadata of un-stitched Lloyd George documents"
6666
default = "UnstitchedLloydGeorgeReferenceMetadata"
6767
}
6868

6969
variable "cloudfront_edge_table_name" {
7070
type = string
71-
description = "The name of dynamodb table to store the presigned url reference of CloudFront requests"
71+
description = "The name of the dynamodb table to store the presigned url reference of CloudFront requests"
7272
default = "CloudFrontEdgeReference"
7373
}
7474

@@ -84,25 +84,25 @@ variable "stitch_metadata_dynamodb_table_name" {
8484

8585
variable "auth_state_dynamodb_table_name" {
8686
type = string
87-
description = "The name of dynamodb table to store the state values (for CIS2 authorisation)"
87+
description = "The name of the dynamodb table to store the state values (for CIS2 authorisation)"
8888
default = "AuthStateReferenceMetadata"
8989
}
9090

9191
variable "auth_session_dynamodb_table_name" {
9292
type = string
93-
description = "The name of dynamodb table to store user login sessions"
93+
description = "The name of the dynamodb table to store user login sessions"
9494
default = "AuthSessionReferenceMetadata"
9595
}
9696

9797
variable "bulk_upload_report_dynamodb_table_name" {
9898
type = string
99-
description = "The name of dynamodb table to store bulk upload status"
99+
description = "The name of the dynamodb table to store bulk upload status"
100100
default = "BulkUploadReport"
101101
}
102102

103103
variable "statistics_dynamodb_table_name" {
104104
type = string
105-
description = "The name of dynamodb table to store application statistics"
105+
description = "The name of the dynamodb table to store application statistics"
106106
default = "ApplicationStatistics"
107107
}
108108

0 commit comments

Comments
 (0)