@aws-cdk/mixins-preview 2.243.0-alpha.0 → 2.245.0-alpha.0

package/README.md

@@ -1,4 +1,12 @@
-# CDK Mixins (Preview)
+# CDK Mixins
+
+
+> **Note**: The core Mixins mechanism  is now GA  and available in `constructs` and `aws-cdk-lib` (`Mixins`, `Mixin`, `IMixin`, `MixinApplicator`, `ConstructSelector`).
+> All service Mixins are now available in `aws-cdk-lib`.
+> Please update your imports.
+>
+> This package continues to provide **Logs Delivery Mixins** and **EventBridge Event Facades**, which are still experimental.
+
 <!--BEGIN STABILITY BANNER-->
 
 ---
@@ -15,14 +23,6 @@
 
 <!--END STABILITY BANNER-->
 
-> **Note**: The core Mixins mechanism (`Mixins`, `Mixin`, `IMixin`, `MixinApplicator`, `ConstructSelector`) is now available in `constructs` and `aws-cdk-lib`.
-> All service Mixins are now available in `aws-cdk-lib`.
-> Please update your imports.
->
-> This package continues to provide **Logs Delivery Mixins** and **EventBridge Event Facades**.
-
----
-
 CDK Mixins provide a new, advanced way to add functionality through composable abstractions.
 Unlike traditional L2 constructs that bundle all features together, Mixins allow you to pick and choose exactly the capabilities you need for constructs.
 Mixins can be applied during or after construct construction.
@@ -148,9 +148,13 @@ distribution
 
 ## EventBridge Event Patterns
 
-CDK Mixins automatically generates typed EventBridge event patterns for AWS resources. These patterns work with both L1 and L2 constructs, providing a consistent interface for creating EventBridge rules.
+CDK Mixins automatically generates typed EventBridge event patterns for AWS resources. These patterns come in two flavors: **resource-specific** and **standalone**.
+
+### Resource-Specific Event Patterns
+
+Resource-specific patterns are created by attaching a resource reference (e.g. an S3 bucket). The resource identifier is automatically injected into the event pattern, so calling a pattern method with no arguments still filters events to that specific resource. For example, an S3 `objectCreatedPattern()` will automatically include the bucket name in the pattern, meaning it only matches events from that particular bucket.
 
-### Event Patterns Basic Usage
+#### Event Patterns Basic Usage
 
 ```typescript
 import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
@@ -182,9 +186,7 @@ new events.CfnRule(scope, 'CfnRule', {
 });
 ```
 
-### Event Pattern Features
-
-**Automatic Resource Injection**: Resource identifiers are automatically included in patterns
+#### Event Pattern Features
 
 ```typescript
 import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
@@ -212,6 +214,62 @@ const pattern = bucketEvents.objectCreatedPattern({
 });
 ```
 
+### Standalone Event Patterns
+
+Standalone patterns are not tied to any specific resource. They match events across all resources of that type. For example, a standalone `awsAPICallViaCloudTrailPattern()` will match CloudTrail API calls for all S3 buckets in the account, not just a specific one.
+
+#### Event Patterns Basic Usage
+
+```typescript
+import { AWSAPICallViaCloudTrail, ObjectCreated, ObjectDeleted } from '@aws-cdk/mixins-preview/aws-s3/events';
+import * as events from 'aws-cdk-lib/aws-events';
+import * as targets from 'aws-cdk-lib/aws-events-targets';
+
+declare const fn: lambda.Function;
+
+// Works with L2 Rule
+new events.Rule(scope, 'Rule', {
+  eventPattern: AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern({
+    tlsDetails: { tlsVersion: ['TLSv1.3'] },
+    eventMetadata: { region: ['us-east-1'] },
+  }),
+  targets: [new targets.LambdaFunction(fn)]
+});
+
+// Also works with L1 CfnRule
+new events.CfnRule(scope, 'CfnRule', {
+  state: 'ENABLED',
+  eventPattern: AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern({
+    tlsDetails: { tlsVersion: ['TLSv1.3'] },
+    eventMetadata: { region: ['us-east-1'] },
+  }),
+  targets: [{ arn: fn.functionArn, id: 'L1' }]
+});
+```
+
+#### Event Pattern Features
+
+```typescript
+import { AWSAPICallViaCloudTrail } from '@aws-cdk/mixins-preview/aws-s3/events';
+
+// Matches CloudTrail API calls across ALL S3 buckets
+const pattern = AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern();
+```
+
+**Event Metadata Support**: Control EventBridge pattern metadata
+
+```typescript
+import { AWSAPICallViaCloudTrail } from '@aws-cdk/mixins-preview/aws-s3/events';
+import * as events from 'aws-cdk-lib/aws-events';
+
+const pattern = AWSAPICallViaCloudTrail.awsAPICallViaCloudTrailPattern({
+  eventMetadata: {
+    region: events.Match.prefix('us-'),
+    version: ['0']
+  }
+});
+```
+
 ### Available Events
 
 Event patterns are generated for EventBridge events available in the AWS Event Schema Registry. Common examples:
@@ -226,5 +284,9 @@ Event patterns are generated for EventBridge events available in the AWS Event S
 Import events from service-specific modules:
 
 ```typescript
+// Resource-specific (filters to a specific bucket)
 import { BucketEvents } from '@aws-cdk/mixins-preview/aws-s3/events';
+
+// Standalone (matches across all buckets)
+import { AWSAPICallViaCloudTrail, ObjectCreated, ObjectDeleted } from '@aws-cdk/mixins-preview/aws-s3/events';
 ```

package/lib/services/aws-apigateway/.jsiirc.json

@@ -0,0 +1,16 @@
+{
+  "targets": {
+    "java": {
+      "package": "software.amazon.awscdk.mixins.preview.services.apigateway"
+    },
+    "dotnet": {
+      "namespace": "Amazon.CDK.Mixins.Preview.AWS.ApiGateway"
+    },
+    "python": {
+      "module": "aws_cdk.mixins_preview.aws_apigateway"
+    },
+    "go": {
+      "packageName": "previewawsapigateway"
+    }
+  }
+}

package/lib/services/aws-apigateway/.mixins.jsiirc.json

@@ -0,0 +1,16 @@
+{
+  "targets": {
+    "java": {
+      "package": "software.amazon.awscdk.mixins.preview.services.apigateway.mixins"
+    },
+    "dotnet": {
+      "namespace": "Amazon.CDK.Mixins.Preview.AWS.ApiGateway.Mixins"
+    },
+    "python": {
+      "module": "aws_cdk.mixins_preview.aws_apigateway.mixins"
+    },
+    "go": {
+      "packageName": "previewawsapigatewaymixins"
+    }
+  }
+}

package/lib/services/aws-apigateway/index.d.ts

@@ -0,0 +1 @@
+export * as mixins from './mixins';

package/lib/services/aws-apigateway/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mixins = void 0;
+exports.mixins = require("./mixins");

package/lib/services/aws-apigateway/logs-delivery-mixins.generated.d.ts

