Skip to content

Commit 5142cba

Browse files
authored
docs(opensearchservice): fix broken markdown link (#29525)
### Reason for this change Links in the [opensearch doc](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice.CapacityConfig.html) are in invalid markdown. For example: ![image](https://github.com/aws/aws-cdk/assets/7490655/2879b0cf-a462-455c-bb24-24dea79052e6) ### Description of changes Removed a newline character between `[]` and `()`. ### Description of how you validated changes Preview in VSCode. ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent c7fcaf7 commit 5142cba

File tree

1 file changed

+8
-12
lines changed
  • packages/aws-cdk-lib/aws-opensearchservice/lib

1 file changed

+8
-12
lines changed

packages/aws-cdk-lib/aws-opensearchservice/lib/domain.ts

+8-12
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,7 @@ export interface CapacityConfig {
3232
/**
3333
* The hardware configuration of the computer that hosts the dedicated master
3434
* node, such as `m3.medium.search`. For valid values, see [Supported
35-
* Instance Types]
36-
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)
35+
* Instance Types](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/supported-instance-types.html)
3736
* in the Amazon OpenSearch Service Developer Guide.
3837
*
3938
* @default - r5.large.search
@@ -66,8 +65,8 @@ export interface CapacityConfig {
6665

6766
/**
6867
* The instance type for your UltraWarm node, such as `ultrawarm1.medium.search`.
69-
* For valid values, see [UltraWarm Storage Limits]
70-
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm)
68+
* For valid values, see [UltraWarm Storage
69+
* Limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#limits-ultrawarm)
7170
* in the Amazon OpenSearch Service Developer Guide.
7271
*
7372
* @default - ultrawarm1.medium.search
@@ -76,8 +75,8 @@ export interface CapacityConfig {
7675

7776
/**
7877
* Indicates whether Multi-AZ with Standby deployment option is enabled.
79-
* For more information, see [Multi-AZ with Standby]
80-
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby)
78+
* For more information, see [Multi-AZ with
79+
* Standby](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html#managedomains-za-standby)
8180
*
8281
* @default - no multi-az with standby
8382
*/
@@ -95,8 +94,7 @@ export interface ZoneAwarenessConfig {
9594
* in the same region to prevent data loss and minimize downtime in the event
9695
* of node or data center failure. Don't enable zone awareness if your cluster
9796
* has no replica index shards or is a single-node cluster. For more information,
98-
* see [Configuring a Multi-AZ Domain]
99-
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html)
97+
* see [Configuring a Multi-AZ Domain](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/managedomains-multiaz.html)
10098
* in the Amazon OpenSearch Service Developer Guide.
10199
*
102100
* @default - false
@@ -115,8 +113,7 @@ export interface ZoneAwarenessConfig {
115113
/**
116114
* The configurations of Amazon Elastic Block Store (Amazon EBS) volumes that
117115
* are attached to data nodes in the Amazon OpenSearch Service domain. For more information, see
118-
* [Amazon EBS]
119-
* (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html)
116+
* [Amazon EBS](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AmazonEBS.html)
120117
* in the Amazon Elastic Compute Cloud Developer Guide.
121118
*/
122119
export interface EbsOptions {
@@ -149,8 +146,7 @@ export interface EbsOptions {
149146
* The size (in GiB) of the EBS volume for each data node. The minimum and
150147
* maximum size of an EBS volume depends on the EBS volume type and the
151148
* instance type to which it is attached. For valid values, see
152-
* [EBS volume size limits]
153-
* (https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource)
149+
* [EBS volume size limits](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/limits.html#ebsresource)
154150
* in the Amazon OpenSearch Service Developer Guide.
155151
*
156152
* @default 10

0 commit comments

Comments
 (0)