docs(aws-ecs): update documentation links (#3255)

aws · Jul 10, 2019 · 032e170 · 032e170
1 parent 8541892
commit 032e170
Show file tree

Hide file tree

Showing 9 changed files with 35 additions and 35 deletions.
diff --git a/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts b/packages/@aws-cdk/aws-ecs/lib/base/task-definition.ts
@@ -36,8 +36,8 @@ export interface ITaskDefinition extends IResource {
 }
 
 /**
- * The common properties for all task definitions. For more information, see Task Definition Parameters:
- * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html]
+ * The common properties for all task definitions. For more information, see
+ * [Task Definition Parameters](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_definition_parameters.html).
  */
 export interface CommonTaskDefinitionProps {
   /**
@@ -64,8 +64,8 @@ export interface CommonTaskDefinitionProps {
   readonly taskRole?: iam.IRole;
 
   /**
-   * The list of volume definitions for the task. For more information, see Task Definition Parameter Volumes:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes]
+   * The list of volume definitions for the task. For more information, see
+   * [Task Definition Parameter Volumes](https://docs.aws.amazon.com/AmazonECS/latest/developerguide//task_definition_parameters.html#volumes).
    *
    * @default - No volumes are passed to the Docker daemon on a container instance.
    */
@@ -418,8 +418,7 @@ export enum NetworkMode {
  * For tasks that use a Docker volume, specify a DockerVolumeConfiguration.
  * For tasks that use a bind mount host volume, specify a host and optional sourcePath.
  *
- * For more information, see Using Data Volumes in Tasks:
- * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html]
+ * For more information, see [Using Data Volumes in Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_data_volumes.html).
  */
 export interface Volume {
   /**

diff --git a/packages/@aws-cdk/aws-ecs/lib/cluster.ts b/packages/@aws-cdk/aws-ecs/lib/cluster.ts
@@ -471,8 +471,8 @@ export interface AddCapacityOptions extends AddAutoScalingGroupCapacityOptions,
   readonly instanceType: ec2.InstanceType;
 
   /**
-   * The ECS-optimized AMI variant to use. For more information, see Amazon ECS-optimized AMIs:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html]
+   * The ECS-optimized AMI variant to use. For more information, see
+   * [Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).
    *
    * @default - Amazon Linux 2
    */
@@ -504,8 +504,8 @@ export interface CloudMapNamespaceOptions {
 }
 
 /**
- * The ECS-optimized AMI variant to use. For more information, see Amazon ECS-optimized AMIs:
- * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html].
+ * The ECS-optimized AMI variant to use. For more information, see
+ * [Amazon ECS-optimized AMIs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-optimized_AMI.html).
  */
 export enum AmiHardwareType {
 

diff --git a/packages/@aws-cdk/aws-ecs/lib/container-definition.ts b/packages/@aws-cdk/aws-ecs/lib/container-definition.ts
@@ -189,7 +189,7 @@ export interface ContainerDefinitionOptions {
 
   /**
    * Linux-specific modifications that are applied to the container, such as Linux kernel capabilities.
-   * For more information see KernelCapabilities. [https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html]
+   * For more information see [KernelCapabilities](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html).
    *
    * @default - No Linux paramters.
    */
@@ -546,8 +546,7 @@ export interface Ulimit {
   /**
    * The type of the ulimit.
    *
-   * For more information, see UlimitName:
-   * [https://docs.aws.amazon.com/cdk/api/latest/typescript/api/aws-ecs/ulimitname.html#aws_ecs_UlimitName]
+   * For more information, see [UlimitName](https://docs.aws.amazon.com/cdk/api/latest/typescript/api/aws-ecs/ulimitname.html#aws_ecs_UlimitName).
    */
   readonly name: UlimitName,
 

diff --git a/packages/@aws-cdk/aws-ecs/lib/ec2/ec2-service.ts b/packages/@aws-cdk/aws-ecs/lib/ec2/ec2-service.ts
@@ -46,16 +46,16 @@ export interface Ec2ServiceProps extends BaseServiceOptions {
   readonly securityGroup?: ec2.ISecurityGroup;
 
   /**
-   * The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html]
+   * The placement constraints to use for tasks in the service. For more information, see
+   * [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
    *
    * @default - No constraints.
    */
   readonly placementConstraints?: PlacementConstraint[];
 
   /**
-   * The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html]
+   * The placement strategies to use for tasks in the service. For more information, see
+   * [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
    *
    * @default - No strategies.
    */
@@ -157,8 +157,8 @@ export class Ec2Service extends BaseService implements IEc2Service, elb.ILoadBal
   }
 
   /**
-   * Adds one or more placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html]
+   * Adds one or more placement strategies to use for tasks in the service. For more information, see
+   * [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
    */
   public addPlacementStrategies(...strategies: PlacementStrategy[]) {
     if (strategies.length > 0 && this.daemon) {
@@ -171,8 +171,8 @@ export class Ec2Service extends BaseService implements IEc2Service, elb.ILoadBal
   }
 
   /**
-   * Adds one or more placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html]
+   * Adds one or more placement strategies to use for tasks in the service. For more information, see
+   * [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
    */
   public addPlacementConstraints(...constraints: PlacementConstraint[]) {
     for (const constraint of constraints) {

diff --git a/packages/@aws-cdk/aws-ecs/lib/fargate/fargate-service.ts b/packages/@aws-cdk/aws-ecs/lib/fargate/fargate-service.ts
@@ -41,8 +41,9 @@ export interface FargateServiceProps extends BaseServiceOptions {
   /**
    * The platform version on which to run your service.
    *
-   * If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html] in the Amazon Elastic Container Service Developer Guide.
+   * If one is not specified, the LATEST platform version is used by default. For more information, see
+   * [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
+   * in the Amazon Elastic Container Service Developer Guide.
    *
    * @default Latest
    */

diff --git a/packages/@aws-cdk/aws-ecs/lib/images/repository.ts b/packages/@aws-cdk/aws-ecs/lib/images/repository.ts
@@ -15,8 +15,8 @@ export interface RepositoryImageProps {
 }
 
 /**
- * An image hosted in a public or private repository. For images hosted in Amazon ECR, see EcrImage:
- * [https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html]
+ * An image hosted in a public or private repository. For images hosted in Amazon ECR, see
+ * [EcrImage](https://docs.aws.amazon.com/AmazonECR/latest/userguide/images.html).
  */
 export class RepositoryImage extends ContainerImage {
 

diff --git a/packages/@aws-cdk/aws-ecs/lib/linux-parameters.ts b/packages/@aws-cdk/aws-ecs/lib/linux-parameters.ts
@@ -163,8 +163,8 @@ export interface Tmpfs {
   readonly size: number,
 
   /**
-   * The list of tmpfs volume mount options. For more information, see TmpfsMountOptions:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Tmpfs.html]
+   * The list of tmpfs volume mount options. For more information, see
+   * [TmpfsMountOptions](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_Tmpfs.html).
    */
   readonly mountOptions?: TmpfsMountOption[],
 }

diff --git a/packages/@aws-cdk/aws-ecs/lib/log-drivers/log-driver.ts b/packages/@aws-cdk/aws-ecs/lib/log-drivers/log-driver.ts
@@ -30,8 +30,9 @@ export interface LogDriverConfig {
    * For tasks using the Fargate launch type, the supported log drivers are awslogs and splunk.
    * For tasks using the EC2 launch type, the supported log drivers are awslogs, syslog, gelf, fluentd, splunk, journald, and json-file.
    *
-   * For more information about using the awslogs log driver, see Using the awslogs Log Driver:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html] in the Amazon Elastic Container Service Developer Guide.
+   * For more information about using the awslogs log driver, see
+   * [Using the awslogs Log Driver](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_awslogs.html)
+   * in the Amazon Elastic Container Service Developer Guide.
    */
   readonly logDriver: string;
 

diff --git a/packages/@aws-cdk/aws-ecs/lib/placement.ts b/packages/@aws-cdk/aws-ecs/lib/placement.ts
@@ -17,8 +17,8 @@ export enum BinPackResource {
 }
 
 /**
- * The placement strategies to use for tasks in the service. For more information, see Amazon ECS Task Placement Strategies:
- * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html]
+ * The placement strategies to use for tasks in the service. For more information, see
+ * [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
  *
  * Tasks will preferentially be placed on instances that match these rules.
  */
@@ -93,8 +93,8 @@ export class PlacementStrategy {
 }
 
 /**
- * The placement constraints to use for tasks in the service. For more information, see Amazon ECS Task Placement Constraints.
- * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html]
+ * The placement constraints to use for tasks in the service. For more information, see
+ * [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
  *
  * Tasks will only be placed on instances that match these rules.
  */
@@ -109,8 +109,8 @@ export class PlacementConstraint {
   /**
    * Use memberOf to restrict the selection to a group of valid candidates specified by a query expression.
    *
-   * Multiple expressions can be specified. For more information, see Cluster Query Language:
-   * [https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html]
+   * Multiple expressions can be specified. For more information, see
+   * [Cluster Query Language](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/cluster-query-language.html).
    *
    * You can specify multiple expressions in one call. The tasks will only be placed on instances matching all expressions.
    *