aws-solutions-library-samples · jtblack-aws · Mar 5, 2024 · Mar 6, 2024 · Mar 7, 2024 · Mar 13, 2024
diff --git a/.github/copyright.yaml b/.github/copyright.yaml
@@ -0,0 +1,5 @@
+one_date_re: ' Copyright (?P<year>[0-9]{4})'
+two_date_re: ' Copyright (?P<from>[0-9]{4})-(?P<to>[0-9]{4})'
+one_date_format: ' Copyright {year}'
+two_date_format: ' Copyright {from}-{to}'
+license_file: LICENSE
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,3 +28,31 @@ repos:
         stages: [ manual ]
         # uncomment the line below if using "finch" on MacOS
         # args: [ "-f" ]
+
+  - repo: https://github.com/sbrunner/pre-commit-copyright
+    rev: 0.7.0
+    hooks:
+      - id: copyright
+        name: update copyright
+        exclude: |
+          (?x)^(
+            ^\..+|
+            .+\.md|
+            jest.config.js|
+            LICENSE|
+            package.json|
+            package-lock.json
+            tsconfig.json|
+          )$
+      - id: copyright-required
+        name: require copyright
+        exclude: |
+          (?x)^(
+            ^\..+|
+            .+\.md|
+            jest.config.js|
+            LICENSE|
+            package.json|
+            package-lock.json|
+            tsconfig.json|
+          )$
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,3 +1,7 @@
+/*
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
+ */
+
 export * from "./osml/model_runner/autoscaling/mr_autoscaling";
 export * from "./osml/model_runner/mr_dataplane";
 export * from "./osml/model_runner/mr_container";
@@ -20,3 +24,5 @@ export * from "./osml/osml_vpc";
 export * from "./osml/tile_server/ts_container";
 export * from "./osml/tile_server/ts_dataplane";
 export * from "./osml/tile_server/roles/ts_task_role";
+export * from "./osml/tile_server/testing/ts_test_runner";
+export * from "./osml/tile_server/testing/ts_imagery";
diff --git a/lib/osml/model_endpoint/me_container.ts b/lib/osml/model_endpoint/me_container.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { RemovalPolicy, SymlinkFollowMode } from "aws-cdk-lib";
 import { DockerImageAsset } from "aws-cdk-lib/aws-ecr-assets";
 import { ContainerImage } from "aws-cdk-lib/aws-ecs";

