Clean up documentation related to a non-optional parameter having a d…

…efault value.
awslabs · Dec 23, 2022 · 0e5a01d · 0e5a01d
1 parent b8067fc
commit 0e5a01d
Show file tree

Hide file tree

Showing 15 changed files with 4 additions and 32 deletions.
diff --git a/source/patterns/@aws-solutions-constructs/aws-alb-fargate/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-alb-fargate/lib/index.ts
@@ -96,8 +96,6 @@ export interface AlbToFargateProps {
   readonly albLoggingBucketProps?: s3.BucketProps;
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC and ALB.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-alb-lambda/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-alb-lambda/lib/index.ts
@@ -109,8 +109,6 @@ export interface AlbToLambdaProps {
   readonly albLoggingBucketProps?: s3.BucketProps,
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC and ALB.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
 }

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-dynamodb/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-dynamodb/lib/index.ts
@@ -22,8 +22,6 @@ export interface FargateToDynamoDBProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-eventbridge/lib/index.ts
@@ -22,8 +22,6 @@ export interface FargateToEventbridgeProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - None
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-kinesisstreams/README.md b/source/patterns/@aws-solutions-constructs/aws-fargate-kinesisstreams/README.md
@@ -72,7 +72,7 @@ new FargateToKinesisStreams(this, "FargateToKinesisStreams", new FargateToKinesi
 
 | **Name**     | **Type**        | **Description** |
 |:-------------|:----------------|-----------------|
-| publicApi | `boolean` | True if the VPC provisioned by this construct should contain only Isolated Subnets, otherwise False for the provisioned VPC to contain Public/Private Subnets. Note this property is ignored if an existing VPC is specified in the `existingVpc` property. |
+| publicApi | `boolean` | True if the VPC provisioned by this construct should contain Public/Private Subnets, otherwise False for the VPC to contain Isolated Subnets only. Note this property is ignored if an existing VPC is specified in the `existingVpc` property. |
 | vpcProps? | [`ec2.VpcProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.VpcProps.html) | Optional custom properties for a new VPC the construct will create. Providing both this and `existingVpc` is an error. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |
 | existingVpc? | [`ec2.IVpc`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.IVpc.html) | An existing VPC in which to deploy the Fargate Service. Providing both this and `vpcProps` is an error. If the client provides an existing Fargate Service in the `existingFargateServiceObject` property, this value must be the VPC where the service is running. An Amazon Kinesis Streams Interface Endpoint will be added to this VPC. |
 | clusterProps? | [`ecs.ClusterProps`](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_ecs.ClusterProps.html) | Optional properties to create a new ECS cluster. To provide an existing cluster, use the cluster attribute of fargateServiceProps. |

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-kinesisstreams/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-kinesisstreams/lib/index.ts
@@ -25,14 +25,12 @@ import { Construct } from 'constructs';
  */
 export interface FargateToKinesisStreamsProps {
   /**
-   * True if the VPC provisioned by this construct should contain only Isolated Subnets,
-   * otherwise False for the provisioned VPC to contain Public/Private Subnets.
+   * True if the VPC provisioned by this construct should contain Public/Private Subnets,
+   * otherwise False for the VPC to contain Isolated Subnets only.
    *
    * Note this property is ignored if an existing VPC is specified in the `existingVpc` property.
-   *
-   * @default - False
    */
-    readonly publicApi: boolean;
+  readonly publicApi: boolean;
   /**
    * Optional custom properties for a new VPC the construct will create. Providing both this and `existingVpc` is an error.
    *

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-opensearch/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-opensearch/lib/index.ts
@@ -42,8 +42,6 @@ export interface FargateToOpenSearchProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-s3/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-s3/lib/index.ts
@@ -42,8 +42,6 @@ export interface FargateToS3Props {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-secretsmanager/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-secretsmanager/lib/index.ts
@@ -22,8 +22,6 @@ export interface FargateToSecretsmanagerProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-sns/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-sns/lib/index.ts
@@ -42,8 +42,6 @@ export interface FargateToSnsProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-sqs/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-sqs/lib/index.ts
@@ -42,8 +42,6 @@ export interface FargateToSqsProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-ssmstringparameter/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-ssmstringparameter/lib/index.ts
@@ -22,8 +22,6 @@ export interface FargateToSsmstringparameterProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-fargate-stepfunctions/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-fargate-stepfunctions/lib/index.ts
@@ -24,8 +24,6 @@ export interface FargateToStepfunctionsProps {
   /**
    * Whether the construct is deploying a private or public API. This has implications for the VPC deployed
    * by this construct.
-   *
-   * @default - none
    */
   readonly publicApi: boolean;
   /**

diff --git a/source/patterns/@aws-solutions-constructs/aws-route53-alb/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-route53-alb/lib/index.ts
@@ -82,8 +82,6 @@ export interface Route53ToAlbProps {
   /**
    * Whether to create a public or private API. This value has implications
    * for the VPC, the type of Hosted Zone and the Application Load Balancer
-   *
-   * @default - None
    */
   readonly publicApi: boolean
 }

diff --git a/source/patterns/@aws-solutions-constructs/aws-route53-apigateway/lib/index.ts b/source/patterns/@aws-solutions-constructs/aws-route53-apigateway/lib/index.ts
@@ -28,8 +28,6 @@ export interface Route53ToApiGatewayProps {
   /**
    * Whether to create a public or private API. This value has implications
    * for the VPC, the type of Hosted Zone and the Application Load Balancer
-   *
-   * @default - None
    */
   readonly publicApi: boolean
   /**