@quadnix/octo-aws-cdk 0.0.11 → 0.0.13

package/dist/resources/alb-listener/index.schema.d.ts

@@ -0,0 +1,294 @@
+import { BaseResourceSchema } from '@quadnix/octo';
+/**
+ * Defines the types of actions on the ALB Listener.
+ * Possible values are `fixed-response`, `forward`, or `redirect`.
+ * These values are mapped from the official ALB Listener Action Types document.
+ * Please refer to the AWS documentation for more information.
+ *
+ * @group Resources/AlbListener
+ */
+export type IAlbListenerActionTypes = {
+    /**
+     * Sends a fixed HTTP response to the client.
+     */
+    'fixed-response': AlbListenerActionFixedResponseActionSchema;
+    /**
+     * Forwards requests to one or more target groups.
+     */
+    forward: AlbListenerActionForwardConfigSchema;
+    /**
+     * Redirects requests from one path to another.
+     */
+    redirect: AlbListenerActionRedirectActionSchema;
+};
+/**
+ * When the ALB receives an HTTP request, the ALB Listener evaluates rules
+ * to determine what to do with the request.
+ * This defines the types of rules on the ALB Listener.
+ * Possible values are `host-header`, `http-header`, `http-request-method`,
+ * `path-pattern`, `query-string`, or `source-ip`.
+ * These values are mapped from the official ALB Listener Rules document.
+ * Please refer to the AWS documentation for more information.
+ *
+ * The official documentation also imposes some restrictions on rules.
+ * It is important to review those restrictions, or else resource creation might fail and get into a dirty state.
+ *
+ * @group Resources/AlbListener
+ */
+export type IAlbListenerRuleTypes = {
+    /**
+     * Matches requests based on the value of the host header in the HTTP request.
+     */
+    'host-header': AlbListenerRuleHostHeaderConditionSchema;
+    /**
+     * Matches requests based on the value of a specified HTTP header in the HTTP request.
+     */
+    'http-header': AlbListenerRuleHttpHeaderConditionSchema;
+    /**
+     * Matches requests based on the HTTP method in the HTTP request.
+     */
+    'http-request-method': AlbListenerRuleHttpRequestMethodConditionSchema;
+    /**
+     * Matches requests based on the value of the path in the HTTP request.
+     */
+    'path-pattern': AlbListenerRulePathPatternConditionSchema;
+    /**
+     * Matches requests based on the value of the query string in the HTTP request.
+     */
+    'query-string': AlbListenerRuleQueryStringConditionSchema;
+    /**
+     * Matches requests based on the source IP address.
+     */
+    'source-ip': AlbListenerRuleSourceIpConditionSchema;
+};
+/**
+ * When sending a fixed HTTP response to the client, this ALB Listener Action defines the payload structure
+ * used by the ALB Listener to fulfill the request.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerActionFixedResponseActionSchema {
+    /**
+     * Value of the Content-Type HTTP header.
+     */
+    ContentType: string;
+    /**
+     * The fixed message to be sent in the HTTP response.
+     */
+    MessageBody: string;
+    /**
+     * Value of the HTTP status code returned to the client.
+     */
+    StatusCode: number;
+}
+/**
+ * When forwarding requests to one or more target groups, this ALB Listener Action defines the target groups
+ * the ALB Listener forwards requests to.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerActionForwardConfigSchema {
+    /**
+     * Definition of target group that will accept the request.
+     * You must specify the name of the target group, and the percentage of traffic to send to that target group.
+     *
+     * You set the name of the target group when you created the {@link AlbTargetGroupSchema} resource.
+     *
+     * For a single target group, you can use a weight of 100.
+     * For multiple target groups, the sum of the weights must be 100.
+     */
+    TargetGroups: {
+        targetGroupName: string;
+        Weight: number;
+    }[];
+    /**
+     * An optional configuration to instruct the load balancer on how to route requests to the targets.
+     * With stickiness enabled, the load balancer routes requests to the same target for the given duration.
+     */
+    TargetGroupStickinessConfig?: {
+        DurationSeconds: number;
+        Enabled: boolean;
+    } | null | undefined;
+}
+/**
+ * When sending a redirect HTTP response to the client, this ALB Listener Action defines the payload structure
+ * used by the ALB Listener to fulfill the request.
+ *
+ * The ALB is already configured to redirect to `protocol://hostname:port/path?query` where each part of the URL is
+ * derived from the original request. You must override at least one option to avoid infinite redirect loops.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerActionRedirectActionSchema {
+    /**
+     * Override the hostname in the redirect URL.
+     */
+    Host?: string | null | undefined;
+    /**
+     * Override the path in the redirect URL.
+     */
+    Path?: string | null | undefined;
+    /**
+     * Override the port in the redirect URL.
+     */
+    Port?: number | null | undefined;
+    /**
+     * Override the protocol in the redirect URL.
+     */
+    Protocol?: "HTTP" | "HTTPS" | null | undefined;
+    /**
+     * Override the query parameters in the redirect URL.
+     */
+    Query?: string | null | undefined;
+    /**
+     * HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
+     */
+    StatusCode: 301 | 302 | null;
+}
+/**
+ * Matches on the value of the Host header in the HTTP request.
+ * You must provide one or more hostnames to match on.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRuleHostHeaderConditionSchema {
+    Values: string[];
+}
+/**
+ * Matches on the value of the HTTP header in the HTTP request.
+ * You must specify the name of the HTTP header to match on, and provide one or more values to match on.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRuleHttpHeaderConditionSchema {
+    HttpHeaderName: string;
+    Values: string[];
+}
+/**
+ * Matches on the value of the HTTP request method.
+ * You must provide one or more HTTP methods to match on.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRuleHttpRequestMethodConditionSchema {
+    Values: string[];
+}
+/**
+ * Matches on the value of the path in the HTTP request.
+ * You must provide one or more paths to match on.
+ *
+ * For more information on use of wildcards, please refer to the AWS documentation.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRulePathPatternConditionSchema {
+    Values: string[];
+}
+/**
+ * Matches on the value of the query parameters in the HTTP request.
+ * You must provide one or more key-value pairs to match on,
+ * where the key is the name of the query to match, and the value is the value of the query to match.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRuleQueryStringConditionSchema {
+    Values: {
+        Key: string;
+        Value: string;
+    }[];
+}
+/**
+ * Matches on the source IP address of the request.
+ * You must provide one or more IP addresses to match on.
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ */
+export declare class AlbListenerRuleSourceIpConditionSchema {
+    Values: string[];
+}
+/**
+ * The `AlbListenerSchema` class is the schema for the `AlbListener` resource,
+ * which represents the AWS Application Load Balancer Listener resource.
+ * This resource can create a alb listener in AWS using the AWS JavaScript SDK V3 API.
+ * See [official sdk docs](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/elastic-load-balancing-v2/).
+ *
+ * @group Resources/AlbListener
+ *
+ * @hideconstructor
+ *
+ * @overrideProperty parents - This resource has parents.
+ * ```mermaid
+ * graph TD;
+ *   alb((Alb)) --> alb_listener((Alb<br>Listener))
+ *   alb_target_group((Alb<br>Target<br>Group)) --> alb_listener
+ * ```
+ * @overrideProperty resourceId - The resource id is of format `alb-listener-<alb-name>`
+ */
+export declare class AlbListenerSchema extends BaseResourceSchema {
+    /**
+     * Input properties.
+     * * `properties.awsAccountId` - The AWS account ID.
+     * * `properties.awsRegionId` - The AWS region ID.
+     * * `properties.DefaultActions` - Specify an action to run when none of the conditions are met.
+     * See {@link IAlbListenerActionTypes} for options.
+     * * `properties.Port` - The port on which the listener is listening.
+     * * `properties.Protocol` - The protocol to use. Valid values are `HTTP`.
+     * * `properties.rules` - Specify the rules for the listener.
+     * A rule must contain conditions as per {@link IAlbListenerRuleTypes},
+     * a set of actions to perform if the conditions are met as per {@link IAlbListenerActionTypes},
+     * and a priority which determines the order in which the rules are evaluated.
+     *
+     * @group Properties
+     */
+    properties: {
+        awsAccountId: string;
+        awsRegionId: string;
+        DefaultActions: { [A in keyof IAlbListenerActionTypes]-?: {
+            action: IAlbListenerActionTypes[A];
+            actionType: A;
+        }; }[keyof IAlbListenerActionTypes][];
+        Port: number;
+        Protocol: "HTTP";
+        rules: {
+            actions: { [A in keyof IAlbListenerActionTypes]-?: {
+                action: IAlbListenerActionTypes[A];
+                actionType: A;
+            }; }[keyof IAlbListenerActionTypes][];
+            conditions: { [R in keyof IAlbListenerRuleTypes]-?: {
+                condition: IAlbListenerRuleTypes[R];
+                conditionType: R;
+            }; }[keyof IAlbListenerRuleTypes][];
+            Priority: number;
+        }[];
+    };
+    /**
+     * Saved response.
+     * * `response.ListenerArn` - ALB Listener ARN.
+     * * `response.Rules` - An array of ALB Listener Rule ARNs and priorities.
+     */
+    response: {
+        ListenerArn?: string;
+        Rules?: {
+            Priority: number;
+            RuleArn: string;
+        }[];
+    };
+}