cdk-ecr-deployment 3.0.41 → 3.0.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/.jsii +15 -2
  2. package/.jsii.tabl.json +1 -1
  3. package/lib/index.js +3 -3
  4. package/node_modules/@types/cacheable-request/node_modules/@types/node/README.md +1 -1
  5. package/node_modules/@types/cacheable-request/node_modules/@types/node/cluster.d.ts +165 -19
  6. package/node_modules/@types/cacheable-request/node_modules/@types/node/dom-events.d.ts +2 -0
  7. package/node_modules/@types/cacheable-request/node_modules/@types/node/events.d.ts +2 -6
  8. package/node_modules/@types/cacheable-request/node_modules/@types/node/fs/promises.d.ts +6 -0
  9. package/node_modules/@types/cacheable-request/node_modules/@types/node/package.json +2 -2
  10. package/node_modules/@types/cacheable-request/node_modules/@types/node/process.d.ts +15 -0
  11. package/node_modules/@types/keyv/node_modules/@types/node/README.md +1 -1
  12. package/node_modules/@types/keyv/node_modules/@types/node/cluster.d.ts +165 -19
  13. package/node_modules/@types/keyv/node_modules/@types/node/dom-events.d.ts +2 -0
  14. package/node_modules/@types/keyv/node_modules/@types/node/events.d.ts +2 -6
  15. package/node_modules/@types/keyv/node_modules/@types/node/fs/promises.d.ts +6 -0
  16. package/node_modules/@types/keyv/node_modules/@types/node/package.json +2 -2
  17. package/node_modules/@types/keyv/node_modules/@types/node/process.d.ts +15 -0
  18. package/node_modules/@types/responselike/node_modules/@types/node/README.md +1 -1
  19. package/node_modules/@types/responselike/node_modules/@types/node/cluster.d.ts +165 -19
  20. package/node_modules/@types/responselike/node_modules/@types/node/dom-events.d.ts +2 -0
  21. package/node_modules/@types/responselike/node_modules/@types/node/events.d.ts +2 -6
  22. package/node_modules/@types/responselike/node_modules/@types/node/fs/promises.d.ts +6 -0
  23. package/node_modules/@types/responselike/node_modules/@types/node/package.json +2 -2
  24. package/node_modules/@types/responselike/node_modules/@types/node/process.d.ts +15 -0
  25. package/package.json +2 -2
package/.jsii CHANGED
@@ -3037,6 +3037,19 @@
3037
3037
  }
3038
3038
  }
3039
3039
  },
3040
+ "aws-cdk-lib.aws_securitylake": {
3041
+ "targets": {
3042
+ "dotnet": {
3043
+ "package": "Amazon.CDK.AWS.SecurityLake"
3044
+ },
3045
+ "java": {
3046
+ "package": "software.amazon.awscdk.services.securitylake"
3047
+ },
3048
+ "python": {
3049
+ "module": "aws_cdk.aws_securitylake"
3050
+ }
3051
+ }
3052
+ },
3040
3053
  "aws-cdk-lib.aws_servicecatalog": {
3041
3054
  "targets": {
3042
3055
  "dotnet": {
@@ -4177,6 +4190,6 @@
4177
4190
  "symbolId": "src/index:S3ArchiveName"
4178
4191
  }
4179
4192
  },
4180
- "version": "3.0.41",
4181
- "fingerprint": "M2DkkcUAi0vBEN6ZxLmzDMubaPPKz+VsmU7gzwDMtWU="
4193
+ "version": "3.0.43",
4194
+ "fingerprint": "Mq7Ffa7zVMet6UuPQQWUxO1ZDfrfT6Z+8efX3K6RIMk="
4182
4195
  }
