konokenj.cdk-api-mcp-server 0.1.0__py3-none-any.whl → 0.2.1__py3-none-any.whl

cdk_api_mcp_server/resources/aws-cdk/constructs/@aws-cdk/aws-neptune-alpha/README.md

@@ -0,0 +1,238 @@
+# Amazon Neptune Construct Library
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> The APIs of higher level constructs in this module are experimental and under active development.
+> They are subject to non-backward compatible changes or removal in any future version. These are
+> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
+> announced in the release notes. This means that while you may use them, you may need to update
+> your source code when upgrading to a newer version of this package.
+
+---
+
+<!--END STABILITY BANNER-->
+
+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-alpha` package contains primitives for setting up Neptune database clusters and instances.
+
+```ts nofixture
+import * as neptune from '@aws-cdk/aws-neptune-alpha';
+```
+
+## Starting a Neptune Database
+
+To set up a Neptune database, define a `DatabaseCluster`. You must always launch a database in a VPC.
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+});
+```
+
+By default only writer instance is provisioned with this construct.
+
+## Connecting
+
+To control who can access the cluster, use the `.connections` attribute. Neptune databases have a default port, so
+you don't need to specify the port:
+
+```ts fixture=with-cluster
+cluster.connections.allowDefaultPortFromAnyIpv4('Open to the world');
+```
+
+The endpoints to access your database cluster will be available as the `.clusterEndpoint` and `.clusterReadEndpoint`
+attributes:
+
+```ts fixture=with-cluster
+const writeAddress = cluster.clusterEndpoint.socketAddress;   // "HOSTNAME:PORT"
+```
+
+## IAM Authentication
+
+You can also authenticate to a database cluster using AWS Identity and Access Management (IAM) database authentication;
+See <https://docs.aws.amazon.com/neptune/latest/userguide/iam-auth.html> for more information and a list of supported
+versions and limitations.
+
+The following example shows enabling IAM authentication for a database cluster and granting connection access to an IAM role.
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'Cluster', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  iamAuthentication: true, // Optional - will be automatically set if you call grantConnect() or grant().
+});
+const role = new iam.Role(this, 'DBRole', { assumedBy: new iam.AccountPrincipal(this.account) });
+// Use one of the following statements to grant the role the necessary permissions
+cluster.grantConnect(role); // Grant the role neptune-db:* access to the DB
+cluster.grant(role, 'neptune-db:ReadDataViaQuery', 'neptune-db:WriteDataViaQuery'); // Grant the role the specified actions to the DB
+```
+
+## Customizing parameters
+
+Neptune allows configuring database behavior by supplying custom parameter groups.  For more details, refer to the
+following link: <https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html>
+
+```ts
+const clusterParams = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
+  description: 'Cluster parameter group',
+  parameters: {
+    neptune_enable_audit_log: '1'
+  },
+});
+
+const dbParams = new neptune.ParameterGroup(this, 'DbParams', {
+  description: 'Db parameter group',
+  parameters: {
+    neptune_query_timeout: '120000',
+  },
+});
+
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  clusterParameterGroup: clusterParams,
+  parameterGroup: dbParams,
+});
+```
+
+Note: To use the Neptune engine versions `1.2.0.0` or later, including the newly added `1.4` series, it's necessary to specify the appropriate `engineVersion` prop in `neptune.DatabaseCluster`. Additionally, for both 1.2,  1.3 and 1.4 series, the corresponding `family` prop must be set to `ParameterGroupFamily.NEPTUNE_1_2`, `ParameterGroupFamily.NEPTUNE_1_3` or `ParameterGroupFamily.NEPTUNE_1_4` respectively in `neptune.ClusterParameterGroup` and `neptune.ParameterGroup`.
+
+## Adding replicas
+
+`DatabaseCluster` allows launching replicas along with the writer instance. This can be specified using the `instanceCount`
+attribute.
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  instances: 2,
+});
+```
+
+Additionally, it is also possible to add replicas using `DatabaseInstance` for an existing cluster.
+
+```ts fixture=with-cluster
+const replica1 = new neptune.DatabaseInstance(this, 'Instance', {
+  cluster,
+  instanceType: neptune.InstanceType.R5_LARGE,
+});
+```
+
+## Automatic minor version upgrades
+
+By setting `autoMinorVersionUpgrade` to true, Neptune will automatically update
+the engine of the entire cluster to the latest minor version after a stabilization
+window of 2 to 3 weeks.
+
+```ts
+new neptune.DatabaseCluster(this, 'Cluster', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  autoMinorVersionUpgrade: true,
+});
+```
+
+You can also specify `autoMinorVersionUpgrade` to a database instance.
+Even within the same cluster, you can modify the `autoMinorVersionUpgrade` setting on a per-instance basis.
+
+```ts fixture=with-cluster
+new neptune.DatabaseInstance(this, 'Instance', {
+  cluster,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  autoMinorVersionUpgrade: true,
+});
+```
+
+## Port
+
+By default, Neptune uses port `8182`. You can override the default port by specifying the `port` property:
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  port: 12345,
+});
+```
+
+## Logging
+
+Neptune supports various methods for monitoring performance and usage. One of those methods is logging
+
+1. Neptune provides logs e.g. audit logs which can be viewed or downloaded via the AWS Console. Audit logs can be enabled using the `neptune_enable_audit_log` parameter in `ClusterParameterGroup` or `ParameterGroup`
+2. Neptune provides the ability to export those logs to CloudWatch Logs
+
+```ts
+// Cluster parameter group with the neptune_enable_audit_log param set to 1
+const clusterParameterGroup = new neptune.ClusterParameterGroup(this, 'ClusterParams', {
+  description: 'Cluster parameter group',
+  parameters: {
+    neptune_enable_audit_log: '1'
+  },
+});
+
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  // Audit logs are enabled via the clusterParameterGroup
+  clusterParameterGroup,
+  // Optionally configuring audit logs to be exported to CloudWatch Logs
+  cloudwatchLogsExports: [neptune.LogType.AUDIT],
+  // Optionally set a retention period on exported CloudWatch Logs
+  cloudwatchLogsRetention: logs.RetentionDays.ONE_MONTH,
+});
+```
+
+For more information on monitoring, refer to https://docs.aws.amazon.com/neptune/latest/userguide/monitoring.html.
+For more information on audit logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/auditing.html.
+For more information on exporting logs to CloudWatch Logs, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cloudwatch-logs.html.
+
+## Metrics
+
+Both `DatabaseCluster` and `DatabaseInstance` provide a `metric()` method to help with cluster-level and instance-level monitoring.
+
+```ts
+declare const cluster: neptune.DatabaseCluster;
+declare const instance: neptune.DatabaseInstance;
+
+cluster.metric('SparqlRequestsPerSec'); // cluster-level SparqlErrors metric
+instance.metric('SparqlRequestsPerSec') // instance-level SparqlErrors metric
+```
+
+For more details on the available metrics, refer to https://docs.aws.amazon.com/neptune/latest/userguide/cw-metrics.html
+
+## Copy tags to snapshot
+
+By setting `copyTagsToSnapshot` to true, all tags of the cluster are copied to the snapshots when they are created.
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'Database', {
+  vpc,
+  instanceType: neptune.InstanceType.R5_LARGE,
+  copyTagsToSnapshot: true  // whether to save the cluster tags when creating the snapshot.
+});
+```
+
+## Neptune Serverless
+
+You can configure a Neptune Serverless cluster using the dedicated instance type along with the
+`serverlessScalingConfiguration` property.
+
+> Visit [Using Amazon Neptune Serverless](https://docs.aws.amazon.com/neptune/latest/userguide/neptune-serverless-using.html) for more details.
+
+```ts
+const cluster = new neptune.DatabaseCluster(this, 'ServerlessDatabase', {
+  vpc,
+  instanceType: neptune.InstanceType.SERVERLESS,
+  serverlessScalingConfiguration: {
+    minCapacity: 1,
+    maxCapacity: 5,
+  },
+});
+```

cdk_api_mcp_server/resources/aws-cdk/constructs/@aws-cdk/aws-pipes-alpha/README.md

@@ -0,0 +1,463 @@
+# Amazon EventBridge Pipes Construct Library
+
+<!--BEGIN STABILITY BANNER-->
+
+---
+
+![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
+
+> The APIs of higher level constructs in this module are experimental and under active development.
+> They are subject to non-backward compatible changes or removal in any future version. These are
+> not subject to the [Semantic Versioning](https://semver.org/) model and breaking changes will be
+> announced in the release notes. This means that while you may use them, you may need to update
+> your source code when upgrading to a newer version of this package.
+
+---
+
+<!--END STABILITY BANNER-->
+
+
+EventBridge Pipes let you create source to target connections between several
+AWS services. While transporting messages from a source to a target the messages
+can be filtered, transformed and enriched.
+
+![diagram of pipes](https://d1.awsstatic.com/product-marketing/EventBridge/Product-Page-Diagram_Amazon-EventBridge-Pipes.cd7961854be4432d63f6158ffd18271d6c9fa3ec.png)
+
+For more details see the [service documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html).
+
+## Pipe
+
+[EventBridge Pipes](https://aws.amazon.com/blogs/aws/new-create-point-to-point-integrations-between-event-producers-and-consumers-with-amazon-eventbridge-pipes/)
+is a fully managed service that enables point-to-point integrations between
+event producers and consumers. Pipes can be used to connect several AWS services
+to each other, or to connect AWS services to external services.
+
+A pipe has a source and a target. The source events can be filtered and enriched
+before reaching the target.
+
+## Example - pipe usage
+
+> The following code examples use an example implementation of a [source](#source) and [target](#target).
+
+To define a pipe you need to create a new `Pipe` construct. The `Pipe` construct needs a source and a target.
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue),
+});
+```
+
+This minimal example creates a pipe with a SQS queue as source and a SQS queue as target.
+Messages from the source are put into the body of the target message.
+
+## Source
+
+A source is a AWS Service that is polled. The following sources are possible:
+
+- [Amazon DynamoDB stream](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-dynamodb.html)
+- [Amazon Kinesis stream](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kinesis.html)
+- [Amazon MQ broker](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-mq.html)
+- [Amazon MSK stream](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-msk.html)
+- [Amazon SQS queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-sqs.html)
+- [Apache Kafka stream](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-kafka.html)
+
+Currently, DynamoDB, Kinesis, and SQS are supported. If you are interested in support for additional sources,
+kindly let us know by opening a GitHub issue or raising a PR.
+
+### Example source
+
+```ts
+declare const sourceQueue: sqs.Queue;
+const pipeSource = new SqsSource(sourceQueue);
+```
+
+## Filter
+
+A filter can be used to filter the events from the source before they are
+forwarded to the enrichment or, if no enrichment is present, target step. Multiple filter expressions are possible.
+If one of the filter expressions matches, the event is forwarded to the enrichment or target step.
+
+### Example - filter usage
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+
+const sourceFilter = new pipes.Filter(
+  [
+    pipes.FilterPattern.fromObject({
+      body: {
+        // only forward events with customerType B2B or B2C
+        customerType: ['B2B', 'B2C'] 
+      },
+    })
+  ]
+)
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue),
+  filter: sourceFilter, 
+});
+```
+
+This example shows a filter that only forwards events with the `customerType` B2B or B2C from the source messages. Messages that are not matching the filter are not forwarded to the enrichment or target step.
+
+You can define multiple filter pattern which are combined with a logical `OR`.
+
+Additional filter pattern and details can be found in the EventBridge pipes [docs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-filtering.html).
+
+## Input transformation
+
+For enrichments and targets the input event can be transformed. The transformation is applied for each item of the batch.
+A transformation has access to the input event as well to some context information of the pipe itself like the name of the pipe.
+See [docs](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-input-transformation.html) for details.
+
+### Example - input transformation from object
+
+The input transformation can be created from an object. The object can contain static values, dynamic values or pipe variables.
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+
+const targetInputTransformation = pipes.InputTransformation.fromObject({
+  staticField: 'static value',
+  dynamicField: pipes.DynamicInput.fromEventPath('$.body.payload'),
+  pipeVariable: pipes.DynamicInput.pipeName,
+});
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  pipeName: 'MyPipe',
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue, {
+    inputTransformation: targetInputTransformation, 
+  }),
+});
+```
+
+This example shows a transformation that adds a static field, a dynamic field and a pipe variable to the input event. The dynamic field is extracted from the input event. The pipe variable is extracted from the pipe context.
+
+So when the following batch of input events is processed by the pipe
+
+```json
+[
+  {
+    ...
+    "body": "{\"payload\": \"Test message.\"}",
+    ...
+  }
+]
+```
+
+it is converted into the following payload:
+
+```json
+[
+  {
+    ...
+    "staticField": "static value",
+    "dynamicField": "Test message.",
+    "pipeVariable": "MyPipe",
+    ...
+  }
+]
+```
+
+If the transformation is applied to a target it might be converted to a string representation. For example, the resulting SQS message body looks like this:
+
+```json
+[
+  {
+    ...
+    "body": "{\"staticField\": \"static value\", \"dynamicField\": \"Test message.\", \"pipeVariable\": \"MyPipe\"}",
+    ...
+  }
+]
+```
+
+
+### Example - input transformation from event path
+
+In cases where you want to forward only a part of the event to the target you can use the transformation event path.
+
+> This only works for targets because the enrichment needs to have a valid json as input.
+
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+
+const targetInputTransformation = pipes.InputTransformation.fromEventPath('$.body.payload')
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue, {
+    inputTransformation: targetInputTransformation, 
+  }),
+});
+```
+
+This transformation extracts the body of the event.
+
+So when the following batch of input events is processed by the pipe
+
+```json
+ [
+  {
+    ...
+    "body": "\"{\"payload\": \"Test message.\"}\"",
+    ...
+  }
+]
+```
+
+it is converted into the following target payload:
+
+```json
+[
+  {
+    ...
+    "body": "Test message."
+    ...
+  }
+]
+```
+
+> The [implicit payload parsing](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-input-transformation.html#input-transform-implicit) (e.g. SQS message body to JSON) only works if the input is the source payload. Implicit body parsing is not applied on enrichment results.
+
+### Example - input transformation from text
+
+In cases where you want to forward a static text to the target or use your own formatted `inputTemplate` you can use the transformation from text.
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+
+const targetInputTransformation = pipes.InputTransformation.fromText('My static text');
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue, {
+    inputTransformation: targetInputTransformation, 
+  }),
+});
+```
+
+This transformation forwards the static text to the target.
+
+```json
+[
+  {
+    ...
+    "body": "My static text"
+    ...
+  }
+]
+```
+
+## Enrichment
+
+In the enrichment step the (un)filtered payloads from the source can be used to invoke one of the following services:
+
+- API destination
+- Amazon API Gateway
+- Lambda function
+- Step Functions state machine
+  - only express workflow
+
+### Example enrichment implementation
+
+> Currently no implementation exist for any of the supported enrichments. The following example shows how an implementation can look like. The actual implementation is not part of this package and will be in a separate one.
+
+```ts fixture=pipes-imports
+class LambdaEnrichment implements pipes.IEnrichment {
+  enrichmentArn: string;
+  private inputTransformation: pipes.InputTransformation  | undefined;
+  
+  constructor(private readonly lambda: lambda.Function, props: {inputTransformation?: pipes.InputTransformation} = {}) {
+    this.enrichmentArn = lambda.functionArn;
+    this.inputTransformation = props?.inputTransformation
+  }
+  
+  bind(pipe: pipes.IPipe): pipes.EnrichmentParametersConfig {
+    return {
+      enrichmentParameters: {
+        inputTemplate: this.inputTransformation?.bind(pipe).inputTemplate,
+      },
+    };
+  }
+  
+  grantInvoke(pipeRole: cdk.aws_iam.IRole): void {
+    this.lambda.grantInvoke(pipeRole);
+  }
+}
+```
+
+An enrichment implementation needs to provide the `enrichmentArn`, `enrichmentParameters` and grant the pipe role invoke access to the enrichment.
+
+### Example - enrichment usage
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+declare const enrichmentLambda: lambda.Function;
+
+const enrichmentInputTransformation = pipes.InputTransformation.fromObject({
+  staticField: 'static value',
+  dynamicField: pipes.DynamicInput.fromEventPath('$.body.payload'),
+  pipeVariable: pipes.DynamicInput.pipeName,
+});
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue),
+  enrichment: new LambdaEnrichment(enrichmentLambda, {
+    inputTransformation: enrichmentInputTransformation,
+  }),
+});
+```
+
+This example adds a lambda function as enrichment to the pipe. The lambda function is invoked with the batch of messages from the source after applying the transformation. The lambda function can return a result which is forwarded to the target.
+
+So the following batch of input events is processed by the pipe
+
+```json
+[
+  {
+    ...
+    "body": "{\"payload\": \"Test message.\"}",
+    ...
+  }
+]
+```
+
+it is converted into the following payload which is sent to the lambda function.
+
+```json
+[
+  {
+    ...
+    "staticField": "static value",
+    "dynamicField": "Test message.",
+    "pipeVariable": "MyPipe",
+    ...
+  }
+]
+```
+
+The lambda function can return a result which is forwarded to the target.
+For example a lambda function that returns a concatenation of the static field, dynamic field and pipe variable
+
+```ts nofixture
+export async function handler (event: any) {
+  return event.staticField + "-" + event.dynamicField + "-" + event.pipeVariable;
+};
+```
+
+will produce the following target message in the target SQS queue.
+
+```json
+[
+  {
+    ...
+    "body": "static value-Test message.-MyPipe",
+    ...
+  }
+]
+```
+
+## Target
+
+A Target is the end of the Pipe. After the payload from the source is pulled,
+filtered and enriched it is forwarded to the target. For now the following
+targets are supported:
+
+- [API destination](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-destinations.html)
+- [API Gateway](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-api-gateway-target.html)
+- [Batch job queue](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html#pipes-targets-specifics-batch)
+- [CloudWatch log group](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html#pipes-targets-specifics-cwl)
+- [ECS task](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html#pipes-targets-specifics-ecs-task)
+- Event bus in the same account and Region
+- Firehose delivery stream
+- Inspector assessment template
+- Kinesis stream
+- Lambda function (SYNC or ASYNC)
+- Redshift cluster data API queries
+- SageMaker Pipeline
+- SNS topic
+- SQS queue
+- Step Functions state machine
+  - Express workflows (ASYNC)
+  - Standard workflows (SYNC or ASYNC)
+
+The target event can be transformed before it is forwarded to the target using
+the same input transformation as in the enrichment step.
+
+### Example target
+
+```ts
+declare const targetQueue: sqs.Queue;
+const pipeTarget = new SqsTarget(targetQueue);
+```
+
+## Log destination
+
+A pipe can produce log events that are forwarded to different log destinations.
+You can configure multiple destinations, but all the destination share the same log level and log data.
+For details check the official [documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-logs.html).
+
+The log level and data that is included in the log events is configured on the pipe class itself.
+The actual destination is defined independently, and there are three options:
+
+1. `CloudwatchLogsLogDestination`
+2. `FirehoseLogDestination`
+3. `S3LogDestination`
+
+### Example log destination usage
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+declare const logGroup: logs.LogGroup;
+
+const cwlLogDestination = new pipes.CloudwatchLogsLogDestination(logGroup);
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue),
+  logLevel: pipes.LogLevel.TRACE,
+  logIncludeExecutionData: [pipes.IncludeExecutionData.ALL],
+  logDestinations: [cwlLogDestination],
+});
+```
+
+This example uses a CloudWatch Logs log group to store the log emitted during a pipe execution.
+The log level is set to `TRACE` so all steps of the pipe are logged.
+Additionally all execution data is logged as well.
+
+## Encrypt pipe data with KMS
+
+You can specify that EventBridge use a customer managed key to encrypt pipe data stored at rest,
+rather than use an AWS owned key as is the default.
+Details can be found in the [documentation](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-encryption-pipes-cmkey.html).
+
+To do this, you need to specify the key in the `kmsKey` property of the pipe.
+
+```ts
+declare const sourceQueue: sqs.Queue;
+declare const targetQueue: sqs.Queue;
+declare const kmsKey: kms.Key;
+
+const pipe = new pipes.Pipe(this, 'Pipe', {
+  source: new SqsSource(sourceQueue),
+  target: new SqsTarget(targetQueue),
+  kmsKey,
+  // pipeName is required when using a KMS key
+  pipeName: 'MyPipe',
+});
+```