diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2a7567e8d64bb..73d9f197c5c1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -352,8 +352,8 @@ assertions against the deployed infrastructure. ``` Examples: -* [integ.destinations.ts](https://github.com/aws/aws-cdk/blob/master/packages/%40aws-cdk/aws-lambda-destinations/test/integ.destinations.ts#L7) -* [integ.put-events.ts](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-stepfunctions-tasks/test/eventbridge/integ.put-events.ts) +* [integ.destinations.ts](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/framework-integ/test/aws-lambda-destinations/test/integ.destinations.ts#L7) +* [integ.put-events.ts](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/framework-integ/test/aws-stepfunctions-tasks/test/eventbridge/integ.put-events.ts) **What if you cannot run integration tests** diff --git a/INTEGRATION_TESTS.md b/INTEGRATION_TESTS.md index 4fe9318f5b720..9c00ed4ef5026 100644 --- a/INTEGRATION_TESTS.md +++ b/INTEGRATION_TESTS.md @@ -49,8 +49,8 @@ an integration test for the new feature can ensure that it works and avoid unnec **3. Involves configuring resource types across services (i.e. integrations)** For example, you are adding functionality that allows for service x to integrate with service y. -A good example of this is the [aws-stepfunctions-tasks](./packages/@aws-cdk/aws-stepfunctions-tasks) or -[aws-apigatewayv2-integrations](./packages/@aws-cdk/aws-apigatewayv2-integrations) modules. Both of these +A good example of this is the [aws-stepfunctions-tasks](./packages/aws-cdk-lib/aws-stepfunctions-tasks) or +[aws-apigatewayv2-integrations-alpha](./packages/@aws-cdk/aws-apigatewayv2-integrations-alpha) modules. Both of these have L2 constructs that provide functionality to integrate services. Sometimes these integrations involve configuring/formatting json/vtl or some other type of data. @@ -82,8 +82,8 @@ Lambda Function would look like this: _integ.lambda.ts_ ```ts -import * as iam from '@aws-cdk/aws-iam'; -import * as cdk from '@aws-cdk/core'; +import * as iam from 'aws-cdk-lib/aws-iam'; +import * as cdk from 'aws-cdk-lib/core'; import * as lambda from '../lib'; import * as integ from '@aws-cdk/integ-tests-alpha'; @@ -230,11 +230,11 @@ to deploy the Lambda Function _and_ then rerun the assertions to ensure that the ### Assertions Sometimes it is necessary to perform some form of _assertion_ against the deployed infrastructure to validate that the -test succeeds. A good example of this is the `@aws-cdk/aws-stepfunctions-tasks` module which creates integrations between +test succeeds. A good example of this is the `aws-cdk-lib/aws-stepfunctions-tasks` module which creates integrations between AWS StepFunctions and other AWS services. -If we look at the [integ.put-events.ts](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-stepfunctions-tasks/test/eventbridge/integ.put-events.ts) -integration test we can see that we are creating an `@aws-cdk/aws-events.EventBus` along with a `@aws-cdk/aws-stepfunctions.StateMachine` +If we look at the [integ.put-events.ts](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk-testing/framework-integ/test/aws-stepfunctions-tasks/test/eventbridge/integ.put-events.ts) +integration test we can see that we are creating an `aws-cdk-lib/aws-events.EventBus` along with a `aws-cdk-lib/aws-stepfunctions.StateMachine` which will send an event to the `EventBus`. In a typical integration test we would just deploy the test and the fact that the infrastructure deployed successfully would be enough of a validation that the test succeeded. In this case though, we ideally want to validate that the _integration_ connecting `StepFunctions` to the `EventBus` has been setup correctly, and the only @@ -269,8 +269,8 @@ Not every test requires an assertion. We typically do not need to assert CloudFo with Encryption, we do not need to assert that Encryption is set on the bucket. We can trust that the CloudFormation behavior works. Some things you should look for in deciding if the test needs an assertion: -- Integrations between services (i.e. integration libraries like `@aws-cdk/aws-lambda-destinations`, `@aws-cdk/aws-stepfunctions-tasks`, etc) -- Anything that bundles or deploys custom code (i.e. does a Lambda function bundled with `@aws-cdk/aws-lambda-nodejs` still invoke or did we break bundling behavior) +- Integrations between services (i.e. integration libraries like `aws-cdk-lib/aws-lambda-destinations`, `aws-cdk-lib/aws-stepfunctions-tasks`, etc) +- Anything that bundles or deploys custom code (i.e. does a Lambda function bundled with `aws-cdk-lib/aws-lambda-nodejs` still invoke or did we break bundling behavior) - IAM/Networking connections. - This one is a bit of a judgement call. Most things do not need assertions, but sometimes we handle complicated configurations involving IAM permissions or Networking access. diff --git a/design/aws-ecs/aws-ecs-fargate-capacity-providers.md b/design/aws-ecs/aws-ecs-fargate-capacity-providers.md index 9ee1ea6a93bac..47f638d41198f 100644 --- a/design/aws-ecs/aws-ecs-fargate-capacity-providers.md +++ b/design/aws-ecs/aws-ecs-fargate-capacity-providers.md @@ -103,11 +103,11 @@ This new field would be added to the BaseService, not only for better extensibil Implications Setting Launch Type -Since it can be reasonably assumed that any CapacityProvideStrategies defined on the Service are what the customer intends to use on the Service, the LaunchType will *not* be set on the Service if CapacityProvideStrategies are specified. This is similar to how the LaunchType field is unset if the service uses an external DeploymentController (https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-ecs/lib/base/base-service.ts#L374). +Since it can be reasonably assumed that any CapacityProvideStrategies defined on the Service are what the customer intends to use on the Service, the LaunchType will *not* be set on the Service if CapacityProvideStrategies are specified. This is similar to how the LaunchType field is unset if the service uses an external DeploymentController (https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ecs/lib/base/base-service.ts#L587). On the other hand, this intent would not be as obvious with Default Capacity Provider Strategies defined a cluster. A *defaultCapacityProviderStrategy* specified on a cluster is used for any service that does not specify either a launchType or its own CapacityProviderStrategies. From the point of view of the ECS APIs, similar to how custom CapacityProvideStrategies defined on the Service are expected to supersede the defaultCapacityProviderStrategy on a cluster, the expected behavior for an ECS Service that specifies a launchType is for it to also ignore the Cluster’s defaultCapacityProviderStrategy. -However, since the two Service constructs in the CDK (Ec2Service and FargateService) do not support having the launchType field passed in explicitly, it would not possible to infer whether the intent of the customer using one of these Service constructs is to use the implied launchType (currently set under the hood in the service’s constructor (https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-ecs/lib/fargate/fargate-service.ts#L155)) or the defaultCapacityProviderStrategy. For this reason, we will not be adding the defaultCapacityProviderStrategy field on the Cluster construct for this iteration. +However, since the two Service constructs in the CDK (Ec2Service and FargateService) do not support having the launchType field passed in explicitly, it would not possible to infer whether the intent of the customer using one of these Service constructs is to use the implied launchType (currently set under the hood in the service’s constructor (https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ecs/lib/fargate/fargate-service.ts#L134) or the defaultCapacityProviderStrategy. For this reason, we will not be adding the defaultCapacityProviderStrategy field on the Cluster construct for this iteration. _*Note*_: Future for support will be dependent on a re-design of the existing Service strategies. This will be treated in v2 of the ECS modules, likely with a single Service L2 construct and deprecation of the Ec2Service and FargateService constructs. diff --git a/design/aws-ecs/aws-ecs-priv-registry-support.md b/design/aws-ecs/aws-ecs-priv-registry-support.md index 4f017e6cf160d..8b4b4e63c8450 100644 --- a/design/aws-ecs/aws-ecs-priv-registry-support.md +++ b/design/aws-ecs/aws-ecs-priv-registry-support.md @@ -2,11 +2,11 @@ To address issue [#1698](https://github.com/aws/aws-cdk/issues/1698), the ECS construct library should provide a way for customers to specify [`repositoryCredentials`](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_ContainerDefinition.html#ECS-Type-ContainerDefinition-repositoryCredentials) on their container. -Minimally, this would mean adding a new string field on `ContainerDefinition`, however this doesn't provide any added value in terms of logical grouping or resource creation. We can instead modify the existing ECS CDK construct [`ContainerImage`](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-ecs/lib/container-image.ts) so that repository credentials are specified along with the image they're meant to access. +Minimally, this would mean adding a new string field on `ContainerDefinition`, however this doesn't provide any added value in terms of logical grouping or resource creation. We can instead modify the existing ECS CDK construct [`ContainerImage`](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts) so that repository credentials are specified along with the image they're meant to access. ## General approach -The [`ecs.ContainerImage`](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-ecs/lib/container-image.ts) class already includes constructs for 3 types of images: +The [`ecs.ContainerImage`](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-ecs/lib/container-image.ts) class already includes constructs for 3 types of images: * DockerHubImage * EcrImage diff --git a/docs/DESIGN_GUIDELINES.md b/docs/DESIGN_GUIDELINES.md index 7e380dda67efb..1647ad658714a 100644 --- a/docs/DESIGN_GUIDELINES.md +++ b/docs/DESIGN_GUIDELINES.md @@ -193,7 +193,7 @@ exist in the CDK will be removed in the next CDK major version (CDKv2). AWS resources are organized into modules based on their AWS service. For example, the "Bucket" resource, which is offered by the Amazon S3 service will -be available under the **@aws-cdk/aws-s3** module. We will use the “aws-” prefix +be available under the **aws-cdk-lib/aws-s3** module. We will use the “aws-” prefix for all AWS services, regardless of whether their marketing name uses an “Amazon” prefix (e.g. “Amazon S3”). Non-AWS services supported by AWS CloudFormation (like the Alexa::ASK namespace) will be **@aws-cdk/alexa-ask**. @@ -203,13 +203,13 @@ consistent with the AWS SDKs and AWS CloudFormation _[awslint:module-name]_. All major versions of an AWS namespace will be mastered in the AWS Construct Library under the root namespace. For example resources of the **ApiGatewayV2** -namespace will be available under the **@aws-cdk/aws-apigateway** module (and +namespace will be available under the **aws-cdk-lib/aws-apigateway** module (and not under “v2) _[awslint:module-v2]_. In some cases, it makes sense to introduce secondary modules for a certain service (e.g. aws-s3-notifications, aws-lambda-event-sources, etc). The name of the secondary module will be -**@aws-cdk/aws-xxx-\**_[awslint:module-secondary]_. +**aws-cdk-lib/aws-xxx-\**_[awslint:module-secondary]_. Documentation for how to use secondary modules should be in the main module. The README file should refer users to the central module diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.ts index 8c6235a52c782..d87824ecf37fd 100644 --- a/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.ts +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.alarm-and-dashboard.ts @@ -1,6 +1,6 @@ // Integration test to deploy some resources, create an alarm on it and create a dashboard. // -// Because literally every other library is going to depend on @aws-cdk/aws-cloudwatch, we drop down +// Because literally every other library is going to depend on aws-cdk-lib/aws-cloudwatch, we drop down // to the very lowest level to create CloudFormation resources by hand, without even generated // library support. diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.math-alarm-and-dashboard.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.math-alarm-and-dashboard.ts index c3dd931dc0f43..60d97835b9d39 100644 --- a/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.math-alarm-and-dashboard.ts +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-cloudwatch/test/integ.math-alarm-and-dashboard.ts @@ -1,6 +1,6 @@ // Integration test to deploy some resources, create an alarm on it and create a dashboard. // -// Because literally every other library is going to depend on @aws-cdk/aws-cloudwatch, we drop down +// Because literally every other library is going to depend on aws-cdk-lib/aws-cloudwatch, we drop down // to the very lowest level to create CloudFormation resources by hand, without even generated // library support. diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-codecommit/test/integ.codecommit-events.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-codecommit/test/integ.codecommit-events.ts index a895a4e9782f8..9d67a54c38ef8 100644 --- a/packages/@aws-cdk-testing/framework-integ/test/aws-codecommit/test/integ.codecommit-events.ts +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-codecommit/test/integ.codecommit-events.ts @@ -10,7 +10,7 @@ const repo = new codecommit.Repository(stack, 'Repo', { }); const topic = new sns.Topic(stack, 'MyTopic'); -// we can't use @aws-cdk/aws-events-targets.SnsTopic here because it will +// we can't use aws-cdk-lib/aws-events-targets.SnsTopic here because it will // create a cyclic dependency with codebuild, so we just fake it repo.onReferenceCreated('OnReferenceCreated', { target: { diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster-ipv6.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster-ipv6.ts index 51018eb3671c8..2c3f6653534b3 100644 --- a/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster-ipv6.ts +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster-ipv6.ts @@ -350,7 +350,7 @@ class EksClusterStack extends Stack { } // this test uses both the bottlerocket image and the inf1 instance, which are only supported in these -// regions. see https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-eks#bottlerocket +// regions. see https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-eks#bottlerocket // and https://aws.amazon.com/about-aws/whats-new/2019/12/introducing-amazon-ec2-inf1-instances-high-performance-and-the-lowest-cost-machine-learning-inference-in-the-cloud/ const supportedRegions = [ 'us-east-1', diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster.ts index 404bed8a4fea8..161e066a26819 100644 --- a/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster.ts +++ b/packages/@aws-cdk-testing/framework-integ/test/aws-eks/test/integ.eks-cluster.ts @@ -323,7 +323,7 @@ class EksClusterStack extends Stack { } // this test uses both the bottlerocket image and the inf1 instance, which are only supported in these -// regions. see https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-eks#bottlerocket +// regions. see https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-eks#bottlerocket // and https://aws.amazon.com/about-aws/whats-new/2019/12/introducing-amazon-ec2-inf1-instances-high-performance-and-the-lowest-cost-machine-learning-inference-in-the-cloud/ const supportedRegions = [ 'us-east-1', diff --git a/packages/@aws-cdk/aws-apigatewayv2-alpha/README.md b/packages/@aws-cdk/aws-apigatewayv2-alpha/README.md index a70c78b5b4e67..d4d142e830c02 100644 --- a/packages/@aws-cdk/aws-apigatewayv2-alpha/README.md +++ b/packages/@aws-cdk/aws-apigatewayv2-alpha/README.md @@ -44,7 +44,7 @@ As an API Gateway API developer, you can create APIs for use in your own client This module supports features under [API Gateway v2](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_ApiGatewayV2.html) that lets users set up Websocket and HTTP APIs. -REST APIs can be created using the `@aws-cdk/aws-apigateway` module. +REST APIs can be created using the `aws-cdk-lib/aws-apigateway` module. ## HTTP API diff --git a/packages/@aws-cdk/aws-iot-actions-alpha/README.md b/packages/@aws-cdk/aws-iot-actions-alpha/README.md index 5a117ef5f851e..cd5814022cb49 100644 --- a/packages/@aws-cdk/aws-iot-actions-alpha/README.md +++ b/packages/@aws-cdk/aws-iot-actions-alpha/README.md @@ -17,7 +17,7 @@ This library contains integration classes to send data to any number of supported AWS Services. Instances of these classes should be passed to -`TopicRule` defined in `@aws-cdk/aws-iot`. +`TopicRule` defined in `aws-cdk-lib/aws-iot`. Currently supported are: diff --git a/packages/@aws-cdk/aws-iot-alpha/README.md b/packages/@aws-cdk/aws-iot-alpha/README.md index 036c1b8147e55..14ae62f9676f2 100644 --- a/packages/@aws-cdk/aws-iot-alpha/README.md +++ b/packages/@aws-cdk/aws-iot-alpha/README.md @@ -76,4 +76,4 @@ new iot.TopicRule(this, 'TopicRule', { }); ``` -See also [@aws-cdk/aws-iot-actions](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-iot-actions-readme.html) for other actions. +See also [@aws-cdk/aws-iot-actions-alpha](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-iot-actions-alpha-readme.html) for other actions. diff --git a/packages/@aws-cdk/aws-iotevents-actions-alpha/README.md b/packages/@aws-cdk/aws-iotevents-actions-alpha/README.md index 95a866690b2a8..2e9f23eb4b5f8 100644 --- a/packages/@aws-cdk/aws-iotevents-actions-alpha/README.md +++ b/packages/@aws-cdk/aws-iotevents-actions-alpha/README.md @@ -15,8 +15,8 @@ -This library contains integration classes to specify actions of state events of Detector Model in `@aws-cdk/aws-iotevents`. -Instances of these classes should be passed to `State` defined in `@aws-cdk/aws-iotevents` +This library contains integration classes to specify actions of state events of Detector Model in `@aws-cdk/aws-iotevents-alpha`. +Instances of these classes should be passed to `State` defined in `@aws-cdk/aws-iotevents-alpha` You can define built-in actions to use a timer or set a variable, or send data to other AWS resources. This library contains integration classes to use a timer or set a variable, or send data to other AWS resources. diff --git a/packages/@aws-cdk/aws-iotevents-alpha/README.md b/packages/@aws-cdk/aws-iotevents-alpha/README.md index e5346fa3ebf97..80d748f07f8ba 100644 --- a/packages/@aws-cdk/aws-iotevents-alpha/README.md +++ b/packages/@aws-cdk/aws-iotevents-alpha/README.md @@ -27,7 +27,7 @@ The detector model need a reference to at least one AWS IoT Events input. AWS IoT Events inputs enable the detector to get MQTT payload values from IoT Core rules. You can define built-in actions to use a timer or set a variable, or send data to other AWS resources. -See also [@aws-cdk/aws-iotevents-actions](https://docs.aws.amazon.com/cdk/api/v1/docs/aws-iotevents-actions-readme.html) for other actions. +See also [@aws-cdk/aws-iotevents-actions-alpha](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-iotevents-actions-alpha-readme.html) for other actions. ```ts import * as iotevents from '@aws-cdk/aws-iotevents-alpha'; diff --git a/packages/@aws-cdk/aws-kinesisfirehose-alpha/README.md b/packages/@aws-cdk/aws-kinesisfirehose-alpha/README.md index 564844bcfdb2b..d842a54cbae3a 100644 --- a/packages/@aws-cdk/aws-kinesisfirehose-alpha/README.md +++ b/packages/@aws-cdk/aws-kinesisfirehose-alpha/README.md @@ -498,7 +498,7 @@ Conversely to the above, Kinesis Data Firehose requires permissions in order for streams to interact with resources that you own. For example, if an S3 bucket is specified as a destination of a delivery stream, the delivery stream must be granted permissions to put and get objects from the bucket. When using the built-in AWS service destinations -found in the `@aws-cdk/aws-kinesisfirehose-destinations` module, the CDK grants the +found in the `@aws-cdk/aws-kinesisfirehose-destinations-alpha` module, the CDK grants the permissions automatically. However, custom or third-party destinations may require custom permissions. In this case, use the delivery stream as an `IGrantable`, as follows: diff --git a/packages/@aws-cdk/aws-lambda-go-alpha/README.md b/packages/@aws-cdk/aws-lambda-go-alpha/README.md index 530f3b56cf143..40ffa67b0dfd7 100644 --- a/packages/@aws-cdk/aws-lambda-go-alpha/README.md +++ b/packages/@aws-cdk/aws-lambda-go-alpha/README.md @@ -99,7 +99,7 @@ generally fall into two scenarios: If you are not vendoring then `go build` will be run without `-mod=vendor` since the default behavior is to download dependencies -All other properties of `lambda.Function` are supported, see also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda). +All other properties of `lambda.Function` are supported, see also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-lambda). ## Environment diff --git a/packages/@aws-cdk/aws-lambda-go-alpha/lib/types.ts b/packages/@aws-cdk/aws-lambda-go-alpha/lib/types.ts index 33b999215e6fe..c1d714bc130d6 100644 --- a/packages/@aws-cdk/aws-lambda-go-alpha/lib/types.ts +++ b/packages/@aws-cdk/aws-lambda-go-alpha/lib/types.ts @@ -15,7 +15,7 @@ export interface BundlingOptions extends DockerRunOptions { /** * A custom bundling Docker image. * - * @default - use the Docker image provided by @aws-cdk/aws-lambda-go + * @default - use the Docker image provided by @aws-cdk/aws-lambda-go-alpha */ readonly dockerImage?: DockerImage; diff --git a/packages/@aws-cdk/aws-lambda-python-alpha/README.md b/packages/@aws-cdk/aws-lambda-python-alpha/README.md index e02462e6e9ea3..26e90adce5aab 100644 --- a/packages/@aws-cdk/aws-lambda-python-alpha/README.md +++ b/packages/@aws-cdk/aws-lambda-python-alpha/README.md @@ -33,7 +33,7 @@ new python.PythonFunction(this, 'MyFunction', { }); ``` -All other properties of `lambda.Function` are supported, see also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda). +All other properties of `lambda.Function` are supported, see also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-lambda). ## Python Layer diff --git a/packages/@aws-cdk/aws-neptune-alpha/README.md b/packages/@aws-cdk/aws-neptune-alpha/README.md index 60a8f920fcdc3..d35035ab44979 100644 --- a/packages/@aws-cdk/aws-neptune-alpha/README.md +++ b/packages/@aws-cdk/aws-neptune-alpha/README.md @@ -17,7 +17,7 @@ Amazon Neptune is a fast, reliable, fully managed graph database service that makes it easy to build and run applications that work with highly connected datasets. The core of Neptune is a purpose-built, high-performance graph database engine. This engine is optimized for storing billions of relationships and querying the graph with milliseconds latency. Neptune supports the popular graph query languages Apache TinkerPop Gremlin and W3C’s SPARQL, enabling you to build queries that efficiently navigate highly connected datasets. -The `@aws-cdk/aws-neptune` package contains primitives for setting up Neptune database clusters and instances. +The `@aws-cdk/aws-neptune-alpha` package contains primitives for setting up Neptune database clusters and instances. ```ts nofixture import * as neptune from '@aws-cdk/aws-neptune-alpha'; diff --git a/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/README.md b/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/README.md index 726b7199334a2..e603e966f15f5 100644 --- a/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/README.md +++ b/packages/@aws-cdk/aws-servicecatalogappregistry-alpha/README.md @@ -30,7 +30,7 @@ enables organizations to create and manage repositories of applications and asso - [Sharing an application](#sharing-an-application) - [Sharing an attribute group](#sharing-an-attribute-group) -The `@aws-cdk/aws-servicecatalogappregistry` package contains resources that enable users to automate governance and management of their AWS resources at scale. +The `@aws-cdk/aws-servicecatalogappregistry-alpha` package contains resources that enable users to automate governance and management of their AWS resources at scale. ```ts nofixture import * as appreg from '@aws-cdk/aws-servicecatalogappregistry-alpha'; diff --git a/packages/aws-cdk-lib/aws-appsync/README.md b/packages/aws-cdk-lib/aws-appsync/README.md index bd67a20ec5e65..438dd045f794a 100644 --- a/packages/aws-cdk-lib/aws-appsync/README.md +++ b/packages/aws-cdk-lib/aws-appsync/README.md @@ -1,7 +1,7 @@ # AWS AppSync Construct Library -The `@aws-cdk/aws-appsync` package contains constructs for building flexible +The `aws-cdk-lib/aws-appsync` package contains constructs for building flexible APIs that use GraphQL. ```ts nofixture diff --git a/packages/aws-cdk-lib/aws-autoscaling-common/README.md b/packages/aws-cdk-lib/aws-autoscaling-common/README.md index e8c6d1f15a6aa..8b10e5b697fc3 100644 --- a/packages/aws-cdk-lib/aws-autoscaling-common/README.md +++ b/packages/aws-cdk-lib/aws-autoscaling-common/README.md @@ -1,8 +1,8 @@ # AWS AutoScaling Common Library -This is a sister package to `@aws-cdk/aws-autoscaling` and -`@aws-cdk/aws-applicationautoscaling`. It contains shared implementation +This is a sister package to `aws-cdk-lib/aws-autoscaling` and +`aws-cdk-lib/aws-applicationautoscaling`. It contains shared implementation details between them. It does not need to be used directly. diff --git a/packages/aws-cdk-lib/aws-autoscaling-hooktargets/README.md b/packages/aws-cdk-lib/aws-autoscaling-hooktargets/README.md index 1929e6a3b148f..317a2b0789510 100644 --- a/packages/aws-cdk-lib/aws-autoscaling-hooktargets/README.md +++ b/packages/aws-cdk-lib/aws-autoscaling-hooktargets/README.md @@ -12,7 +12,7 @@ Lifecycle hooks can be activated in one of the following ways: * Send to an SQS queue For more information on using this library, see the README of the -`@aws-cdk/aws-autoscaling` library. +`aws-cdk-lib/aws-autoscaling` library. For more information about lifecycle hooks, see [Amazon EC2 AutoScaling Lifecycle hooks](https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html) in the Amazon EC2 User Guide. diff --git a/packages/aws-cdk-lib/aws-autoscaling/README.md b/packages/aws-cdk-lib/aws-autoscaling/README.md index b171a2a5773e1..9fb6dd8c8d81f 100644 --- a/packages/aws-cdk-lib/aws-autoscaling/README.md +++ b/packages/aws-cdk-lib/aws-autoscaling/README.md @@ -427,7 +427,7 @@ The following update policies are available: ## Allowing Connections -See the documentation of the `@aws-cdk/aws-ec2` package for more information +See the documentation of the `aws-cdk-lib/aws-ec2` package for more information about allowing connections between resources backed by instances. ## Max Instance Lifetime diff --git a/packages/aws-cdk-lib/aws-cloudformation/lib/custom-resource.ts b/packages/aws-cdk-lib/aws-cloudformation/lib/custom-resource.ts index c9397c4b8af65..51c2424d1c602 100644 --- a/packages/aws-cdk-lib/aws-cloudformation/lib/custom-resource.ts +++ b/packages/aws-cdk-lib/aws-cloudformation/lib/custom-resource.ts @@ -110,8 +110,8 @@ export interface CustomResourceProps { * ``` * * ```ts - * import * as cloudformation from '@aws-cdk/aws-cloudformation'; - * import * as lambda from '@aws-cdk/aws-lambda'; + * import * as cloudformation from 'aws-cdk-lib/aws-cloudformation'; + * import * as lambda from 'aws-cdk-lib/aws-lambda'; * declare const myFunction: lambda.Function; * * // invoke an AWS Lambda function when a lifecycle event occurs: @@ -119,8 +119,8 @@ export interface CustomResourceProps { * ``` * * ```ts - * import * as cloudformation from '@aws-cdk/aws-cloudformation'; - * import * as sns from '@aws-cdk/aws-sns'; + * import * as cloudformation from 'aws-cdk-lib/aws-cloudformation'; + * import * as sns from 'aws-cdk-lib/aws-sns'; * declare const myTopic: sns.Topic; * * // publish lifecycle events to an SNS topic: diff --git a/packages/aws-cdk-lib/aws-cloudfront-origins/README.md b/packages/aws-cdk-lib/aws-cloudfront-origins/README.md index ada52ef1ed55c..c876cde8a1158 100644 --- a/packages/aws-cdk-lib/aws-cloudfront-origins/README.md +++ b/packages/aws-cdk-lib/aws-cloudfront-origins/README.md @@ -87,7 +87,7 @@ new cloudfront.Distribution(this, 'myDist', { }); ``` -See the documentation of `@aws-cdk/aws-cloudfront` for more information. +See the documentation of `aws-cdk-lib/aws-cloudfront` for more information. ## Failover Origins (Origin Groups) diff --git a/packages/aws-cdk-lib/aws-cloudfront/README.md b/packages/aws-cdk-lib/aws-cloudfront/README.md index a4866aa28b469..aab05433fd4f6 100644 --- a/packages/aws-cdk-lib/aws-cloudfront/README.md +++ b/packages/aws-cdk-lib/aws-cloudfront/README.md @@ -16,7 +16,7 @@ for more complex use cases. ### Creating a distribution CloudFront distributions deliver your content from one or more origins; an origin is the location where you store the original version of your -content. Origins can be created from S3 buckets or a custom origin (HTTP server). Constructs to define origins are in the `@aws-cdk/aws-cloudfront-origins` module. +content. Origins can be created from S3 buckets or a custom origin (HTTP server). Constructs to define origins are in the `aws-cdk-lib/aws-cloudfront-origins` module. Each distribution has a default behavior which applies to all requests to that distribution, and routes requests to a primary origin. Additional behaviors may be specified for an origin with a given URL path pattern. Behaviors allow routing with multiple origins, diff --git a/packages/aws-cdk-lib/aws-cloudtrail/lib/cloudtrail.ts b/packages/aws-cdk-lib/aws-cloudtrail/lib/cloudtrail.ts index 6c97a6a97d78f..ef1a03bec8de1 100644 --- a/packages/aws-cdk-lib/aws-cloudtrail/lib/cloudtrail.ts +++ b/packages/aws-cdk-lib/aws-cloudtrail/lib/cloudtrail.ts @@ -186,7 +186,7 @@ export class InsightType { * Cloud trail allows you to log events that happen in your AWS account * For example: * - * import { CloudTrail } from '@aws-cdk/aws-cloudtrail' + * import { CloudTrail } from 'aws-cdk-lib/aws-cloudtrail' * * const cloudTrail = new CloudTrail(this, 'MyTrail'); * diff --git a/packages/aws-cdk-lib/aws-cloudwatch-actions/README.md b/packages/aws-cdk-lib/aws-cloudwatch-actions/README.md index 79647f527b7b3..5da3f83ebcab3 100644 --- a/packages/aws-cdk-lib/aws-cloudwatch-actions/README.md +++ b/packages/aws-cdk-lib/aws-cloudwatch-actions/README.md @@ -40,4 +40,4 @@ alarm.addAlarmAction( ); ``` -See `@aws-cdk/aws-cloudwatch` for more information. +See `aws-cdk-lib/aws-cloudwatch` for more information. diff --git a/packages/aws-cdk-lib/aws-cloudwatch/README.md b/packages/aws-cdk-lib/aws-cloudwatch/README.md index a5e26293b6960..c28f46e28b476 100644 --- a/packages/aws-cdk-lib/aws-cloudwatch/README.md +++ b/packages/aws-cdk-lib/aws-cloudwatch/README.md @@ -284,7 +284,7 @@ Please note that it is **not possible** to: ### Alarm Actions To add actions to an alarm, use the integration classes from the -`@aws-cdk/aws-cloudwatch-actions` package. For example, to post a message to +`aws-cdk-lib/aws-cloudwatch-actions` package. For example, to post a message to an SNS topic when an alarm breaches, do the following: ```ts diff --git a/packages/aws-cdk-lib/aws-codebuild/README.md b/packages/aws-cdk-lib/aws-codebuild/README.md index ffda53fb3ff97..e9ac04288d325 100644 --- a/packages/aws-cdk-lib/aws-codebuild/README.md +++ b/packages/aws-cdk-lib/aws-codebuild/README.md @@ -605,7 +605,7 @@ by events via an event rule. ### Using Project as an event target -The `@aws-cdk/aws-events-targets.CodeBuildProject` allows using an AWS CodeBuild +The `aws-cdk-lib/aws-events-targets.CodeBuildProject` allows using an AWS CodeBuild project as a AWS CloudWatch event rule target: ```ts diff --git a/packages/aws-cdk-lib/aws-docdb/README.md b/packages/aws-cdk-lib/aws-docdb/README.md index 30e4652d42c33..4b34af779b25d 100644 --- a/packages/aws-cdk-lib/aws-docdb/README.md +++ b/packages/aws-cdk-lib/aws-docdb/README.md @@ -119,7 +119,7 @@ cluster.addRotationMultiUser('MyUser', { // Add rotation using the multi user sc **Note**: This user must be created manually in the database using the master credentials. The rotation will start as soon as this user exists. -See also [@aws-cdk/aws-secretsmanager](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-secretsmanager/README.md) for credentials rotation of existing clusters. +See also [aws-cdk-lib/aws-secretsmanager](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-secretsmanager/README.md) for credentials rotation of existing clusters. ## Audit and profiler Logs diff --git a/packages/aws-cdk-lib/aws-dynamodb/README.md b/packages/aws-cdk-lib/aws-dynamodb/README.md index b8b8ed75e2e28..fd8403d42738b 100644 --- a/packages/aws-cdk-lib/aws-dynamodb/README.md +++ b/packages/aws-cdk-lib/aws-dynamodb/README.md @@ -23,7 +23,7 @@ table.grantReadWriteData(user); ``` If you intend to use the `tableStreamArn` (including indirectly, for example by creating an -`@aws-cdk/aws-lambda-event-source.DynamoEventSource` on the imported table), you *must* use the +`aws-cdk-lib/aws-lambda-event-sources.DynamoEventSource` on the imported table), you *must* use the `Table.fromTableAttributes` method and the `tableStreamArn` property *must* be populated. In order to grant permissions to indexes on imported tables you can either set `grantIndexPermissions` to `true`, or you can provide the indexes via the `globalIndexes` or `localIndexes` properties. This will enable `grant*` methods to also grant permissions to *all* table indexes. diff --git a/packages/aws-cdk-lib/aws-ec2/README.md b/packages/aws-cdk-lib/aws-ec2/README.md index b857f432a4546..709e363140811 100644 --- a/packages/aws-cdk-lib/aws-ec2/README.md +++ b/packages/aws-cdk-lib/aws-ec2/README.md @@ -2,7 +2,7 @@ -The `@aws-cdk/aws-ec2` package contains primitives for setting up networking and +The `aws-cdk-lib/aws-ec2` package contains primitives for setting up networking and instances. ```ts nofixture @@ -878,7 +878,7 @@ By default, routes will be propagated on the route tables associated with the pr private subnets exist, isolated subnets are used. If no isolated subnets exist, public subnets are used. Use the `Vpc` property `vpnRoutePropagation` to customize this behavior. -VPN connections expose [metrics (cloudwatch.Metric)](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-cloudwatch/README.md) across all tunnels in the account/region and per connection: +VPN connections expose [metrics (cloudwatch.Metric)](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-cloudwatch/README.md) across all tunnels in the account/region and per connection: ```ts fixture=with-vpc // Across all tunnels in the account/region diff --git a/packages/aws-cdk-lib/aws-ecs-patterns/CONTRIBUTING.md b/packages/aws-cdk-lib/aws-ecs-patterns/CONTRIBUTING.md index 5a6ad506d18ea..73b4c3fe4d7c2 100644 --- a/packages/aws-cdk-lib/aws-ecs-patterns/CONTRIBUTING.md +++ b/packages/aws-cdk-lib/aws-ecs-patterns/CONTRIBUTING.md @@ -1 +1 @@ -See: [Contributing Guide](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-ecs/README.md) +See: [Contributing Guide](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-ecs/README.md) diff --git a/packages/aws-cdk-lib/aws-ecs/CONTRIBUTING.md b/packages/aws-cdk-lib/aws-ecs/CONTRIBUTING.md index bb0f7d28187cd..e461152312758 100644 --- a/packages/aws-cdk-lib/aws-ecs/CONTRIBUTING.md +++ b/packages/aws-cdk-lib/aws-ecs/CONTRIBUTING.md @@ -4,16 +4,11 @@ Hiya! Thanks for your interest in contributing to the ECS modules! The [ECS Developer Experience](https://github.com/orgs/aws/teams/aws-ecs-devx) team currently owns the following construct libraries: -- [@aws-cdk/aws-ecs](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-ecs): +- [@aws-cdk/aws-ecs](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-ecs): the main construct library for AWS ECS -- [@aws-cdk/aws-ecs-patterns](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-ecs-patterns): +- [@aws-cdk/aws-ecs-patterns](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-ecs-patterns): a set of simplified, higher-level constructs based on common container-based application architectures. Great for first-time container developers! -- [@aws-cdk-containers/ecs-service-extensions](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk-containers/ecs-service-extensions): - a set of ECS constructs that promote best practices for container -infrastructure by using composable add-ons, such as load balancers and sidecar -containers used for tracing and metric logging. More suitable for advanced -container configuration. ## Find something to work on diff --git a/packages/aws-cdk-lib/aws-ecs/README.md b/packages/aws-cdk-lib/aws-ecs/README.md index 09b02d1605fdb..c7927b54b747f 100644 --- a/packages/aws-cdk-lib/aws-ecs/README.md +++ b/packages/aws-cdk-lib/aws-ecs/README.md @@ -38,7 +38,7 @@ const ecsService = new ecs.Ec2Service(this, 'Service', { }); ``` -For a set of constructs defining common ECS architectural patterns, see the `@aws-cdk/aws-ecs-patterns` package. +For a set of constructs defining common ECS architectural patterns, see the `aws-cdk-lib/aws-ecs-patterns` package. ## Launch Types: AWS Fargate vs Amazon EC2 vs AWS ECS Anywhere @@ -435,7 +435,7 @@ obtained from either DockerHub or from ECR repositories, built directly from a l - `ecs.ContainerImage.fromAsset('./image')`: build and upload an image directly from a `Dockerfile` in your source directory. - `ecs.ContainerImage.fromDockerImageAsset(asset)`: uses an existing - `@aws-cdk/aws-ecr-assets.DockerImageAsset` as a container image. + `aws-cdk-lib/aws-ecr-assets.DockerImageAsset` as a container image. - `ecs.ContainerImage.fromTarball(file)`: use an existing tarball. - `new ecs.TagParameterContainerImage(repository)`: use the given ECR repository as the image but a CloudFormation parameter as the tag. @@ -912,7 +912,7 @@ See that section for details. ## Integration with CloudWatch Events To start an Amazon ECS task on an Amazon EC2-backed Cluster, instantiate an -`@aws-cdk/aws-events-targets.EcsTask` instead of an `Ec2Service`: +`aws-cdk-lib/aws-events-targets.EcsTask` instead of an `Ec2Service`: ```ts declare const cluster: ecs.Cluster; diff --git a/packages/aws-cdk-lib/aws-eks/README.md b/packages/aws-cdk-lib/aws-eks/README.md index 923b1f026819f..85bb21f3c0dc9 100644 --- a/packages/aws-cdk-lib/aws-eks/README.md +++ b/packages/aws-cdk-lib/aws-eks/README.md @@ -1100,7 +1100,7 @@ bucket.grantReadWrite(serviceAccount); Note that adding service accounts requires running `kubectl` commands against the cluster. This means you must also pass the `kubectlRoleArn` when importing the cluster. -See [Using existing Clusters](https://github.com/aws/aws-cdk/tree/main/packages/@aws-cdk/aws-eks#using-existing-clusters). +See [Using existing Clusters](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-eks#using-existing-clusters). ## Applying Kubernetes Resources diff --git a/packages/aws-cdk-lib/aws-elasticloadbalancing/README.md b/packages/aws-cdk-lib/aws-elasticloadbalancing/README.md index 5c0d25cbd0532..0ec19fad47831 100644 --- a/packages/aws-cdk-lib/aws-elasticloadbalancing/README.md +++ b/packages/aws-cdk-lib/aws-elasticloadbalancing/README.md @@ -1,7 +1,7 @@ # Amazon Elastic Load Balancing Construct Library -The `@aws-cdk/aws-elasticloadbalancing` package provides constructs for configuring +The `aws-cdk-lib/aws-elasticloadbalancing` package provides constructs for configuring classic load balancers. ## Configuring a Load Balancer diff --git a/packages/aws-cdk-lib/aws-elasticloadbalancingv2-actions/README.md b/packages/aws-cdk-lib/aws-elasticloadbalancingv2-actions/README.md index a117be505ae67..2e8aab8348c28 100644 --- a/packages/aws-cdk-lib/aws-elasticloadbalancingv2-actions/README.md +++ b/packages/aws-cdk-lib/aws-elasticloadbalancingv2-actions/README.md @@ -1,7 +1,7 @@ # Actions for AWS Elastic Load Balancing V2 -This package contains integration actions for ELBv2. See the README of the `@aws-cdk/aws-elasticloadbalancingv2` library. +This package contains integration actions for ELBv2. See the README of the `aws-cdk-lib/aws-elasticloadbalancingv2` library. ## Cognito diff --git a/packages/aws-cdk-lib/aws-elasticloadbalancingv2-targets/README.md b/packages/aws-cdk-lib/aws-elasticloadbalancingv2-targets/README.md index 928dc1068e09b..d0756b2cb73f6 100644 --- a/packages/aws-cdk-lib/aws-elasticloadbalancingv2-targets/README.md +++ b/packages/aws-cdk-lib/aws-elasticloadbalancingv2-targets/README.md @@ -1,4 +1,4 @@ # Targets for AWS Elastic Load Balancing V2 -This package contains targets for ELBv2. See the README of the `@aws-cdk/aws-elasticloadbalancingv2` library. +This package contains targets for ELBv2. See the README of the `aws-cdk-lib/aws-elasticloadbalancingv2` library. diff --git a/packages/aws-cdk-lib/aws-elasticloadbalancingv2/README.md b/packages/aws-cdk-lib/aws-elasticloadbalancingv2/README.md index 14e86b86963db..fa8d644b26501 100644 --- a/packages/aws-cdk-lib/aws-elasticloadbalancingv2/README.md +++ b/packages/aws-cdk-lib/aws-elasticloadbalancingv2/README.md @@ -2,7 +2,7 @@ -The `@aws-cdk/aws-elasticloadbalancingv2` package provides constructs for +The `aws-cdk-lib/aws-elasticloadbalancingv2` package provides constructs for configuring application and network load balancers. For more information, see the AWS documentation for @@ -133,7 +133,7 @@ Balancer that the other two convenience methods don't: redirect response (ALB only). - **Authentication**: use `ListenerAction.authenticateOidc()` to perform OpenID authentication before serving a request (see the - `@aws-cdk/aws-elasticloadbalancingv2-actions` package for direct authentication + `aws-cdk-lib/aws-elasticloadbalancingv2-actions` package for direct authentication integration with Cognito) (ALB only). Here's an example of serving a fixed response at the `/ok` URL: @@ -338,7 +338,7 @@ const tg = new elbv2.ApplicationTargetGroup(this, 'TG', { ## Using Lambda Targets To use a Lambda Function as a target, use the integration class in the -`@aws-cdk/aws-elasticloadbalancingv2-targets` package: +`aws-cdk-lib/aws-elasticloadbalancingv2-targets` package: ```ts import * as lambda from 'aws-cdk-lib/aws-lambda'; @@ -364,7 +364,7 @@ Only a single Lambda function can be added to a single listener rule. ## Using Application Load Balancer Targets To use a single application load balancer as a target for the network load balancer, use the integration class in the -`@aws-cdk/aws-elasticloadbalancingv2-targets` package: +`aws-cdk-lib/aws-elasticloadbalancingv2-targets` package: ```ts import * as targets from 'aws-cdk-lib/aws-elasticloadbalancingv2-targets'; diff --git a/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/load-balancer-targets.ts b/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/load-balancer-targets.ts index 9b07b79cde436..5d92ac264e189 100644 --- a/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/load-balancer-targets.ts +++ b/packages/aws-cdk-lib/aws-elasticloadbalancingv2/lib/shared/load-balancer-targets.ts @@ -9,7 +9,7 @@ import { INetworkLoadBalancerTarget, INetworkTargetGroup } from '../nlb/network- * If you register a target of this type, you are responsible for making * sure the load balancer's security group can connect to the instance. * - * @deprecated Use IpTarget from the @aws-cdk/aws-elasticloadbalancingv2-targets package instead. + * @deprecated Use IpTarget from the aws-cdk-lib/aws-elasticloadbalancingv2-targets package instead. */ export class InstanceTarget implements IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget { /** @@ -60,7 +60,7 @@ export class InstanceTarget implements IApplicationLoadBalancerTarget, INetworkL * If you register a target of this type, you are responsible for making * sure the load balancer's security group can send packets to the IP address. * - * @deprecated Use IpTarget from the @aws-cdk/aws-elasticloadbalancingv2-targets package instead. + * @deprecated Use IpTarget from the aws-cdk-lib/aws-elasticloadbalancingv2-targets package instead. */ export class IpTarget implements IApplicationLoadBalancerTarget, INetworkLoadBalancerTarget { /** diff --git a/packages/aws-cdk-lib/aws-elasticsearch/README.md b/packages/aws-cdk-lib/aws-elasticsearch/README.md index 4f65da745ea5e..74ba009470589 100644 --- a/packages/aws-cdk-lib/aws-elasticsearch/README.md +++ b/packages/aws-cdk-lib/aws-elasticsearch/README.md @@ -1,7 +1,7 @@ # Amazon OpenSearch Service Construct Library -> Instead of this module, we recommend using the [@aws-cdk/aws-opensearchservice](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-opensearchservice-readme.html) module. See [Amazon OpenSearch Service FAQs](https://aws.amazon.com/opensearch-service/faqs/#Name_change) for details. See [Migrating to OpenSearch](#migrating-to-opensearch) for migration instructions. +> Instead of this module, we recommend using the [aws-cdk-lib/aws-opensearchservice](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_opensearchservice-readme.html) module. See [Amazon OpenSearch Service FAQs](https://aws.amazon.com/opensearch-service/faqs/#Name_change) for details. See [Migrating to OpenSearch](#migrating-to-opensearch) for migration instructions. ## Quick start @@ -342,13 +342,13 @@ new es.Domain(this, 'Domain', { ## Migrating to OpenSearch -To migrate from this module (`@aws-cdk/aws-elasticsearch`) to the new `@aws-cdk/aws-opensearchservice` module, you must modify your CDK application to refer to the new module (including some associated changes) and then perform a CloudFormation resource deletion/import. +To migrate from this module (`aws-cdk-lib/aws-elasticsearch`) to the new `aws-cdk-lib/aws-opensearchservice` module, you must modify your CDK application to refer to the new module (including some associated changes) and then perform a CloudFormation resource deletion/import. ### Necessary CDK Modifications -Make the following modifications to your CDK application to migrate to the `@aws-cdk/aws-opensearchservice` module. +Make the following modifications to your CDK application to migrate to the `aws-cdk-lib/aws-opensearchservice` module. -- Rewrite module imports to use `'@aws-cdk/aws-opensearchservice` to `'@aws-cdk/aws-elasticsearch`. +- Rewrite module imports to use `'aws-cdk-lib/aws-opensearchservice` to `'aws-cdk-lib/aws-elasticsearch`. For example: ```ts nofixture @@ -435,7 +435,7 @@ Follow these steps to migrate your application without data loss: - Ensure that the [removal policy](https://docs.aws.amazon.com/cdk/api/latest/docs/@aws-cdk_core.RemovalPolicy.html) on your domains are set to `RemovalPolicy.RETAIN`. This is the default for the domain construct, so nothing is required unless you have specifically set the removal policy to some other value. - Remove the domain resource from your CloudFormation stacks by manually modifying the synthesized templates used to create the CloudFormation stacks. This may also involve modifying or deleting dependent resources, such as the custom resources that CDK creates to manage the domain's access policy or any other resource you have connected to the domain. You will need to search for references to each domain's logical ID to determine which other resources refer to it and replace or delete those references. Do not remove resources that are dependencies of the domain or you will have to recreate or import them before importing the domain. After modification, deploy the stacks through the AWS Management Console or using the AWS CLI. -- Migrate your CDK application to use the new `@aws-cdk/aws-opensearchservice` module by applying the necessary modifications listed above. Synthesize your application and obtain the resulting stack templates. +- Migrate your CDK application to use the new `aws-cdk-lib/aws-opensearchservice` module by applying the necessary modifications listed above. Synthesize your application and obtain the resulting stack templates. - Copy just the definition of the domain from the "migrated" templates to the corresponding "stripped" templates that you deployed above. [Import](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resource-import-existing-stack.html) the orphaned domains into your CloudFormation stacks using these templates. - Synthesize and deploy your CDK application to reconfigure/recreate the modified dependent resources. The CloudFormation stacks should now contain the same resources as existed prior to migration. - Proceed with development as normal! diff --git a/packages/aws-cdk-lib/aws-events-targets/README.md b/packages/aws-cdk-lib/aws-events-targets/README.md index 8675ddca64151..693a93ab2dbd1 100644 --- a/packages/aws-cdk-lib/aws-events-targets/README.md +++ b/packages/aws-cdk-lib/aws-events-targets/README.md @@ -23,7 +23,7 @@ Currently supported are: * [Put an event on an EventBridge bus](#put-an-event-on-an-eventbridge-bus) * [Send an event to EventBridge API Destination](#invoke-an-api-destination) -See the README of the `@aws-cdk/aws-events` library for more information on +See the README of the `aws-cdk-lib/aws-events` library for more information on EventBridge. ## Event retry policy and using dead-letter queues diff --git a/packages/aws-cdk-lib/aws-events/README.md b/packages/aws-cdk-lib/aws-events/README.md index 528f4b483bd44..6becb63ddef5f 100644 --- a/packages/aws-cdk-lib/aws-events/README.md +++ b/packages/aws-cdk-lib/aws-events/README.md @@ -156,7 +156,7 @@ const ecsTaskTarget = new targets.EcsTask({ cluster, taskDefinition, role, platf ## Event Targets -The `@aws-cdk/aws-events-targets` module includes classes that implement the `IRuleTarget` +The `aws-cdk-lib/aws-events-targets` module includes classes that implement the `IRuleTarget` interface for various AWS services. The following targets are supported: diff --git a/packages/aws-cdk-lib/aws-globalaccelerator-endpoints/README.md b/packages/aws-cdk-lib/aws-globalaccelerator-endpoints/README.md index 39f965c3d90e3..1af12571805ce 100644 --- a/packages/aws-cdk-lib/aws-globalaccelerator-endpoints/README.md +++ b/packages/aws-cdk-lib/aws-globalaccelerator-endpoints/README.md @@ -5,6 +5,6 @@ This library contains integration classes to reference endpoints in AWS Global Accelerator. Instances of these classes should be passed to the `endpointGroup.addEndpoint()` method. -See the README of the `@aws-cdk/aws-globalaccelerator` library for more information on +See the README of the `aws-cdk-lib/aws-globalaccelerator` library for more information on AWS Global Accelerator, and examples of all the integration classes available in this module. diff --git a/packages/aws-cdk-lib/aws-globalaccelerator/README.md b/packages/aws-cdk-lib/aws-globalaccelerator/README.md index 9134c3635d875..8f0955e899ac7 100644 --- a/packages/aws-cdk-lib/aws-globalaccelerator/README.md +++ b/packages/aws-cdk-lib/aws-globalaccelerator/README.md @@ -71,7 +71,7 @@ used is the same as the traffic came in on at the Listener, unless overridden. ## Types of Endpoints There are 4 types of Endpoints, and they can be found in the -`@aws-cdk/aws-globalaccelerator-endpoints` package: +`aws-cdk-lib/aws-globalaccelerator-endpoints` package: * Application Load Balancers * Network Load Balancers diff --git a/packages/aws-cdk-lib/aws-lambda-nodejs/README.md b/packages/aws-cdk-lib/aws-lambda-nodejs/README.md index 1270d19e5108f..3c31e52b915fb 100644 --- a/packages/aws-cdk-lib/aws-lambda-nodejs/README.md +++ b/packages/aws-cdk-lib/aws-lambda-nodejs/README.md @@ -76,7 +76,7 @@ For monorepos, the reference architecture becomes: All properties of `lambda.Function` can be used to customize the underlying `lambda.Function`. -See also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda). +See also the [AWS Lambda construct library](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-lambda). The `NodejsFunction` construct automatically [reuses existing connections](https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/node-reusing-connections.html) when working with the AWS SDK for JavaScript. Set the `awsSdkConnectionReuse` prop to `false` to disable it. @@ -300,7 +300,7 @@ new nodejs.NodejsFunction(this, 'my-handler', { This image should have `esbuild` installed **globally**. If you plan to use `nodeModules` it should also have `npm`, `yarn` or `pnpm` depending on the lock file you're using. -Use the [default image provided by `@aws-cdk/aws-lambda-nodejs`](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-lambda-nodejs/lib/Dockerfile) +Use the [default image provided by `aws-cdk-lib/aws-lambda-nodejs`](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-lambda-nodejs/lib/Dockerfile) as a source of inspiration. You can set additional Docker options to configure the build environment: diff --git a/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts b/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts index c522d088edc24..5f433f0161fed 100644 --- a/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts +++ b/packages/aws-cdk-lib/aws-lambda-nodejs/lib/types.ts @@ -249,10 +249,10 @@ export interface BundlingOptions extends DockerRunOptions { * This image should have esbuild installed globally. If you plan to use `nodeModules` * it should also have `npm`, `yarn` or `pnpm` depending on the lock file you're using. * - * See https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-lambda-nodejs/lib/Dockerfile - * for the default image provided by @aws-cdk/aws-lambda-nodejs. + * See https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-lambda-nodejs/lib/Dockerfile + * for the default image provided by aws-cdk-lib/aws-lambda-nodejs. * - * @default - use the Docker image provided by @aws-cdk/aws-lambda-nodejs + * @default - use the Docker image provided by aws-cdk-lib/aws-lambda-nodejs */ readonly dockerImage?: DockerImage; diff --git a/packages/aws-cdk-lib/aws-lambda/README.md b/packages/aws-cdk-lib/aws-lambda/README.md index bded45e47e132..30b5839687637 100644 --- a/packages/aws-cdk-lib/aws-lambda/README.md +++ b/packages/aws-cdk-lib/aws-lambda/README.md @@ -1081,8 +1081,8 @@ new lambda.Function(this, 'Function', { Language-specific higher level constructs are provided in separate modules: -* `@aws-cdk/aws-lambda-nodejs`: [Github](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda-nodejs) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-nodejs-readme.html) -* `@aws-cdk/aws-lambda-python`: [Github](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda-python) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-lambda-python-readme.html) +* `aws-cdk-lib/aws-lambda-nodejs`: [Github](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-lambda-nodejs) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda_nodejs-readme.html) +* `@aws-cdk/aws-lambda-python-alpha`: [Github](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-lambda-python-alpha) & [CDK Docs](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-lambda-python-alpha-readme.html) ## Code Signing diff --git a/packages/aws-cdk-lib/aws-lambda/lib/event-source-mapping.ts b/packages/aws-cdk-lib/aws-lambda/lib/event-source-mapping.ts index f166d27cf6d43..daf5a555d4d3d 100644 --- a/packages/aws-cdk-lib/aws-lambda/lib/event-source-mapping.ts +++ b/packages/aws-cdk-lib/aws-lambda/lib/event-source-mapping.ts @@ -285,7 +285,7 @@ export interface IEventSourceMapping extends cdk.IResource { * Usually, you won't need to define the mapping yourself. This will usually be done by * event sources. For example, to add an SQS event source to a function: * - * import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources'; + * import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources'; * lambda.addEventSource(new SqsEventSource(sqs)); * * The `SqsEventSource` class will automatically create the mapping, and will also diff --git a/packages/aws-cdk-lib/aws-lambda/lib/function-base.ts b/packages/aws-cdk-lib/aws-lambda/lib/function-base.ts index 46788487acf7b..a251b27ffcd54 100644 --- a/packages/aws-cdk-lib/aws-lambda/lib/function-base.ts +++ b/packages/aws-cdk-lib/aws-lambda/lib/function-base.ts @@ -131,11 +131,11 @@ export interface IFunction extends IResource, ec2.IConnectable, iam.IGrantable { /** * Adds an event source to this function. * - * Event sources are implemented in the @aws-cdk/aws-lambda-event-sources module. + * Event sources are implemented in the aws-cdk-lib/aws-lambda-event-sources module. * * The following example adds an SQS Queue as an event source: * ``` - * import { SqsEventSource } from '@aws-cdk/aws-lambda-event-sources'; + * import { SqsEventSource } from 'aws-cdk-lib/aws-lambda-event-sources'; * myFunction.addEventSource(new SqsEventSource(myQueue)); * ``` */ diff --git a/packages/aws-cdk-lib/aws-lambda/lib/log-retention.ts b/packages/aws-cdk-lib/aws-lambda/lib/log-retention.ts index 4796ef31ec483..9609dc372ee3b 100644 --- a/packages/aws-cdk-lib/aws-lambda/lib/log-retention.ts +++ b/packages/aws-cdk-lib/aws-lambda/lib/log-retention.ts @@ -10,7 +10,7 @@ export interface LogRetentionRetryOptions extends logs.LogRetentionRetryOptions /** * Construction properties for a LogRetention. * - * @deprecated use `LogRetentionProps` from '@aws-cdk/aws-logs' instead + * @deprecated use `LogRetentionProps` from 'aws-cdk-lib/aws-logs' instead */ export interface LogRetentionProps extends logs.LogRetentionProps { } @@ -20,7 +20,7 @@ export interface LogRetentionProps extends logs.LogRetentionProps { * log group. The log group is created if it doesn't already exist. The policy * is removed when `retentionDays` is `undefined` or equal to `Infinity`. * - * @deprecated use `LogRetention` from '@aws-cdk/aws-logs' instead + * @deprecated use `LogRetention` from 'aws-cdk-lib/aws-logs' instead */ export class LogRetention extends logs.LogRetention { constructor(scope: Construct, id: string, props: LogRetentionProps) { diff --git a/packages/aws-cdk-lib/aws-logs/lib/cross-account-destination.ts b/packages/aws-cdk-lib/aws-logs/lib/cross-account-destination.ts index 072525835477c..a525de583b043 100644 --- a/packages/aws-cdk-lib/aws-logs/lib/cross-account-destination.ts +++ b/packages/aws-cdk-lib/aws-logs/lib/cross-account-destination.ts @@ -38,7 +38,7 @@ export interface CrossAccountDestinationProps { * * Consumers will hardly ever need to use this class. Instead, directly * subscribe a Kinesis stream using the integration class in the - * `@aws-cdk/aws-logs-destinations` package; if necessary, a + * `aws-cdk-lib/aws-logs-destinations` package; if necessary, a * `CrossAccountDestination` will be created automatically. * * @resource AWS::Logs::Destination diff --git a/packages/aws-cdk-lib/aws-logs/lib/log-retention.ts b/packages/aws-cdk-lib/aws-logs/lib/log-retention.ts index 1a5ca3d893c0f..b155029326e70 100644 --- a/packages/aws-cdk-lib/aws-logs/lib/log-retention.ts +++ b/packages/aws-cdk-lib/aws-logs/lib/log-retention.ts @@ -92,7 +92,7 @@ export class LogRetention extends Construct { } // Need to use a CfnResource here to prevent lerna dependency cycles - // @aws-cdk/aws-cloudformation -> @aws-cdk/aws-lambda -> @aws-cdk/aws-cloudformation + // aws-cdk-lib/aws-cloudformation -> aws-cdk-lib/aws-lambda -> aws-cdk-lib/aws-cloudformation const retryOptions = props.logRetentionRetryOptions; const resource = new cdk.CfnResource(this, 'Resource', { type: 'Custom::LogRetention', @@ -123,7 +123,7 @@ export class LogRetention extends Construct { /** * Helper method to ensure that only one instance of LogRetentionFunction resources are in the stack mimicking the - * behaviour of @aws-cdk/aws-lambda's SingletonFunction to prevent circular dependencies + * behaviour of aws-cdk-lib/aws-lambda's SingletonFunction to prevent circular dependencies */ private ensureSingletonLogRetentionFunction(props: LogRetentionProps) { const functionLogicalId = 'LogRetentionaae0aa3c5b4d4f87b02d85b201efdd8a'; diff --git a/packages/aws-cdk-lib/aws-opensearchservice/README.md b/packages/aws-cdk-lib/aws-opensearchservice/README.md index a81451453514c..fc1e06f30a200 100644 --- a/packages/aws-cdk-lib/aws-opensearchservice/README.md +++ b/packages/aws-cdk-lib/aws-opensearchservice/README.md @@ -1,7 +1,7 @@ # Amazon OpenSearch Service Construct Library -See [Migrating to OpenSearch](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-elasticsearch-readme.html#migrating-to-opensearch) for migration instructions from `@aws-cdk/aws-elasticsearch` to this module, `@aws-cdk/aws-opensearchservice`. +See [Migrating to OpenSearch](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-elasticsearch-readme.html#migrating-to-opensearch) for migration instructions from `aws-cdk-lib/aws-elasticsearch` to this module, `aws-cdk-lib/aws-opensearchservice`. ## Quick start diff --git a/packages/aws-cdk-lib/aws-rds/README.md b/packages/aws-cdk-lib/aws-rds/README.md index ad9d8580c6c46..9b38c6f29187a 100644 --- a/packages/aws-cdk-lib/aws-rds/README.md +++ b/packages/aws-cdk-lib/aws-rds/README.md @@ -671,7 +671,7 @@ instance.addRotationSingleUser({ }); ``` -See also [@aws-cdk/aws-secretsmanager](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-secretsmanager/README.md) for credentials rotation of existing clusters/instances. +See also [aws-cdk-lib/aws-secretsmanager](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-secretsmanager/README.md) for credentials rotation of existing clusters/instances. By default, any stack updates will cause AWS Secrets Manager to rotate a secret immediately. To prevent this behavior and wait until the next scheduled rotation window specified via the `automaticallyAfter` property, set the `rotateImmediatelyOnUpdate` property to false: diff --git a/packages/aws-cdk-lib/aws-route53-targets/README.md b/packages/aws-cdk-lib/aws-route53-targets/README.md index c16a614a4e307..53c4ed6f7ff96 100644 --- a/packages/aws-cdk-lib/aws-route53-targets/README.md +++ b/packages/aws-cdk-lib/aws-route53-targets/README.md @@ -178,4 +178,4 @@ new route53.ARecord(this, 'AliasRecord', { }); ``` -See the documentation of `@aws-cdk/aws-route53` for more information. +See the documentation of `aws-cdk-lib/aws-route53` for more information. diff --git a/packages/aws-cdk-lib/aws-s3-deployment/README.md b/packages/aws-cdk-lib/aws-s3-deployment/README.md index 87285c17bc8fa..122c17af7d0f1 100644 --- a/packages/aws-cdk-lib/aws-s3-deployment/README.md +++ b/packages/aws-cdk-lib/aws-s3-deployment/README.md @@ -428,8 +428,8 @@ new cdk.CfnOutput(this, 'ObjectKey', { ## Development The custom resource is implemented in Python 3.9 in order to be able to leverage -the AWS CLI for "aws s3 sync". The code is under [`lib/lambda`](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-s3-deployment/lib/lambda) and -unit tests are under [`test/lambda`](https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-s3-deployment/test/lambda). +the AWS CLI for "aws s3 sync". The code is under [`lib/lambda`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment/lib/lambda) and +unit tests are under [`test/lambda`](https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment/test/lambda). This package requires Python 3.9 during build time in order to create the custom resource Lambda bundle and test it. It also relies on a few bash scripts, so diff --git a/packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts b/packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts index 7ed1fd182bf38..2d05c28498b54 100644 --- a/packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts +++ b/packages/aws-cdk-lib/aws-s3-deployment/lib/bucket-deployment.ts @@ -87,7 +87,7 @@ export interface BucketDeploymentProps { * NOTICE: Configuring this to "false" might have operational implications. Please * visit to the package documentation referred below to make sure you fully understand those implications. * - * @see https://github.com/aws/aws-cdk/tree/main/packages/%40aws-cdk/aws-s3-deployment#retain-on-delete + * @see https://github.com/aws/aws-cdk/tree/main/packages/aws-cdk-lib/aws-s3-deployment#retain-on-delete * @default true - when resource is deleted/updated, files are retained */ readonly retainOnDelete?: boolean; diff --git a/packages/aws-cdk-lib/aws-s3/README.md b/packages/aws-cdk-lib/aws-s3/README.md index 5fde1da258127..90ac7386d1196 100644 --- a/packages/aws-cdk-lib/aws-s3/README.md +++ b/packages/aws-cdk-lib/aws-s3/README.md @@ -269,7 +269,7 @@ bucket.addEventNotification(s3.EventType.OBJECT_CREATED, new s3n.SnsDestination( This call will also ensure that the topic policy can accept notifications for this specific bucket. -Supported S3 notification targets are exposed by the `@aws-cdk/aws-s3-notifications` package. +Supported S3 notification targets are exposed by the `aws-cdk-lib/aws-s3-notifications` package. It is also possible to specify S3 object key filters when subscribing. The following example will notify `myQueue` when objects prefixed with `foo/` and @@ -501,7 +501,7 @@ const bucket = new s3.Bucket(this, 'MyRedirectedBucket', { ## Filling the bucket as part of deployment To put files into a bucket as part of a deployment (for example, to host a -website), see the `@aws-cdk/aws-s3-deployment` package, which provides a +website), see the `aws-cdk-lib/aws-s3-deployment` package, which provides a resource that can do just that. ## The URL for objects diff --git a/packages/aws-cdk-lib/aws-s3/lib/notifications-resource/notifications-resource-handler.ts b/packages/aws-cdk-lib/aws-s3/lib/notifications-resource/notifications-resource-handler.ts index c97d155a0c068..352b958b2b336 100644 --- a/packages/aws-cdk-lib/aws-s3/lib/notifications-resource/notifications-resource-handler.ts +++ b/packages/aws-cdk-lib/aws-s3/lib/notifications-resource/notifications-resource-handler.ts @@ -22,7 +22,7 @@ export class NotificationsResourceHandlerProps { * For 'Delete' operations, we send an empty NotificationConfiguration as * required. We propagate errors and results as-is. * - * Sadly, we can't use @aws-cdk/aws-lambda as it will introduce a dependency + * Sadly, we can't use aws-cdk-lib/aws-lambda as it will introduce a dependency * cycle, so this uses raw `cdk.Resource`s. */ export class NotificationsResourceHandler extends Construct { diff --git a/packages/aws-cdk-lib/aws-secretsmanager/README.md b/packages/aws-cdk-lib/aws-secretsmanager/README.md index 0835e5bcd78f6..d72b5b5953f80 100644 --- a/packages/aws-cdk-lib/aws-secretsmanager/README.md +++ b/packages/aws-cdk-lib/aws-secretsmanager/README.md @@ -219,7 +219,7 @@ new secretsmanager.SecretRotation(this, 'SecretRotation', { }); ``` -See also [aws-rds](https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-rds/README.md) where +See also [aws-rds](https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-rds/README.md) where credentials generation and rotation is integrated. ## Importing Secrets diff --git a/packages/aws-cdk-lib/aws-servicecatalog/README.md b/packages/aws-cdk-lib/aws-servicecatalog/README.md index b5f4ab730fcb8..b3437393bd089 100644 --- a/packages/aws-cdk-lib/aws-servicecatalog/README.md +++ b/packages/aws-cdk-lib/aws-servicecatalog/README.md @@ -24,7 +24,7 @@ enables organizations to create and manage catalogs of products for their end us - [Deploy with StackSets](#deploy-with-stacksets) -The `@aws-cdk/aws-servicecatalog` package contains resources that enable users to automate governance and management of their AWS resources at scale. +The `aws-cdk-lib/aws-servicecatalog` package contains resources that enable users to automate governance and management of their AWS resources at scale. ```ts nofixture import * as servicecatalog from 'aws-cdk-lib/aws-servicecatalog'; diff --git a/packages/aws-cdk-lib/aws-ses-actions/README.md b/packages/aws-cdk-lib/aws-ses-actions/README.md index 8c83782f58db5..c1c8de4a2f529 100644 --- a/packages/aws-cdk-lib/aws-ses-actions/README.md +++ b/packages/aws-cdk-lib/aws-ses-actions/README.md @@ -13,4 +13,4 @@ Currently supported are: * [SNS](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-sns.html) * [Stop](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/receiving-email-action-stop.html) -See the README of `@aws-cdk/aws-ses` for more information. +See the README of `aws-cdk-lib/aws-ses` for more information. diff --git a/packages/aws-cdk-lib/aws-ses/README.md b/packages/aws-cdk-lib/aws-ses/README.md index 327172954ab1d..1b94d95346143 100644 --- a/packages/aws-cdk-lib/aws-ses/README.md +++ b/packages/aws-cdk-lib/aws-ses/README.md @@ -6,7 +6,7 @@ This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aw ## Email receiving Create a receipt rule set with rules and actions (actions can be found in the -`@aws-cdk/aws-ses-actions` package): +`aws-cdk-lib/aws-ses-actions` package): ```ts import * as s3 from 'aws-cdk-lib/aws-s3'; diff --git a/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts b/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts index f8907dc4d8e01..10098a9adb971 100644 --- a/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts +++ b/packages/aws-cdk-lib/aws-ses/lib/email-identity.ts @@ -219,7 +219,7 @@ class EasyDkim extends DkimIdentity { public bind(emailIdentity: EmailIdentity, hostedZone?: route53.IPublicHostedZone): DkimIdentityConfig | undefined { if (hostedZone) { // Use CfnRecordSet instead of CnameRecord to avoid current bad handling of - // tokens in route53.determineFullyQualifiedDomainName() at https://github.com/aws/aws-cdk/blob/main/packages/%40aws-cdk/aws-route53/lib/util.ts + // tokens in route53.determineFullyQualifiedDomainName() at https://github.com/aws/aws-cdk/blob/main/packages/aws-cdk-lib/aws-route53/lib/util.ts new route53.CfnRecordSet(emailIdentity, 'DkimDnsToken1', { hostedZoneId: hostedZone.hostedZoneId, name: Lazy.string({ produce: () => emailIdentity.dkimDnsTokenName1 }), diff --git a/packages/aws-cdk-lib/aws-sns/README.md b/packages/aws-cdk-lib/aws-sns/README.md index e5143003b9911..542482e50c3d8 100644 --- a/packages/aws-cdk-lib/aws-sns/README.md +++ b/packages/aws-cdk-lib/aws-sns/README.md @@ -26,7 +26,7 @@ Note that FIFO topics require a topic name to be provided. The required `.fifo` Various subscriptions can be added to the topic by calling the `.addSubscription(...)` method on the topic. It accepts a *subscription* object, default implementations of which can be found in the -`@aws-cdk/aws-sns-subscriptions` package: +`aws-cdk-lib/aws-sns-subscriptions` package: Add an HTTPS Subscription to your topic: @@ -150,7 +150,7 @@ new sns.Subscription(this, 'Subscription', { SNS topics can be used as targets for CloudWatch event rules. -Use the `@aws-cdk/aws-events-targets.SnsTopic`: +Use the `aws-cdk-lib/aws-events-targets.SnsTopic`: ```ts import * as codecommit from 'aws-cdk-lib/aws-codecommit'; diff --git a/packages/aws-cdk-lib/aws-ssm/README.md b/packages/aws-cdk-lib/aws-ssm/README.md index a05447c87a8a3..e70e424f0573b 100644 --- a/packages/aws-cdk-lib/aws-ssm/README.md +++ b/packages/aws-cdk-lib/aws-ssm/README.md @@ -105,7 +105,7 @@ You can create either `ssm.StringParameter` or `ssm.StringListParameter`s in a CDK app. These are public (not secret) values. Parameters of type *SecureString* cannot be created directly from a CDK application; if you want to provision secrets automatically, use Secrets Manager Secrets (see the -`@aws-cdk/aws-secretsmanager` package). +`aws-cdk-lib/aws-secretsmanager` package). ```ts new ssm.StringParameter(this, 'Parameter', { diff --git a/packages/aws-cdk-lib/aws-stepfunctions/README.md b/packages/aws-cdk-lib/aws-stepfunctions/README.md index 1b89b588dfe8a..bd2749c0b949f 100644 --- a/packages/aws-cdk-lib/aws-stepfunctions/README.md +++ b/packages/aws-cdk-lib/aws-stepfunctions/README.md @@ -1,9 +1,9 @@ # AWS Step Functions Construct Library -The `@aws-cdk/aws-stepfunctions` package contains constructs for building +The `aws-cdk-lib/aws-stepfunctions` package contains constructs for building serverless workflows using objects. Use this in conjunction with the -`@aws-cdk/aws-stepfunctions-tasks` package, which contains classes used +`aws-cdk-lib/aws-stepfunctions-tasks` package, which contains classes used to call other AWS services. Defining a workflow looks like this (for the [Step Functions Job Poller @@ -64,7 +64,7 @@ new sfn.StateMachine(this, 'StateMachine', { ``` You can find more sample snippets and learn more about the service integrations -in the `@aws-cdk/aws-stepfunctions-tasks` package. +in the `aws-cdk-lib/aws-stepfunctions-tasks` package. ## State Machine @@ -251,7 +251,7 @@ information, see the States Language spec. A `Task` represents some work that needs to be done. Do not use the `Task` class directly. -Instead, use one of the classes in the `@aws-cdk/aws-stepfunctions-tasks` module, +Instead, use one of the classes in the `aws-cdk-lib/aws-stepfunctions-tasks` module, which provide a much more ergonomic way to integrate with various AWS services. ### Pass diff --git a/packages/aws-cdk-lib/cloudformation-include/lib/cfn-type-to-l1-mapping.ts b/packages/aws-cdk-lib/cloudformation-include/lib/cfn-type-to-l1-mapping.ts index 07bb5e61d63c0..d74935970e5b5 100644 --- a/packages/aws-cdk-lib/cloudformation-include/lib/cfn-type-to-l1-mapping.ts +++ b/packages/aws-cdk-lib/cloudformation-include/lib/cfn-type-to-l1-mapping.ts @@ -10,7 +10,7 @@ let cfnTypeToL1Mapping: { [type: string]: string }; * or undefined if the given type was not found. * * For example, lookup("AWS::S3::Bucket") - * returns "@aws-cdk/aws-s3.CfnBucket". + * returns "aws-cdk-lib/aws-s3.CfnBucket". */ export function lookup(cfnType: string): string | undefined { if (!cfnTypeToL1Mapping) { diff --git a/packages/aws-cdk-lib/cx-api/lib/context/vpc.ts b/packages/aws-cdk-lib/cx-api/lib/context/vpc.ts index 257102bd6f9dc..18f86801890e9 100644 --- a/packages/aws-cdk-lib/cx-api/lib/context/vpc.ts +++ b/packages/aws-cdk-lib/cx-api/lib/context/vpc.ts @@ -1,6 +1,6 @@ /** * The type of subnet group. - * Same as SubnetType in the @aws-cdk/aws-ec2 package, + * Same as SubnetType in the aws-cdk-lib/aws-ec2 package, * but we can't use that because of cyclical dependencies. */ export enum VpcSubnetGroupType { diff --git a/packages/aws-cdk-lib/pipelines/ORIGINAL_API.md b/packages/aws-cdk-lib/pipelines/ORIGINAL_API.md index 453b05b099b64..ba31695eb18b0 100644 --- a/packages/aws-cdk-lib/pipelines/ORIGINAL_API.md +++ b/packages/aws-cdk-lib/pipelines/ORIGINAL_API.md @@ -361,7 +361,7 @@ If you need to run commands to setup proxies, mirrors, etc you can supply them u #### Sources -Any of the regular sources from the [`@aws-cdk/aws-codepipeline-actions`](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-codepipeline-actions-readme.html#github) module can be used. +Any of the regular sources from the [`aws-cdk-lib/aws-codepipeline-actions`](https://docs.aws.amazon.com/cdk/api/latest/docs/aws-codepipeline-actions-readme.html#github) module can be used. #### Synths @@ -730,8 +730,8 @@ create an SNS Topic, subscribe your own email address, and pass it in via `securityNotificationTopic`: ```ts -import * as sns from '@aws-cdk/aws-sns'; -import * as subscriptions from '@aws-cdk/aws-sns-subscriptions'; +import * as sns from 'aws-cdk-lib/aws-sns'; +import * as subscriptions from 'aws-cdk-lib/aws-sns-subscriptions'; const topic = new sns.Topic(this, 'SecurityChangesTopic'); topic.addSubscription(new subscriptions.EmailSubscription('test@email.com')); diff --git a/packages/aws-cdk-lib/pipelines/README.md b/packages/aws-cdk-lib/pipelines/README.md index 769e0714edffc..5b20b9059ebb6 100644 --- a/packages/aws-cdk-lib/pipelines/README.md +++ b/packages/aws-cdk-lib/pipelines/README.md @@ -261,7 +261,7 @@ const pipeline = new pipelines.CodePipeline(this, 'Pipeline', { }); ``` -The underlying `@aws-cdk/aws-codepipeline.Pipeline` construct will be produced +The underlying `aws-cdk-lib/aws-codepipeline.Pipeline` construct will be produced when `app.synth()` is called. You can also force it to be produced earlier by calling `pipeline.buildPipeline()`. After you've called that method, you can inspect the constructs that were produced by @@ -967,7 +967,7 @@ Docker can be used in 3 different places in the pipeline: images for your CodeBuild projects): Docker will run in the self-mutate project. - If you are using Docker to bundle file assets anywhere in your project (for example, if you are using such construct libraries as - `@aws-cdk/aws-lambda-nodejs`): Docker will run in the + `aws-cdk-lib/aws-lambda-nodejs`): Docker will run in the *synth* project. For the first case, you don't need to do anything special. For the other two cases, @@ -1021,7 +1021,7 @@ pipeline.addWave('MyWave', { ### Using bundled file assets If you are using asset bundling anywhere (such as automatically done for you -if you add a construct like `@aws-cdk/aws-lambda-nodejs`), you need to pass +if you add a construct like `aws-cdk-lib/aws-lambda-nodejs`), you need to pass `dockerEnabledForSynth: true` to the pipeline. For example: ```ts diff --git a/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts b/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts index 83e9e7528327d..dd425712b1cec 100644 --- a/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts +++ b/packages/aws-cdk-lib/pipelines/lib/codepipeline/codepipeline.ts @@ -131,7 +131,7 @@ export interface CodePipelineProps { * application stacks. * * A common way to use bundling assets in your application is by - * using the `@aws-cdk/aws-lambda-nodejs` library. + * using the `aws-cdk-lib/aws-lambda-nodejs` library. * * Configures privileged mode for the synth CodeBuild action. *