@@ -0,0 +1,248 @@
+import * as cdk from "aws-cdk-lib/core";
+import * as interfaces from "aws-cdk-lib/interfaces";
+import * as constructs from "constructs";
+import * as logsDelivery from "../aws-logs/logs-delivery";
+import * as service from "aws-cdk-lib/aws-apigateway";
+/**
+ * Builder for CfnRestApiLogsMixin to generate EXECUTION_LOGS for CfnRestApi
+ *
+ * @cloudformationResource AWS::ApiGateway::RestApi
+ * @logType EXECUTION_LOGS
+ * @stability external
+ */
+export declare class CfnRestApiExecutionLogs {
+    /**
+     * Send logs to an S3 Bucket
+     *
+     * @param props Additional properties that are optionally used in log delivery for S3 destinations
+     */
+    toS3(bucket: interfaces.aws_s3.IBucketRef, props?: CfnRestApiExecutionLogsS3Props): CfnRestApiLogsMixin;
+    /**
+     * Send logs to a CloudWatch Log Group
+     *
+     * @param props Additional properties that are optionally used in log delivery for Log Group destinations
+     */
+    toLogGroup(logGroup: interfaces.aws_logs.ILogGroupRef, props?: CfnRestApiExecutionLogsLogGroupProps): CfnRestApiLogsMixin;
+    /**
+     * Send logs to a Firehose Delivery Stream
+     *
+     * @param props Additional properties that are optionally used in log delivery for Firehose destinations
+     */
+    toFirehose(deliveryStream: interfaces.aws_kinesisfirehose.IDeliveryStreamRef, props?: CfnRestApiExecutionLogsFirehoseProps): CfnRestApiLogsMixin;
+    /**
+     * Delivers logs to a pre-created delivery destination
+     *
+     * Supported destinations are S3, CWL, FH
+     * You are responsible for setting up the correct permissions for your delivery destination, toDestination() does not set up any permissions for you.
+     * Delivery destinations that are imported from another stack using CfnDeliveryDestination.fromDeliveryDestinationArn() or CfnDeliveryDestination.fromDeliveryDestinationName() are supported by toDestination().
+     *
+     * @param props Additional properties that are optionally used in log delivery for destinations
+     */
+    toDestination(destination: interfaces.aws_logs.IDeliveryDestinationRef, props?: CfnRestApiExecutionLogsDestProps): CfnRestApiLogsMixin;
+}
+/**
+ * Builder for CfnRestApiLogsMixin to generate ACCESS_LOGS for CfnRestApi
+ *
+ * @cloudformationResource AWS::ApiGateway::RestApi
+ * @logType ACCESS_LOGS
+ * @stability external
+ */
+export declare class CfnRestApiAccessLogs {
+    /**
+     * Send logs to an S3 Bucket
+     *
+     * @param props Additional properties that are optionally used in log delivery for S3 destinations
+     */
+    toS3(bucket: interfaces.aws_s3.IBucketRef, props?: CfnRestApiAccessLogsS3Props): CfnRestApiLogsMixin;
+    /**
+     * Send logs to a CloudWatch Log Group
+     *
+     * @param props Additional properties that are optionally used in log delivery for Log Group destinations
+     */
+    toLogGroup(logGroup: interfaces.aws_logs.ILogGroupRef, props?: CfnRestApiAccessLogsLogGroupProps): CfnRestApiLogsMixin;
+    /**
+     * Send logs to a Firehose Delivery Stream
+     *
+     * @param props Additional properties that are optionally used in log delivery for Firehose destinations
+     */
+    toFirehose(deliveryStream: interfaces.aws_kinesisfirehose.IDeliveryStreamRef, props?: CfnRestApiAccessLogsFirehoseProps): CfnRestApiLogsMixin;
+    /**
+     * Delivers logs to a pre-created delivery destination
+     *
+     * Supported destinations are S3, CWL, FH
+     * You are responsible for setting up the correct permissions for your delivery destination, toDestination() does not set up any permissions for you.
+     * Delivery destinations that are imported from another stack using CfnDeliveryDestination.fromDeliveryDestinationArn() or CfnDeliveryDestination.fromDeliveryDestinationName() are supported by toDestination().
+     *
+     * @param props Additional properties that are optionally used in log delivery for destinations
+     */
+    toDestination(destination: interfaces.aws_logs.IDeliveryDestinationRef, props?: CfnRestApiAccessLogsDestProps): CfnRestApiLogsMixin;
+}
+/**
+ * The `AWS::ApiGateway::RestApi` resource creates a REST API.
+ *
+ * For more information, see [restapi:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateRestApi.html) in the *Amazon API Gateway REST API Reference* .
+ *
+ * > On January 1, 2016, the Swagger Specification was donated to the [OpenAPI initiative](https://docs.aws.amazon.com/https://www.openapis.org/) , becoming the foundation of the OpenAPI Specification.
+ *
+ * @cloudformationResource AWS::ApiGateway::RestApi
+ * @mixin true
+ * @stability external
+ * @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
+ */
+export declare class CfnRestApiLogsMixin extends cdk.Mixin implements constructs.IMixin {
+    static readonly EXECUTION_LOGS: CfnRestApiExecutionLogs;
+    static readonly ACCESS_LOGS: CfnRestApiAccessLogs;
+    protected readonly logType: string;
+    protected readonly logDelivery: logsDelivery.ILogsDelivery;
+    /**
+     * Create a mixin to enable vended logs for `AWS::ApiGateway::RestApi`.
+     *
+     * @param logType Type of logs that are getting vended
+     * @param logDelivery Object in charge of setting up the delivery source, delivery destination, and delivery connection
+     */
+    constructor(logType: string, logDelivery: logsDelivery.ILogsDelivery);
+    /**
+     * Check if this mixin supports the given construct (has vendedLogs property)
+     */
+    supports(construct: constructs.IConstruct): construct is service.CfnRestApi;
+    /**
+     * Apply vended logs configuration to the construct
+     */
+    applyTo(resource: constructs.IConstruct): void;
+}
+/**
+ * Output Format options for each destination of CfnRestApiExecutionLogs.
+ */
+export declare class CfnRestApiExecutionLogsOutputFormat {
+}
+export declare namespace CfnRestApiExecutionLogsOutputFormat {
+    enum S3 {
+        JSON = "json",
+        PLAIN = "plain",
+        W3C = "w3c",
+        PARQUET = "parquet"
+    }
+    enum LogGroup {
+        PLAIN = "plain",
+        JSON = "json"
+    }
+    enum Firehose {
+        JSON = "json",
+        PLAIN = "plain",
+        RAW = "raw"
+    }
+}
+export declare enum CfnRestApiExecutionLogsRecordFields {
+    RESOURCE_ARN = "resource_arn",
+    EVENT_TIMESTAMP = "event_timestamp",
+    STAGE = "stage",
+    PAYLOAD = "payload"
+}
+export interface CfnRestApiExecutionLogsS3Props {
+    /**
+     * Encrpytion key for your delivery bucket
+     */
+    readonly encryptionKey?: interfaces.aws_kms.IKeyRef;
+    /**
+     * Format for log output, options are json,plain,w3c,parquet
+     */
+    readonly outputFormat?: CfnRestApiExecutionLogsOutputFormat.S3;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiExecutionLogsRecordFields>;
+}
+export interface CfnRestApiExecutionLogsLogGroupProps {
+    /**
+     * Format for log output, options are plain,json
+     */
+    readonly outputFormat?: CfnRestApiExecutionLogsOutputFormat.LogGroup;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiExecutionLogsRecordFields>;
+}
+export interface CfnRestApiExecutionLogsFirehoseProps {
+    /**
+     * Format for log output, options are json,plain,raw
+     */
+    readonly outputFormat?: CfnRestApiExecutionLogsOutputFormat.Firehose;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiExecutionLogsRecordFields>;
+}
+export interface CfnRestApiExecutionLogsDestProps {
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiExecutionLogsRecordFields>;
+}
+/**
+ * Output Format options for each destination of CfnRestApiAccessLogs.
+ */
+export declare class CfnRestApiAccessLogsOutputFormat {
+}
+export declare namespace CfnRestApiAccessLogsOutputFormat {
+    enum S3 {
+        JSON = "json",
+        PLAIN = "plain",
+        W3C = "w3c",
+        PARQUET = "parquet"
+    }
+    enum LogGroup {
+        PLAIN = "plain",
+        JSON = "json"
+    }
+    enum Firehose {
+        JSON = "json",
+        PLAIN = "plain",
+        RAW = "raw"
+    }
+}
+export declare enum CfnRestApiAccessLogsRecordFields {
+    RESOURCE_ARN = "resource_arn",
+    EVENT_TIMESTAMP = "event_timestamp",
+    STAGE = "stage",
+    PAYLOAD = "payload"
+}
+export interface CfnRestApiAccessLogsS3Props {
+    /**
+     * Encrpytion key for your delivery bucket
+     */
+    readonly encryptionKey?: interfaces.aws_kms.IKeyRef;
+    /**
+     * Format for log output, options are json,plain,w3c,parquet
+     */
+    readonly outputFormat?: CfnRestApiAccessLogsOutputFormat.S3;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiAccessLogsRecordFields>;
+}
+export interface CfnRestApiAccessLogsLogGroupProps {
+    /**
+     * Format for log output, options are plain,json
+     */
+    readonly outputFormat?: CfnRestApiAccessLogsOutputFormat.LogGroup;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiAccessLogsRecordFields>;
+}
+export interface CfnRestApiAccessLogsFirehoseProps {
+    /**
+     * Format for log output, options are json,plain,raw
+     */
+    readonly outputFormat?: CfnRestApiAccessLogsOutputFormat.Firehose;
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiAccessLogsRecordFields>;
+}
+export interface CfnRestApiAccessLogsDestProps {
+    /**
+     * Record fields that can be provided to a log delivery
+     */
+    readonly recordFields?: Array<CfnRestApiAccessLogsRecordFields>;
+}