diff --git a/lib/osml/model_endpoint/me_http_endpoint.ts b/lib/osml/model_endpoint/me_http_endpoint.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { Duration, RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/model_endpoint/me_sm_endpoint.ts b/lib/osml/model_endpoint/me_sm_endpoint.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import {

diff --git a/lib/osml/model_endpoint/roles/me_http_role.ts b/lib/osml/model_endpoint/roles/me_http_role.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { region_info } from "aws-cdk-lib";
 import {
   CompositePrincipal,

diff --git a/lib/osml/model_endpoint/roles/me_sm_role.ts b/lib/osml/model_endpoint/roles/me_sm_role.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { ManagedPolicy, Role, ServicePrincipal } from "aws-cdk-lib/aws-iam";
 import { Construct } from "constructs";
 

diff --git a/lib/osml/model_runner/autoscaling/mr_autoscaling.ts b/lib/osml/model_runner/autoscaling/mr_autoscaling.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { EcsIsoServiceAutoscaler } from "@cdklabs/cdk-enterprise-iac";

diff --git a/lib/osml/model_runner/monitoring/mr_monitoring.ts b/lib/osml/model_runner/monitoring/mr_monitoring.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import {
   Dashboard,
   GraphWidget,

diff --git a/lib/osml/model_runner/mr_container.ts b/lib/osml/model_runner/mr_container.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy, SymlinkFollowMode } from "aws-cdk-lib";

diff --git a/lib/osml/model_runner/mr_dataplane.ts b/lib/osml/model_runner/mr_dataplane.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { Duration, region_info, RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/model_runner/roles/mr_task_role.ts b/lib/osml/model_runner/roles/mr_task_role.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { region_info } from "aws-cdk-lib";
 import {
   CompositePrincipal,

diff --git a/lib/osml/model_runner/testing/mr_endpoints.ts b/lib/osml/model_runner/testing/mr_endpoints.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { RemovalPolicy } from "aws-cdk-lib";
 import { ContainerImage } from "aws-cdk-lib/aws-ecs";
 import { IRole } from "aws-cdk-lib/aws-iam";

diff --git a/lib/osml/model_runner/testing/mr_imagery.ts b/lib/osml/model_runner/testing/mr_imagery.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy } from "aws-cdk-lib";
@@ -26,7 +26,7 @@ export class MRImageryConfig {
    */
   constructor(
     public S3_IMAGE_BUCKET: string = "test-images",
-    public S3_TEST_IMAGES_PATH: string = "assets/images"
+    public S3_TEST_IMAGES_PATH: string = "assets/images/model-runner"
   ) {}
 }
 

diff --git a/lib/osml/model_runner/testing/mr_sync.ts b/lib/osml/model_runner/testing/mr_sync.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/osml_account.ts b/lib/osml/osml_account.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 /**

diff --git a/lib/osml/osml_bucket.ts b/lib/osml/osml_bucket.ts
@@ -1,3 +1,7 @@
+/*
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
+ */
+
 import { RemovalPolicy } from "aws-cdk-lib";
 import {
   BlockPublicAccess,

diff --git a/lib/osml/osml_ecr_deployment.ts b/lib/osml/osml_ecr_deployment.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/osml_queue.ts b/lib/osml/osml_queue.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { Duration } from "aws-cdk-lib";

diff --git a/lib/osml/osml_repository.ts b/lib/osml/osml_repository.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/osml_table.ts b/lib/osml/osml_table.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { RemovalPolicy } from "aws-cdk-lib";

diff --git a/lib/osml/osml_topic.ts b/lib/osml/osml_topic.ts
@@ -1,5 +1,5 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
 
 import { Key } from "aws-cdk-lib/aws-kms";

diff --git a/lib/osml/osml_vpc.ts b/lib/osml/osml_vpc.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import {
   GatewayVpcEndpointAwsService,
   InterfaceVpcEndpointAwsService,

diff --git a/lib/osml/tile_server/roles/ts_lambda_role.ts b/lib/osml/tile_server/roles/ts_lambda_role.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { region_info } from "aws-cdk-lib";
 import {
   CompositePrincipal,

diff --git a/lib/osml/tile_server/roles/ts_task_role.ts b/lib/osml/tile_server/roles/ts_task_role.ts
@@ -1,6 +1,7 @@
 /*
- * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
  */
+
 import { region_info } from "aws-cdk-lib";
 import {
   AccountPrincipal,

diff --git a/lib/osml/tile_server/testing/ts_imagery.ts b/lib/osml/tile_server/testing/ts_imagery.ts
@@ -0,0 +1,134 @@
+/*
+ * Copyright 2023-2024 Amazon.com, Inc. or its affiliates.
+ */
+
+import { RemovalPolicy } from "aws-cdk-lib";
+import { IVpc } from "aws-cdk-lib/aws-ec2";
+import { BucketAccessControl } from "aws-cdk-lib/aws-s3";
+import {
+  BucketDeployment,
+  ServerSideEncryption,
+  Source
+} from "aws-cdk-lib/aws-s3-deployment";
+import { Construct } from "constructs";
+
+import { OSMLAccount } from "../../osml_account";
+import { OSMLBucket } from "../../osml_bucket";
+
+/**
+ * Configuration class for TSImagery Construct.
+ */
+export class TSImageryConfig {
+  /**
+   * Creates an instance of TSImageryConfig.
+   * @param {string} S3_IMAGE_BUCKET - The name of the S3 bucket where images will be stored.
+   * @param {string} S3_TEST_IMAGES_PATH - The local path to the test imager to deploy.
+   */
+  constructor(
+    public S3_IMAGE_BUCKET: string = "tile-server-test-images",
+    public S3_TEST_IMAGES_PATH: string = "assets/images/tile-server"
+  ) {}
+}
+
+/**
+ * Represents the properties for configuring the TSImagery Construct.
+ *
+ * @interface TSImageryProps
+ * @property {OSMLAccount} account - The OSML account to use.
+ * @property {IVpc} vpc - The Model Runner VPC configuration.
+ * @property {TSImageryConfig|undefined} [tsImageryConfig] - Optional configuration for TS Imagery.
+ * @property {string|undefined} [securityGroupId] - Optional security group ID to apply to the VPC config for SM endpoints.
+ */
+export interface TSImageryProps {
+  /**
+   * The OSML account to use.
+   *
+   * @type {OSMLAccount}
+   */
+  account: OSMLAccount;
+
+  /**
+   * The target vpc for the s3 bucket deployment.
+   *
+   * @type {IVpc}
+   */
+  vpc: IVpc;
+
+  /**
+   * Optional custom configuration for TSImagery.
+   *
+   * @type {TSImageryConfig|undefined}
+   */
+  tsImageryConfig?: TSImageryConfig;
+
+  /**
+   * Optional security group ID to apply to the VPC config for SM endpoints.
+   *
+   * @type {string|undefined}
+   */
+  securityGroupId?: string;
+}
+
+/**
+ * Represents an TSImagery construct for managing imagery resources.
+ */
+export class TSImagery extends Construct {
+  /**
+   * The image bucket where TS imagery data is stored.
+   */
+  public imageBucket: OSMLBucket;
+
+  /**
+   * The removal policy for this TSImagery resource.
+   * @default RemovalPolicy.DESTROY
+   */
+  public removalPolicy: RemovalPolicy;
+
+  /**
+   * Configuration options for TSImagery.
+   */
+  public tsImageryConfig: TSImageryConfig;
+
+  /**
+   * Creates an TSImagery cdk construct.
+   * @param scope The scope/stack in which to define this construct.
+   * @param id The id of this construct within the current scope.
+   * @param props The properties of this construct.
+   */
+  constructor(scope: Construct, id: string, props: TSImageryProps) {
+    super(scope, id);
+
+    // Check if a custom configuration was provided
+    if (props.tsImageryConfig != undefined) {
+      // Import existing TS configuration
+      this.tsImageryConfig = props.tsImageryConfig;
+    } else {
+      // Create a new default configuration
+      this.tsImageryConfig = new TSImageryConfig();
+    }
+
+    // Setup a removal policy based on the 'prodLike' property
+    this.removalPolicy = props.account.prodLike
+      ? RemovalPolicy.RETAIN
+      : RemovalPolicy.DESTROY;
+
+    // Create an image bucket to store TS imagery data
+    this.imageBucket = new OSMLBucket(this, `TSTestImageBucket`, {
+      bucketName: `${this.tsImageryConfig.S3_IMAGE_BUCKET}-${props.account.id}`,
+      prodLike: props.account.prodLike,
+      removalPolicy: this.removalPolicy
+    });
+
+    // Deploy test images into the bucket
+    new BucketDeployment(this, "TSTestImageDeployment", {
+      sources: [Source.asset(this.tsImageryConfig.S3_TEST_IMAGES_PATH)],
+      destinationBucket: this.imageBucket.bucket,
+      accessControl: BucketAccessControl.BUCKET_OWNER_FULL_CONTROL,
+      memoryLimit: 10240,
+      useEfs: true,
+      vpc: props.vpc,
+      retainOnDelete: props.account.prodLike,
+      serverSideEncryption: ServerSideEncryption.AES_256
+    });
+  }
+}