@gradientedge/cdk-utils 5.13.0 → 6.0.1

package/dist/src/lib/construct/api-to-eventbridge-target-with-sns/main.d.ts

@@ -0,0 +1,193 @@
+import * as secretsmanager from 'aws-cdk-lib/aws-secretsmanager';
+import { Construct } from 'constructs';
+import { CommonConstruct } from '../../common';
+import * as types from '../../types';
+/**
+ * @stability stable
+ * @category cdk-utils.api-to-eventbridge-target
+ * @subcategory construct
+ * @classdesc Provides a construct to create and deploy API Gateway invocations to EventBridge
+ *
+ * <b>Architecture</b> ![Architecture](./ApiToEventBridgeTargetWithSns.jpg)
+ *
+ * @example
+ * import { ApiToEventBridgeTargetWithSns, ApiToEventBridgeTargetProps } '@gradientedge/cdk-utils'
+ * import { Construct } from 'constructs'
+ *
+ * class CustomConstruct extends ApiToEventBridgeTargetWithSns {
+ *   constructor(parent: Construct, id: string, props: ApiToEventBridgeTargetProps) {
+ *     super(parent, id, props)
+ *     this.props = props
+ *     this.id = id
+ *     this.initResources()
+ *   }
+ * }
+ *
+ */
+export declare class ApiToEventBridgeTargetWithSns extends CommonConstruct {
+    props: types.ApiToEventBridgeTargetProps;
+    id: string;
+    applicationSecrets: secretsmanager.ISecret[];
+    apiDestinedLambda: types.ApiDestinedLambdaType;
+    apiEvent: types.ApiToEventBridgeTargetEventType;
+    apiDestinedRestApi: types.ApiToEventBridgeTargetRestApiType;
+    apiResource: string;
+    constructor(parent: Construct, id: string, props: types.ApiToEventBridgeTargetProps);
+    protected initResources(): void;
+    /**
+     * @summary Method to resolve secrets from SecretsManager
+     * - To be implemented in the overriding method in the implementation class
+     * @protected
+     */
+    protected resolveSecrets(): void;
+    /**
+     * @summary Method to resolve a hosted zone based on domain attributes
+     * @protected
+     */
+    protected resolveHostedZone(): void;
+    /**
+     * @summary Method to resolve a certificate based on attributes
+     * @protected
+     */
+    protected resolveCertificate(): void;
+    /**
+     * @summary Method to create iam policy for Api Destined Lambda function
+     * @protected
+     */
+    protected createApiDestinedLambdaPolicy(): void;
+    /**
+     * @summary Method to create iam role for Api Destined Lambda function
+     * @protected
+     */
+    protected createApiDestinedLambdaRole(): void;
+    /**
+     * @summary Method to create environment variables for Api Destined Lambda function
+     * @protected
+     */
+    protected createApiDestinedLambdaEnvironment(): void;
+    /**
+     * @summary Method to create layers for Api Destined Lambda function
+     * @protected
+     */
+    protected createApiDestinedLambdaLayers(): void;
+    /**
+     * @summary Method to create destination for Api Destined function
+     * @protected
+     */
+    protected createApiDestinedLambdaDestinations(): void;
+    /**
+     * @summary Method to create lambda function for Api Destined
+     * @protected
+     */
+    protected createApiDestinedLambdaFunction(): void;
+    /**
+     * @summary Method to create or use an existing eventbus for api destined payload deliveries
+     * @protected
+     */
+    protected createApiDestinedEventBus(): void;
+    /**
+     * @summary Method to create a log group for successful api destined payload deliveries
+     * @protected
+     */
+    protected createApiDestinationLogGroupSuccess(): void;
+    /**
+     * Method to create EventBridge rule with lambda target for success
+     * @protected
+     */
+    protected createApiDestinationRuleSuccess(): void;
+    /**
+     * @summary Method to create a log group for failed api destined payload deliveries
+     * @protected
+     */
+    protected createApiDestinationLogGroupFailure(): void;
+    /**
+     * Method to create EventBridge rule with lambda target for failure
+     * @protected
+     */
+    protected createApiDestinationRuleFailure(): void;
+    /**
+     * @summary Method to create a role for sns topic
+     * @protected
+     */
+    protected createApiDestinedTopicRole(): void;
+    /**
+     * @summary Method to create API destined SNS topic
+     * @protected
+     */
+    protected createApiDestinedTopic(): void;
+    /**
+     * @summary Method to create api integration request parameters
+     * @protected
+     */
+    protected createApiDestinedIntegrationRequestParameters(): void;
+    /**
+     * @summary Method to create api integration request templates
+     * @protected
+     */
+    protected createApiDestinedIntegrationRequestTemplates(): void;
+    /**
+     * @summary Method to create api integration response
+     * @protected
+     */
+    protected createApiDestinedIntegrationResponse(): void;
+    /**
+     * @summary Method to create api integration error response
+     * @protected
+     */
+    protected createApiDestinedIntegrationErrorResponse(): void;
+    /**
+     * @summary Method to create api integration
+     * @protected
+     */
+    protected createApiDestinedIntegration(): void;
+    /**
+     * @summary Method to create api integration method response
+     * @protected
+     */
+    protected createApiDestinedMethodResponse(): void;
+    /**
+     * @summary Method to create api integration method error response
+     * @protected
+     */
+    protected createApiDestinedMethodErrorResponse(): void;
+    /**
+     * @summary Method to create rest restApi for Api
+     * @protected
+     */
+    protected createApiDestinedRestApi(): void;
+    /**
+     * @summary Method to create api integration response model
+     * @protected
+     */
+    protected createApiDestinedResponseModel(): void;
+    /**
+     * @summary Method to create api integration error response model
+     * @protected
+     */
+    protected createApiDestinedErrorResponseModel(): void;
+    /**
+     * @summary Method to create api integration resource
+     * @protected
+     */
+    protected createApiDestinedResource(): void;
+    /**
+     * @summary Method to create api integration resource method
+     * @protected
+     */
+    protected createApiDestinedResourceMethod(): void;
+    /**
+     * @summary Method to create custom restApi domain for Api API
+     * @protected
+     */
+    protected createApiDomain(): void;
+    /**
+     * @summary Method to create base path mappings for Api API
+     * @protected
+     */
+    protected createApiBasePathMapping(): void;
+    /**
+     * @summary Method to create route53 records for Api API
+     * @protected
+     */
+    protected createApiRouteAssets(): void;
+}