package/.jsii.tabl.json CHANGED
@@ -1 +1 @@
1
- {"version":"2","toolVersion":"5.3.31","snippets":{"33850328020507963bc7787401a169bb06e49f6132425a6d1529815c1554c645":{"translations":{"python":{"source":"from aws_cdk.aws_ecr_assets import DockerImageAsset\n\n\nimage = DockerImageAsset(self, \"CDKDockerImage\",\n directory=path.join(__dirname, \"docker\")\n)\n\n# Copy from cdk docker image asset to another ECR.\necrdeploy.ECRDeployment(self, \"DeployDockerImage1\",\n src=ecrdeploy.DockerImageName(image.image_uri),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\")\n)\n\n# Copy from docker registry to ECR.\necrdeploy.ECRDeployment(self, \"DeployDockerImage2\",\n src=ecrdeploy.DockerImageName(\"nginx:latest\"),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\")\n)\n\n# Copy from private docker registry to ECR.\n# The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\necrdeploy.ECRDeployment(self, \"DeployDockerImage3\",\n src=ecrdeploy.DockerImageName(\"javacs3/nginx:latest\", \"username:password\"),\n # src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n # src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\")\n).add_to_principal_policy(iam.PolicyStatement(\n effect=iam.Effect.ALLOW,\n actions=[\"secretsmanager:GetSecretValue\"\n ],\n resources=[\"*\"]\n))","version":"2"},"csharp":{"source":"using Amazon.CDK.AWS.Ecr.Assets;\n\n\nvar image = new DockerImageAsset(this, \"CDKDockerImage\", new DockerImageAssetProps {\n Directory = Join(__dirname, \"docker\")\n});\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\nnew ECRDeployment(this, \"DeployDockerImage1\", new ECRDeploymentProps {\n Src = new DockerImageName(image.ImageUri),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\")\n});\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\nnew ECRDeployment(this, \"DeployDockerImage2\", new ECRDeploymentProps {\n Src = new DockerImageName(\"nginx:latest\"),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\")\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ECRDeployment(this, \"DeployDockerImage3\", new ECRDeploymentProps {\n Src = new DockerImageName(\"javacs3/nginx:latest\", \"username:password\"),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\")\n}).AddToPrincipalPolicy(new PolicyStatement(new PolicyStatementProps {\n Effect = Effect.ALLOW,\n Actions = new [] { \"secretsmanager:GetSecretValue\" },\n Resources = new [] { \"*\" }\n}));","version":"1"},"java":{"source":"import software.amazon.awscdk.services.ecr.assets.DockerImageAsset;\n\n\nDockerImageAsset image = DockerImageAsset.Builder.create(this, \"CDKDockerImage\")\n .directory(join(__dirname, \"docker\"))\n .build();\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\nECRDeployment.Builder.create(this, \"DeployDockerImage1\")\n .src(new DockerImageName(image.getImageUri()))\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\", Aws.ACCOUNT_ID)))\n .build();\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\nECRDeployment.Builder.create(this, \"DeployDockerImage2\")\n .src(new DockerImageName(\"nginx:latest\"))\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\", Aws.ACCOUNT_ID)))\n .build();\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nECRDeployment.Builder.create(this, \"DeployDockerImage3\")\n .src(new DockerImageName(\"javacs3/nginx:latest\", \"username:password\"))\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\", Aws.ACCOUNT_ID)))\n .build().addToPrincipalPolicy(PolicyStatement.Builder.create()\n .effect(Effect.ALLOW)\n .actions(List.of(\"secretsmanager:GetSecretValue\"))\n .resources(List.of(\"*\"))\n .build());","version":"1"},"go":{"source":"import \"github.com/aws/aws-cdk-go/awscdk\"\n\n\nimage := awscdk.NewDockerImageAsset(this, jsii.String(\"CDKDockerImage\"), &DockerImageAssetProps{\n\tDirectory: path.join(__dirname, jsii.String(\"docker\")),\n})\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage1\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(image.ImageUri),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\", cdk.Aws_ACCOUNT_ID())),\n})\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage2\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(jsii.String(\"nginx:latest\")),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\", cdk.Aws_ACCOUNT_ID())),\n})\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage3\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(jsii.String(\"javacs3/nginx:latest\"), jsii.String(\"username:password\")),\n\t// src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n\t// src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\", cdk.Aws_ACCOUNT_ID())),\n}).AddToPrincipalPolicy(awscdk.Aws_iam.NewPolicyStatement(&PolicyStatementProps{\n\tEffect: awscdk.*Aws_iam.Effect_ALLOW,\n\tActions: []*string{\n\t\tjsii.String(\"secretsmanager:GetSecretValue\"),\n\t},\n\tResources: []*string{\n\t\tjsii.String(\"*\"),\n\t},\n}))","version":"1"},"$":{"source":"import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';\n\nconst image = new DockerImageAsset(this, 'CDKDockerImage', {\n directory: path.join(__dirname, 'docker'),\n});\n\n// Copy from cdk docker image asset to another ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage1', {\n src: new ecrdeploy.DockerImageName(image.imageUri),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest`),\n});\n\n// Copy from docker registry to ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage2', {\n src: new ecrdeploy.DockerImageName('nginx:latest'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest`),\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage3', {\n src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'username:password'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest`),\n}).addToPrincipalPolicy(new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: [\n 'secretsmanager:GetSecretValue',\n ],\n resources: ['*'],\n}));","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"cdk-ecr-deployment"},"field":{"field":"markdown","line":33}},"didCompile":true,"fqnsReferenced":["aws-cdk-lib.aws_ecr_assets.DockerImageAsset","aws-cdk-lib.aws_ecr_assets.DockerImageAsset#imageUri","aws-cdk-lib.aws_ecr_assets.DockerImageAssetProps","aws-cdk-lib.aws_iam.Effect","aws-cdk-lib.aws_iam.Effect#ALLOW","aws-cdk-lib.aws_iam.PolicyStatement","aws-cdk-lib.aws_iam.PolicyStatementProps","cdk-ecr-deployment.DockerImageName","cdk-ecr-deployment.ECRDeployment","cdk-ecr-deployment.ECRDeployment#addToPrincipalPolicy","cdk-ecr-deployment.ECRDeploymentProps","cdk-ecr-deployment.IImageName","constructs.Construct"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\nimport { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport * as path from 'node:path';\nimport { Construct } from 'constructs';\n import * as ecrdeploy from 'cdk-ecr-deployment';\nimport {\n Stack,\n aws_iam as iam,\n} from 'aws-cdk-lib';\nimport * as cdk from 'aws-cdk-lib';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n // Code snippet begins after !show marker below\n/// !show\n\n\nconst image = new DockerImageAsset(this, 'CDKDockerImage', {\n directory: path.join(__dirname, 'docker'),\n});\n\n// Copy from cdk docker image asset to another ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage1', {\n src: new ecrdeploy.DockerImageName(image.imageUri),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest`),\n});\n\n// Copy from docker registry to ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage2', {\n src: new ecrdeploy.DockerImageName('nginx:latest'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest`),\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage3', {\n src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'username:password'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest`),\n}).addToPrincipalPolicy(new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: [\n 'secretsmanager:GetSecretValue',\n ],\n resources: ['*'],\n}));\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"11":11,"16":3,"18":3,"80":51,"110":4,"209":2,"210":5,"211":21,"213":2,"214":11,"228":3,"239":3,"243":1,"244":3,"260":1,"261":1,"272":1,"273":1,"275":1,"276":1,"303":10,"312":1},"fqnsFingerprint":"9d435b1b2c76010f8a75490e073b59c4d776eb93ca570ed78a292aecd169403d"}}}
1
+ {"version":"2","toolVersion":"5.3.34","snippets":{"33850328020507963bc7787401a169bb06e49f6132425a6d1529815c1554c645":{"translations":{"python":{"source":"from aws_cdk.aws_ecr_assets import DockerImageAsset\n\n\nimage = DockerImageAsset(self, \"CDKDockerImage\",\n directory=path.join(__dirname, \"docker\")\n)\n\n# Copy from cdk docker image asset to another ECR.\necrdeploy.ECRDeployment(self, \"DeployDockerImage1\",\n src=ecrdeploy.DockerImageName(image.image_uri),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\")\n)\n\n# Copy from docker registry to ECR.\necrdeploy.ECRDeployment(self, \"DeployDockerImage2\",\n src=ecrdeploy.DockerImageName(\"nginx:latest\"),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\")\n)\n\n# Copy from private docker registry to ECR.\n# The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\necrdeploy.ECRDeployment(self, \"DeployDockerImage3\",\n src=ecrdeploy.DockerImageName(\"javacs3/nginx:latest\", \"username:password\"),\n # src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n # src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest=ecrdeploy.DockerImageName(f\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\")\n).add_to_principal_policy(iam.PolicyStatement(\n effect=iam.Effect.ALLOW,\n actions=[\"secretsmanager:GetSecretValue\"\n ],\n resources=[\"*\"]\n))","version":"2"},"csharp":{"source":"using Amazon.CDK.AWS.Ecr.Assets;\n\n\nvar image = new DockerImageAsset(this, \"CDKDockerImage\", new DockerImageAssetProps {\n Directory = Join(__dirname, \"docker\")\n});\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\nnew ECRDeployment(this, \"DeployDockerImage1\", new ECRDeploymentProps {\n Src = new DockerImageName(image.ImageUri),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\")\n});\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\nnew ECRDeployment(this, \"DeployDockerImage2\", new ECRDeploymentProps {\n Src = new DockerImageName(\"nginx:latest\"),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\")\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ECRDeployment(this, \"DeployDockerImage3\", new ECRDeploymentProps {\n Src = new DockerImageName(\"javacs3/nginx:latest\", \"username:password\"),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n Dest = new DockerImageName($\"{cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\")\n}).AddToPrincipalPolicy(new PolicyStatement(new PolicyStatementProps {\n Effect = Effect.ALLOW,\n Actions = new [] { \"secretsmanager:GetSecretValue\" },\n Resources = new [] { \"*\" }\n}));","version":"1"},"java":{"source":"import software.amazon.awscdk.services.ecr.assets.DockerImageAsset;\n\n\nDockerImageAsset image = DockerImageAsset.Builder.create(this, \"CDKDockerImage\")\n .directory(join(__dirname, \"docker\"))\n .build();\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\nECRDeployment.Builder.create(this, \"DeployDockerImage1\")\n .src(new DockerImageName(image.getImageUri()))\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\", Aws.ACCOUNT_ID)))\n .build();\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\nECRDeployment.Builder.create(this, \"DeployDockerImage2\")\n .src(new DockerImageName(\"nginx:latest\"))\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\", Aws.ACCOUNT_ID)))\n .build();\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nECRDeployment.Builder.create(this, \"DeployDockerImage3\")\n .src(new DockerImageName(\"javacs3/nginx:latest\", \"username:password\"))\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n .dest(new DockerImageName(String.format(\"%s.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\", Aws.ACCOUNT_ID)))\n .build().addToPrincipalPolicy(PolicyStatement.Builder.create()\n .effect(Effect.ALLOW)\n .actions(List.of(\"secretsmanager:GetSecretValue\"))\n .resources(List.of(\"*\"))\n .build());","version":"1"},"go":{"source":"import \"github.com/aws/aws-cdk-go/awscdk\"\n\n\nimage := awscdk.NewDockerImageAsset(this, jsii.String(\"CDKDockerImage\"), &DockerImageAssetProps{\n\tDirectory: path.join(__dirname, jsii.String(\"docker\")),\n})\n\n// Copy from cdk docker image asset to another ECR.\n// Copy from cdk docker image asset to another ECR.\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage1\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(image.ImageUri),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest\", cdk.Aws_ACCOUNT_ID())),\n})\n\n// Copy from docker registry to ECR.\n// Copy from docker registry to ECR.\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage2\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(jsii.String(\"nginx:latest\")),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest\", cdk.Aws_ACCOUNT_ID())),\n})\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\necrdeploy.NewECRDeployment(this, jsii.String(\"DeployDockerImage3\"), &ECRDeploymentProps{\n\tSrc: ecrdeploy.NewDockerImageName(jsii.String(\"javacs3/nginx:latest\"), jsii.String(\"username:password\")),\n\t// src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n\t// src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n\tDest: ecrdeploy.NewDockerImageName(fmt.Sprintf(\"%v.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest\", cdk.Aws_ACCOUNT_ID())),\n}).AddToPrincipalPolicy(awscdk.Aws_iam.NewPolicyStatement(&PolicyStatementProps{\n\tEffect: awscdk.*Aws_iam.Effect_ALLOW,\n\tActions: []*string{\n\t\tjsii.String(\"secretsmanager:GetSecretValue\"),\n\t},\n\tResources: []*string{\n\t\tjsii.String(\"*\"),\n\t},\n}))","version":"1"},"$":{"source":"import { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';\n\nconst image = new DockerImageAsset(this, 'CDKDockerImage', {\n directory: path.join(__dirname, 'docker'),\n});\n\n// Copy from cdk docker image asset to another ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage1', {\n src: new ecrdeploy.DockerImageName(image.imageUri),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest`),\n});\n\n// Copy from docker registry to ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage2', {\n src: new ecrdeploy.DockerImageName('nginx:latest'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest`),\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage3', {\n src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'username:password'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest`),\n}).addToPrincipalPolicy(new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: [\n 'secretsmanager:GetSecretValue',\n ],\n resources: ['*'],\n}));","version":"0"}},"location":{"api":{"api":"moduleReadme","moduleFqn":"cdk-ecr-deployment"},"field":{"field":"markdown","line":33}},"didCompile":true,"fqnsReferenced":["aws-cdk-lib.aws_ecr_assets.DockerImageAsset","aws-cdk-lib.aws_ecr_assets.DockerImageAsset#imageUri","aws-cdk-lib.aws_ecr_assets.DockerImageAssetProps","aws-cdk-lib.aws_iam.Effect","aws-cdk-lib.aws_iam.Effect#ALLOW","aws-cdk-lib.aws_iam.PolicyStatement","aws-cdk-lib.aws_iam.PolicyStatementProps","cdk-ecr-deployment.DockerImageName","cdk-ecr-deployment.ECRDeployment","cdk-ecr-deployment.ECRDeployment#addToPrincipalPolicy","cdk-ecr-deployment.ECRDeploymentProps","cdk-ecr-deployment.IImageName","constructs.Construct"],"fullSource":"// Hoisted imports begin after !show marker below\n/// !show\nimport { DockerImageAsset } from 'aws-cdk-lib/aws-ecr-assets';\n/// !hide\n// Hoisted imports ended before !hide marker above\n// Fixture with packages imported, but nothing else\nimport * as path from 'node:path';\nimport { Construct } from 'constructs';\n import * as ecrdeploy from 'cdk-ecr-deployment';\nimport {\n Stack,\n aws_iam as iam,\n} from 'aws-cdk-lib';\nimport * as cdk from 'aws-cdk-lib';\n\nclass Fixture extends Stack {\n constructor(scope: Construct, id: string) {\n super(scope, id);\n\n // Code snippet begins after !show marker below\n/// !show\n\n\nconst image = new DockerImageAsset(this, 'CDKDockerImage', {\n directory: path.join(__dirname, 'docker'),\n});\n\n// Copy from cdk docker image asset to another ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage1', {\n src: new ecrdeploy.DockerImageName(image.imageUri),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx:latest`),\n});\n\n// Copy from docker registry to ECR.\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage2', {\n src: new ecrdeploy.DockerImageName('nginx:latest'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx2:latest`),\n});\n\n// Copy from private docker registry to ECR.\n// The format of secret in aws secrets manager must be plain text! e.g. <username>:<password>\nnew ecrdeploy.ECRDeployment(this, 'DeployDockerImage3', {\n src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'username:password'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'aws-secrets-manager-secret-name'),\n // src: new ecrdeploy.DockerImageName('javacs3/nginx:latest', 'arn:aws:secretsmanager:us-west-2:000000000000:secret:id'),\n dest: new ecrdeploy.DockerImageName(`${cdk.Aws.ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com/my-nginx3:latest`),\n}).addToPrincipalPolicy(new iam.PolicyStatement({\n effect: iam.Effect.ALLOW,\n actions: [\n 'secretsmanager:GetSecretValue',\n ],\n resources: ['*'],\n}));\n/// !hide\n// Code snippet ended before !hide marker above\n }\n}","syntaxKindCounter":{"11":11,"16":3,"18":3,"80":51,"110":4,"209":2,"210":5,"211":21,"213":2,"214":11,"228":3,"239":3,"243":1,"244":3,"260":1,"261":1,"272":1,"273":1,"275":1,"276":1,"303":10,"312":1},"fqnsFingerprint":"9d435b1b2c76010f8a75490e073b59c4d776eb93ca570ed78a292aecd169403d"}}}
package/lib/index.js CHANGED
@@ -37,7 +37,7 @@ class DockerImageName {
37
37
  }
38
38
  exports.DockerImageName = DockerImageName;
39
39
  _a = JSII_RTTI_SYMBOL_1;
40
- DockerImageName[_a] = { fqn: "cdk-ecr-deployment.DockerImageName", version: "3.0.41" };
40
+ DockerImageName[_a] = { fqn: "cdk-ecr-deployment.DockerImageName", version: "3.0.43" };
41
41
  class S3ArchiveName {
42
42
  constructor(p, ref, creds) {
43
43
  this.creds = creds;
@@ -50,7 +50,7 @@ class S3ArchiveName {
50
50
  }
51
51
  exports.S3ArchiveName = S3ArchiveName;
52
52
  _b = JSII_RTTI_SYMBOL_1;
53
- S3ArchiveName[_b] = { fqn: "cdk-ecr-deployment.S3ArchiveName", version: "3.0.41" };
53
+ S3ArchiveName[_b] = { fqn: "cdk-ecr-deployment.S3ArchiveName", version: "3.0.43" };
54
54
  class ECRDeployment extends constructs_1.Construct {
55
55
  constructor(scope, id, props) {
56
56
  super(scope, id);
@@ -134,5 +134,5 @@ class ECRDeployment extends constructs_1.Construct {
134
134
  }
135
135
  exports.ECRDeployment = ECRDeployment;
136
136
  _c = JSII_RTTI_SYMBOL_1;
137
- ECRDeployment[_c] = { fqn: "cdk-ecr-deployment.ECRDeployment", version: "3.0.41" };
137
+ ECRDeployment[_c] = { fqn: "cdk-ecr-deployment.ECRDeployment", version: "3.0.43" };
138
138
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,qEAAqE;AACrE,sCAAsC;AAGtC,+CAA+C;AAC/C,6BAA6B;AAC7B,6CAAoH;AAEpH,2CAAuC;AACvC,qCAAmD;AAwFnD,SAAS,OAAO,CAAC,UAAkB;IACjC,IAAI,IAAA,gCAAuB,GAAE,EAAE;QAC7B,IAAI;YACF,MAAM,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,sBAAsB,CAAC,CAAC;YACnE,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,eAAe,CAAC,CAAC;YAC3D,aAAa,CAAC,YAAY,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,aAAa,EAAE,YAAY,CAAC,CAAC,CAAC;YAEzE,OAAO,wBAAM,CAAC,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;SAC5C;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,IAAI,CAAC,gCAAgC,GAAG,EAAE,CAAC,CAAC;SACrD;KACF;IAED,OAAO,wBAAM,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,EAAE;QACpE,SAAS,EAAE;YACT,UAAU;SACX;KACF,CAAC,CAAC;AACL,CAAC;AAED,MAAa,eAAe;IAC1B,YAA2B,IAAY,EAAS,KAAc;QAAnC,SAAI,GAAJ,IAAI,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAS;IAAI,CAAC;IACnE,IAAW,GAAG,KAAa,OAAO,YAAY,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;;AAF9D,0CAGC;;;AAED,MAAa,aAAa;IAExB,YAAmB,CAAS,EAAE,GAAY,EAAS,KAAc;QAAd,UAAK,GAAL,KAAK,CAAS;QAC/D,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACd,IAAI,GAAG,EAAE;YACP,IAAI,CAAC,IAAI,IAAI,GAAG,GAAG,GAAG,CAAC;SACxB;IACH,CAAC;IACD,IAAW,GAAG,KAAa,OAAO,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;;AAR1D,sCASC;;;AAED,MAAa,aAAc,SAAQ,sBAAS;IAG1C,YAAY,KAAgB,EAAE,EAAU,EAAE,KAAyB;QACjE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjB,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,GAAG,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAM,CAAC,iBAAiB,CAAC,IAAI,EAAE,uBAAuB,EAAE;YACzE,IAAI,EAAE,IAAI,CAAC,mBAAmB,CAAC,WAAW,CAAC;YAC3C,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,UAAU,IAAI,UAAU,CAAC;YAC7C,OAAO,EAAE,wBAAM,CAAC,OAAO,CAAC,eAAe;YACvC,OAAO,EAAE,WAAW;YACpB,WAAW,EAAE,KAAK,CAAC,WAAW;YAC9B,aAAa,EAAE,0BAA0B;YACzC,OAAO,EAAE,sBAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;YAC7B,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,UAAU,EAAE,WAAW;YACvB,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,cAAc,EAAE,KAAK,CAAC,cAAc;SACrC,CAAC,CAAC;QAEH,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,WAAW,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;SAAE;QAE7F,WAAW,CAAC,oBAAoB,CAC9B,IAAI,qBAAG,CAAC,eAAe,CAAC;YACtB,MAAM,EAAE,qBAAG,CAAC,MAAM,CAAC,KAAK;YACxB,OAAO,EAAE;gBACP,2BAA2B;gBAC3B,iCAAiC;gBACjC,4BAA4B;gBAC5B,yBAAyB;gBACzB,0BAA0B;gBAC1B,gBAAgB;gBAChB,oBAAoB;gBACpB,mBAAmB;gBACnB,yBAAyB;gBACzB,+BAA+B;gBAC/B,yBAAyB;gBACzB,qBAAqB;gBACrB,yBAAyB;gBACzB,cAAc;aACf;YACD,SAAS,EAAE,CAAC,GAAG,CAAC;SACjB,CAAC,CAAC,CAAC;QACN,WAAW,CAAC,oBAAoB,CAAC,IAAI,qBAAG,CAAC,eAAe,CAAC;YACvD,MAAM,EAAE,qBAAG,CAAC,MAAM,CAAC,KAAK;YACxB,OAAO,EAAE;gBACP,cAAc;aACf;YACD,SAAS,EAAE,CAAC,GAAG,CAAC;SACjB,CAAC,CAAC,CAAC;QAEJ,IAAI,4BAAc,CAAC,IAAI,EAAE,gBAAgB,EAAE;YACzC,YAAY,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW;YACtC,YAAY,EAAE,6BAA6B;YAC3C,UAAU,EAAE;gBACV,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG;gBACvB,QAAQ,EAAE,KAAK,CAAC,GAAG,CAAC,KAAK;gBACzB,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG;gBACzB,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK;aAC5B;SACF,CAAC,CAAC;IACL,CAAC;IAEM,oBAAoB,CAAC,SAA0B;QACpD,MAAM,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC;QACtC,IAAI,CAAC,WAAW,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC;SAAE;QAE7F,OAAO,WAAW,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;IACrD,CAAC;IAEO,mBAAmB,CAAC,WAAoB;QAC9C,IAAI,IAAI,GAAG,sCAAsC,CAAC;QAElD,0EAA0E;QAC1E,2EAA2E;QAC3E,4CAA4C;QAC5C,IAAI,WAAW,EAAE;YACf,IAAI,mBAAK,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE;gBACnC,MAAM,IAAI,KAAK,CAAC,mHAAmH,CAAC,CAAC;aACtI;YAED,IAAI,IAAI,IAAI,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC;SACzC;QAED,OAAO,IAAI,CAAC;IACd,CAAC;;AAvFH,sCAwFC","sourcesContent":["// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\n// SPDX-License-Identifier: Apache-2.0\n\n\nimport * as child_process from 'child_process';\nimport * as path from 'path';\nimport { aws_ec2 as ec2, aws_iam as iam, aws_lambda as lambda, Duration, CustomResource, Token } from 'aws-cdk-lib';\nimport { PolicyStatement, AddToPrincipalPolicyResult } from 'aws-cdk-lib/aws-iam';\nimport { Construct } from 'constructs';\nimport { shouldUsePrebuiltLambda } from './config';\n\nexport interface ECRDeploymentProps {\n\n  /**\n   * Image to use to build Golang lambda for custom resource, if download fails or is not wanted.\n   *\n   * Might be needed for local build if all images need to come from own registry.\n   *\n   * Note that image should use yum as a package manager and have golang available.\n   *\n   * @default public.ecr.aws/sam/build-go1.x:latest\n   */\n  readonly buildImage?: string;\n  /**\n   * The source of the docker image.\n   */\n  readonly src: IImageName;\n\n  /**\n   * The destination of the docker image.\n   */\n  readonly dest: IImageName;\n\n  /**\n   * The amount of memory (in MiB) to allocate to the AWS Lambda function which\n   * replicates the files from the CDK bucket to the destination bucket.\n   *\n   * If you are deploying large files, you will need to increase this number\n   * accordingly.\n   *\n   * @default 512\n   */\n  readonly memoryLimit?: number;\n\n  /**\n   * Execution role associated with this function\n   *\n   * @default - A role is automatically created\n   */\n  readonly role?: iam.IRole;\n\n  /**\n   * The VPC network to place the deployment lambda handler in.\n   *\n   * @default None\n   */\n  readonly vpc?: ec2.IVpc;\n\n  /**\n   * Where in the VPC to place the deployment lambda handler.\n   * Only used if 'vpc' is supplied.\n   *\n   * @default - the Vpc default strategy if not specified\n   */\n  readonly vpcSubnets?: ec2.SubnetSelection;\n\n  /**\n   * The list of security groups to associate with the Lambda's network interfaces.\n   *\n   * Only used if 'vpc' is supplied.\n   *\n   * @default - If the function is placed within a VPC and a security group is\n   * not specified, either by this or securityGroup prop, a dedicated security\n   * group will be created for this function.\n   */\n  readonly securityGroups?: ec2.SecurityGroup[];\n\n  /**\n   * The environment variable to set\n   */\n  readonly environment?: { [key: string]: string };\n}\n\nexport interface IImageName {\n  /**\n   *  The uri of the docker image.\n   *\n   *  The uri spec follows https://github.com/containers/skopeo\n   */\n  readonly uri: string;\n\n  /**\n   * The credentials of the docker image. Format `user:password` or `AWS Secrets Manager secret arn` or `AWS Secrets Manager secret name`\n   */\n  creds?: string;\n}\n\nfunction getCode(buildImage: string): lambda.AssetCode {\n  if (shouldUsePrebuiltLambda()) {\n    try {\n      const installScript = path.join(__dirname, '../lambda/install.js');\n      const prebuiltPath = path.join(__dirname, '../lambda/out');\n      child_process.execFileSync(process.argv0, [installScript, prebuiltPath]);\n\n      return lambda.Code.fromAsset(prebuiltPath);\n    } catch (err) {\n      console.warn(`Can not get prebuilt lambda: ${err}`);\n    }\n  }\n\n  return lambda.Code.fromDockerBuild(path.join(__dirname, '../lambda'), {\n    buildArgs: {\n      buildImage,\n    },\n  });\n}\n\nexport class DockerImageName implements IImageName {\n  public constructor(private name: string, public creds?: string) { }\n  public get uri(): string { return `docker://${this.name}`; }\n}\n\nexport class S3ArchiveName implements IImageName {\n  private name: string;\n  public constructor(p: string, ref?: string, public creds?: string) {\n    this.name = p;\n    if (ref) {\n      this.name += ':' + ref;\n    }\n  }\n  public get uri(): string { return `s3://${this.name}`; }\n}\n\nexport class ECRDeployment extends Construct {\n  private handler: lambda.SingletonFunction;\n\n  constructor(scope: Construct, id: string, props: ECRDeploymentProps) {\n    super(scope, id);\n    const memoryLimit = props.memoryLimit ?? 512;\n    this.handler = new lambda.SingletonFunction(this, 'CustomResourceHandler', {\n      uuid: this.renderSingletonUuid(memoryLimit),\n      code: getCode(props.buildImage ?? 'golang:1'),\n      runtime: lambda.Runtime.PROVIDED_AL2023,\n      handler: 'bootstrap',\n      environment: props.environment,\n      lambdaPurpose: 'Custom::CDKECRDeployment',\n      timeout: Duration.minutes(15),\n      role: props.role,\n      memorySize: memoryLimit,\n      vpc: props.vpc,\n      vpcSubnets: props.vpcSubnets,\n      securityGroups: props.securityGroups,\n    });\n\n    const handlerRole = this.handler.role;\n    if (!handlerRole) { throw new Error('lambda.SingletonFunction should have created a Role'); }\n\n    handlerRole.addToPrincipalPolicy(\n      new iam.PolicyStatement({\n        effect: iam.Effect.ALLOW,\n        actions: [\n          'ecr:GetAuthorizationToken',\n          'ecr:BatchCheckLayerAvailability',\n          'ecr:GetDownloadUrlForLayer',\n          'ecr:GetRepositoryPolicy',\n          'ecr:DescribeRepositories',\n          'ecr:ListImages',\n          'ecr:DescribeImages',\n          'ecr:BatchGetImage',\n          'ecr:ListTagsForResource',\n          'ecr:DescribeImageScanFindings',\n          'ecr:InitiateLayerUpload',\n          'ecr:UploadLayerPart',\n          'ecr:CompleteLayerUpload',\n          'ecr:PutImage',\n        ],\n        resources: ['*'],\n      }));\n    handlerRole.addToPrincipalPolicy(new iam.PolicyStatement({\n      effect: iam.Effect.ALLOW,\n      actions: [\n        's3:GetObject',\n      ],\n      resources: ['*'],\n    }));\n\n    new CustomResource(this, 'CustomResource', {\n      serviceToken: this.handler.functionArn,\n      resourceType: 'Custom::CDKBucketDeployment',\n      properties: {\n        SrcImage: props.src.uri,\n        SrcCreds: props.src.creds,\n        DestImage: props.dest.uri,\n        DestCreds: props.dest.creds,\n      },\n    });\n  }\n\n  public addToPrincipalPolicy(statement: PolicyStatement): AddToPrincipalPolicyResult {\n    const handlerRole = this.handler.role;\n    if (!handlerRole) { throw new Error('lambda.SingletonFunction should have created a Role'); }\n\n    return handlerRole.addToPrincipalPolicy(statement);\n  }\n\n  private renderSingletonUuid(memoryLimit?: number) {\n    let uuid = 'bd07c930-edb9-4112-a20f-03f096f53666';\n\n    // if user specify a custom memory limit, define another singleton handler\n    // with this configuration. otherwise, it won't be possible to use multiple\n    // configurations since we have a singleton.\n    if (memoryLimit) {\n      if (Token.isUnresolved(memoryLimit)) {\n        throw new Error('Can\\'t use tokens when specifying \"memoryLimit\" since we use it to identify the singleton custom resource handler');\n      }\n\n      uuid += `-${memoryLimit.toString()}MiB`;\n    }\n\n    return uuid;\n  }\n}\n"]}
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 19 Mar 2024 12:41:20 GMT
11
+ * Last updated: Sat, 30 Mar 2024 05:35:18 GMT
12
12
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
13
13
 
14
14
  # Credits
@@ -1,8 +1,8 @@
1
1
  /**
2
2
  * Clusters of Node.js processes can be used to run multiple instances of Node.js
3
- * that can distribute workloads among their application threads. When process
4
- * isolation is not needed, use the `worker_threads` module instead, which
5
- * allows running multiple application threads within a single Node.js instance.
3
+ * that can distribute workloads among their application threads. When process isolation
4
+ * is not needed, use the [`worker_threads`](https://nodejs.org/docs/latest-v20.x/api/worker_threads.html)
5
+ * module instead, which allows running multiple application threads within a single Node.js instance.
6
6
  *
7
7
  * The cluster module allows easy creation of child processes that all share
8
8
  * server ports.
@@ -50,7 +50,7 @@
50
50
  * ```
51
51
  *
52
52
  * On Windows, it is not yet possible to set up a named pipe server in a worker.
53
- * @see [source](https://github.com/nodejs/node/blob/v20.2.0/lib/cluster.js)
53
+ * @see [source](https://github.com/nodejs/node/blob/v20.11.1/lib/cluster.js)
54
54
  */
55
55
  declare module "cluster" {
56
56
  import * as child from "node:child_process";
@@ -58,22 +58,74 @@ declare module "cluster" {
58
58
  import * as net from "node:net";
59
59
  type SerializationType = "json" | "advanced";
60
60
  export interface ClusterSettings {
61
- execArgv?: string[] | undefined; // default: process.execArgv
61
+ /**
62
+ * List of string arguments passed to the Node.js executable.
63
+ * @default process.execArgv
64
+ */
65
+ execArgv?: string[] | undefined;
66
+ /**
67
+ * File path to worker file.
68
+ * @default process.argv[1]
69
+ */
62
70
  exec?: string | undefined;
71
+ /**
72
+ * String arguments passed to worker.
73
+ * @default process.argv.slice(2)
74
+ */
63
75
  args?: string[] | undefined;
76
+ /**
77
+ * Whether or not to send output to parent's stdio.
78
+ * @default false
79
+ */
64
80
  silent?: boolean | undefined;
81
+ /**
82
+ * Configures the stdio of forked processes. Because the cluster module relies on IPC to function, this configuration must
83
+ * contain an `'ipc'` entry. When this option is provided, it overrides `silent`. See [`child_prcess.spawn()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processspawncommand-args-options)'s
84
+ * [`stdio`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#optionsstdio).
85
+ */
65
86
  stdio?: any[] | undefined;
87
+ /**
88
+ * Sets the user identity of the process. (See [`setuid(2)`](https://man7.org/linux/man-pages/man2/setuid.2.html).)
89
+ */
66
90
  uid?: number | undefined;
91
+ /**
92
+ * Sets the group identity of the process. (See [`setgid(2)`](https://man7.org/linux/man-pages/man2/setgid.2.html).)
93
+ */
67
94
  gid?: number | undefined;
95
+ /**
96
+ * Sets inspector port of worker. This can be a number, or a function that takes no arguments and returns a number.
97
+ * By default each worker gets its own port, incremented from the primary's `process.debugPort`.
98
+ */
68
99
  inspectPort?: number | (() => number) | undefined;
100
+ /**
101
+ * Specify the kind of serialization used for sending messages between processes. Possible values are `'json'` and `'advanced'`.
102
+ * See [Advanced serialization for `child_process`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#advanced-serialization) for more details.
103
+ * @default false
104
+ */
69
105
  serialization?: SerializationType | undefined;
106
+ /**
107
+ * Current working directory of the worker process.
108
+ * @default undefined (inherits from parent process)
109
+ */
70
110
  cwd?: string | undefined;
111
+ /**
112
+ * Hide the forked processes console window that would normally be created on Windows systems.
113
+ * @default false
114
+ */
71
115
  windowsHide?: boolean | undefined;
72
116
  }
73
117
  export interface Address {
74
118
  address: string;
75
119
  port: number;
76
- addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6"
120
+ /**
121
+ * The `addressType` is one of:
122
+ *
123
+ * * `4` (TCPv4)
124
+ * * `6` (TCPv6)
125
+ * * `-1` (Unix domain socket)
126
+ * * `'udp4'` or `'udp6'` (UDPv4 or UDPv6)
127
+ */
128
+ addressType: 4 | 6 | -1 | "udp4" | "udp6";
77
129
  }
78
130
  /**
79
131
  * A `Worker` object contains all public information and method about a worker.
@@ -83,17 +135,17 @@ declare module "cluster" {
83
135
  */
84
136
  export class Worker extends EventEmitter {
85
137
  /**
86
- * Each new worker is given its own unique id, this id is stored in the`id`.
138
+ * Each new worker is given its own unique id, this id is stored in the `id`.
87
139
  *
88
- * While a worker is alive, this is the key that indexes it in`cluster.workers`.
140
+ * While a worker is alive, this is the key that indexes it in `cluster.workers`.
89
141
  * @since v0.8.0
90
142
  */
91
143
  id: number;
92
144
  /**
93
- * All workers are created using `child_process.fork()`, the returned object
94
- * from this function is stored as `.process`. In a worker, the global `process`is stored.
145
+ * All workers are created using [`child_process.fork()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options), the returned object
146
+ * from this function is stored as `.process`. In a worker, the global `process` is stored.
95
147
  *
96
- * See: `Child Process module`.
148
+ * See: [Child Process module](https://nodejs.org/docs/latest-v20.x/api/child_process.html#child_processforkmodulepath-args-options).
97
149
  *
98
150
  * Workers will call `process.exit(0)` if the `'disconnect'` event occurs
99
151
  * on `process` and `.exitedAfterDisconnect` is not `true`. This protects against
@@ -104,9 +156,9 @@ declare module "cluster" {
104
156
  /**
105
157
  * Send a message to a worker or primary, optionally with a handle.
106
158
  *
107
- * In the primary, this sends a message to a specific worker. It is identical to `ChildProcess.send()`.
159
+ * In the primary, this sends a message to a specific worker. It is identical to [`ChildProcess.send()`](https://nodejs.org/docs/latest-v20.x/api/child_process.html#subprocesssendmessage-sendhandle-options-callback).
108
160
  *
109
- * In a worker, this sends a message to the primary. It is identical to`process.send()`.
161
+ * In a worker, this sends a message to the primary. It is identical to `process.send()`.
110
162
  *
111
163
  * This example will echo back all messages from the primary:
112
164
  *
@@ -122,7 +174,7 @@ declare module "cluster" {
122
174
  * }
123
175
  * ```
124
176
  * @since v0.7.0
125
- * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles. `options` supports the following properties:
177
+ * @param options The `options` argument, if present, is an object used to parameterize the sending of certain types of handles.
126
178
  */
127
179
  send(message: child.Serializable, callback?: (error: Error | null) => void): boolean;
128
180
  send(
@@ -138,7 +190,7 @@ declare module "cluster" {
138
190
  ): boolean;
139
191
  /**
140
192
  * This function will kill the worker. In the primary worker, it does this by
141
- * disconnecting the `worker.process`, and once disconnected, killing with`signal`. In the worker, it does it by killing the process with `signal`.
193
+ * disconnecting the `worker.process`, and once disconnected, killing with `signal`. In the worker, it does it by killing the process with `signal`.
142
194
  *
143
195
  * The `kill()` function kills the worker process without waiting for a graceful
144
196
  * disconnect, it has the same behavior as `worker.process.kill()`.
@@ -146,7 +198,7 @@ declare module "cluster" {
146
198
  * This method is aliased as `worker.destroy()` for backwards compatibility.
147
199
  *
148
200
  * In a worker, `process.kill()` exists, but it is not this function;
149
- * it is `kill()`.
201
+ * it is [`kill()`](https://nodejs.org/docs/latest-v20.x/api/process.html#processkillpid-signal).
150
202
  * @since v0.9.12
151
203
  * @param [signal='SIGTERM'] Name of the kill signal to send to the worker process.
152
204
  */
@@ -156,7 +208,7 @@ declare module "cluster" {
156
208
  * In a worker, this function will close all servers, wait for the `'close'` event
157
209
  * on those servers, and then disconnect the IPC channel.
158
210
  *
159
- * In the primary, an internal message is sent to the worker causing it to call`.disconnect()` on itself.
211
+ * In the primary, an internal message is sent to the worker causing it to call `.disconnect()` on itself.
160
212
  *
161
213
  * Causes `.exitedAfterDisconnect` to be set.
162
214
  *
@@ -336,20 +388,114 @@ declare module "cluster" {
336
388
  }
337
389
  export interface Cluster extends EventEmitter {
338
390
  disconnect(callback?: () => void): void;
391
+ /**
392
+ * Spawn a new worker process.
393
+ *
394
+ * This can only be called from the primary process.
395
+ * @param env Key/value pairs to add to worker process environment.
396
+ * @since v0.6.0
397
+ */
339
398
  fork(env?: any): Worker;
340
399
  /** @deprecated since v16.0.0 - use isPrimary. */
341
400
  readonly isMaster: boolean;
401
+ /**
402
+ * True if the process is a primary. This is determined by the `process.env.NODE_UNIQUE_ID`. If `process.env.NODE_UNIQUE_ID`
403
+ * is undefined, then `isPrimary` is `true`.
404
+ * @since v16.0.0
405
+ */
342
406
  readonly isPrimary: boolean;
407
+ /**
408
+ * True if the process is not a primary (it is the negation of `cluster.isPrimary`).
409
+ * @since v0.6.0
410
+ */
343
411
  readonly isWorker: boolean;
412
+ /**
413
+ * The scheduling policy, either `cluster.SCHED_RR` for round-robin or `cluster.SCHED_NONE` to leave it to the operating system. This is a
414
+ * global setting and effectively frozen once either the first worker is spawned, or [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
415
+ * is called, whichever comes first.
416
+ *
417
+ * `SCHED_RR` is the default on all operating systems except Windows. Windows will change to `SCHED_RR` once libuv is able to effectively distribute
418
+ * IOCP handles without incurring a large performance hit.
419
+ *
420
+ * `cluster.schedulingPolicy` can also be set through the `NODE_CLUSTER_SCHED_POLICY` environment variable. Valid values are `'rr'` and `'none'`.
421
+ * @since v0.11.2
422
+ */
344
423
  schedulingPolicy: number;
424
+ /**
425
+ * After calling [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings)
426
+ * (or [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)) this settings object will contain
427
+ * the settings, including the default values.
428
+ *
429
+ * This object is not intended to be changed or set manually.
430
+ * @since v0.7.1
431
+ */
345
432
  readonly settings: ClusterSettings;
346
- /** @deprecated since v16.0.0 - use setupPrimary. */
433
+ /** @deprecated since v16.0.0 - use [`.setupPrimary()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clustersetupprimarysettings) instead. */
347
434
  setupMaster(settings?: ClusterSettings): void;
348
435
  /**
349
- * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in cluster.settings.
436
+ * `setupPrimary` is used to change the default 'fork' behavior. Once called, the settings will be present in `cluster.settings`.
437
+ *
438
+ * Any settings changes only affect future calls to [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv)
439
+ * and have no effect on workers that are already running.
440
+ *
441
+ * The only attribute of a worker that cannot be set via `.setupPrimary()` is the `env` passed to
442
+ * [`.fork()`](https://nodejs.org/docs/latest-v20.x/api/cluster.html#clusterforkenv).
443
+ *
444
+ * The defaults above apply to the first call only; the defaults for later calls are the current values at the time of
445
+ * `cluster.setupPrimary()` is called.
446
+ *
447
+ * ```js
448
+ * import cluster from 'node:cluster';
449
+ *
450
+ * cluster.setupPrimary({
451
+ * exec: 'worker.js',
452
+ * args: ['--use', 'https'],
453
+ * silent: true,
454
+ * });
455
+ * cluster.fork(); // https worker
456
+ * cluster.setupPrimary({
457
+ * exec: 'worker.js',
458
+ * args: ['--use', 'http'],
459
+ * });
460
+ * cluster.fork(); // http worker
461
+ * ```
462
+ *
463
+ * This can only be called from the primary process.
464
+ * @since v16.0.0
350
465
  */
351
466
  setupPrimary(settings?: ClusterSettings): void;
467
+ /**
468
+ * A reference to the current worker object. Not available in the primary process.
469
+ *
470
+ * ```js
471
+ * import cluster from 'node:cluster';
472
+ *
473
+ * if (cluster.isPrimary) {
474
+ * console.log('I am primary');
475
+ * cluster.fork();
476
+ * cluster.fork();
477
+ * } else if (cluster.isWorker) {
478
+ * console.log(`I am worker #${cluster.worker.id}`);
479
+ * }
480
+ * ```
481
+ * @since v0.7.0
482
+ */
352
483
  readonly worker?: Worker | undefined;
484
+ /**
485
+ * A hash that stores the active worker objects, keyed by `id` field. This makes it easy to loop through all the workers. It is only available in the primary process.
486
+ *
487
+ * A worker is removed from `cluster.workers` after the worker has disconnected _and_ exited. The order between these two events cannot be determined in advance. However, it
488
+ * is guaranteed that the removal from the `cluster.workers` list happens before the last `'disconnect'` or `'exit'` event is emitted.
489
+ *
490
+ * ```js
491
+ * import cluster from 'node:cluster';
492
+ *
493
+ * for (const worker of Object.values(cluster.workers)) {
494
+ * worker.send('big announcement to all workers');
495
+ * }
496
+ * ```
497
+ * @since v0.7.0
498
+ */
353
499
  readonly workers?: NodeJS.Dict<Worker> | undefined;
354
500
  readonly SCHED_NONE: number;
355
501
  readonly SCHED_RR: number;
@@ -89,6 +89,8 @@ interface AddEventListenerOptions extends EventListenerOptions {
89
89
  once?: boolean;
90
90
  /** When `true`, serves as a hint that the listener will not call the `Event` object's `preventDefault()` method. Default: false. */
91
91
  passive?: boolean;
92
+ /** The listener will be removed when the given AbortSignal object's `abort()` method is called. */
93
+ signal?: AbortSignal;
92
94
  }
93
95
 
94
96
  interface EventListener {
@@ -75,10 +75,6 @@ declare module "events" {
75
75
  */
76
76
  captureRejections?: boolean | undefined;
77
77
  }
78
- // Any EventTarget with a Node-style `once` function
79
- interface _NodeEventTarget {
80
- once(eventName: string | symbol, listener: (...args: any[]) => void): this;
81
- }
82
78
  // Any EventTarget with a DOM-style `addEventListener`
83
79
  interface _DOMEventTarget {
84
80
  addEventListener(
@@ -208,7 +204,7 @@ declare module "events" {
208
204
  * @since v11.13.0, v10.16.0
209
205
  */
210
206
  static once(
211
- emitter: _NodeEventTarget,
207
+ emitter: NodeJS.EventEmitter,
212
208
  eventName: string | symbol,
213
209
  options?: StaticEventEmitterOptions,
214
210
  ): Promise<any[]>;
@@ -720,7 +716,7 @@ declare module "events" {
720
716
  * Returns a reference to the `EventEmitter`, so that calls can be chained.
721
717
  * @since v0.1.26
722
718
  */
723
- removeAllListeners(event?: Key<unknown, T>): this;
719
+ removeAllListeners(eventName?: Key<unknown, T>): this;
724
720
  /**
725
721
  * By default `EventEmitter`s will print a warning if more than `10` listeners are
726
722
  * added for a particular event. This is a useful default that helps finding
@@ -1008,6 +1008,12 @@ declare module "fs/promises" {
1008
1008
  | (ObjectEncodingOptions & {
1009
1009
  mode?: Mode | undefined;
1010
1010
  flag?: OpenMode | undefined;
1011
+ /**
1012
+ * If all data is successfully written to the file, and `flush`
1013
+ * is `true`, `filehandle.sync()` is used to flush the data.
1014
+ * @default false
1015
+ */
1016
+ flush?: boolean | undefined;
1011
1017
  } & Abortable)
1012
1018
  | BufferEncoding
1013
1019
  | null,
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@types/node",
3
- "version": "20.11.30",
3
+ "version": "20.12.2",
4
4
  "description": "TypeScript definitions for node",
5
5
  "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node",
6
6
  "license": "MIT",
@@ -212,6 +212,6 @@
212
212
  "dependencies": {
213
213
  "undici-types": "~5.26.4"
214
214
  },
215
- "typesPublisherContentHash": "f32598ce514dab7b6619466fa574d45c878183cb69f626de9a4ba7676000d809",
215
+ "typesPublisherContentHash": "87dfc7f77cdee3468250d81c9d0a1affd373ef091004a961696e12cd422beb71",
216
216
  "typeScriptVersion": "4.7"
217
217
  }
@@ -1044,6 +1044,21 @@ declare module "process" {
1044
1044
  * @param [signal='SIGTERM'] The signal to send, either as a string or number.
1045
1045
  */
1046
1046
  kill(pid: number, signal?: string | number): true;
1047
+ /**
1048
+ * Loads the environment configuration from a `.env` file into `process.env`. If
1049
+ * the file is not found, error will be thrown.
1050
+ *
1051
+ * To load a specific .env file by specifying its path, use the following code:
1052
+ *
1053
+ * ```js
1054
+ * import { loadEnvFile } from 'node:process';
1055
+ *
1056
+ * loadEnvFile('./development.env')
1057
+ * ```
1058
+ * @since v20.12.0
1059
+ * @param path The path to the .env file
1060
+ */
1061
+ loadEnvFile(path?: string | URL | Buffer): void;
1047
1062
  /**
1048
1063
  * The `process.pid` property returns the PID of the process.
1049
1064
  *
@@ -8,7 +8,7 @@ This package contains type definitions for node (https://nodejs.org/).
8
8
  Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/node.
9
9
 
10
10
  ### Additional Details
11
- * Last updated: Tue, 19 Mar 2024 12:41:20 GMT
11
+ * Last updated: Sat, 30 Mar 2024 05:35:18 GMT
12
12
  * Dependencies: [undici-types](https://npmjs.com/package/undici-types)
13
13
 
14
14
  # Credits