@propulsionworks/cloudformation 0.0.1 → 0.1.0

package/out/exports/resources.generated/aws-apigateway-method.d.ts

@@ -0,0 +1,174 @@
+import type { ResourceDefinition } from "../main.ts";
+export type ApiGatewayMethod = ResourceDefinition<"AWS::ApiGateway::Method", ApiGatewayMethodProps>;
+/**
+ * The `AWS::ApiGateway::Method` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
+ */
+export type ApiGatewayMethodProps = {
+    /**
+     * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
+     */
+    ApiKeyRequired?: boolean | undefined;
+    /**
+     * A list of authorization scopes configured on the method. The scopes are used with a `COGNITO_USER_POOLS` authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
+     */
+    AuthorizationScopes?: string[] | undefined;
+    /**
+     * The method's authorization type. This parameter is required. For valid values, see [Method](https://docs.aws.amazon.com/apigateway/latest/api/API_Method.html) in the *API Gateway API Reference* .
+     *
+     * > If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.
+     */
+    AuthorizationType?: string | undefined;
+    /**
+     * The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS` .
+     */
+    AuthorizerId?: string | undefined;
+    /**
+     * The method's HTTP verb.
+     */
+    HttpMethod: string;
+    /**
+     * Represents an `HTTP` , `HTTP_PROXY` , `AWS` , `AWS_PROXY` , or Mock integration.
+     */
+    Integration?: Integration | undefined;
+    /**
+     * Gets a method response associated with a given HTTP status code.
+     */
+    MethodResponses?: MethodResponse[] | undefined;
+    /**
+     * A human-friendly operation identifier for the method. For example, you can assign the `operationName` of `ListPets` for the `GET /pets` method in the `PetStore` example.
+     */
+    OperationName?: string | undefined;
+    /**
+     * A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
+     */
+    RequestModels?: Record<string, string> | undefined;
+    /**
+     * A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required ( `true` ) or optional ( `false` ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
+     */
+    RequestParameters?: Record<string, boolean | string> | undefined;
+    /**
+     * The identifier of a RequestValidator for request validation.
+     */
+    RequestValidatorId?: string | undefined;
+    /**
+     * The Resource identifier for the MethodResponse resource.
+     */
+    ResourceId: string;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+};
+/**
+ * `Integration` is a property of the [AWS::ApiGateway::Method](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html) resource that specifies information about the target backend that a method calls.
+ */
+export type Integration = {
+    /**
+     * A list of request parameters whose values API Gateway caches. To be valid values for `cacheKeyParameters` , these parameters must also be specified for Method `requestParameters` .
+     */
+    CacheKeyParameters?: string[] | undefined;
+    /**
+     * Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the `cacheNamespace` . You can specify the same `cacheNamespace` across resources to return the same cached data for requests to different resources.
+     */
+    CacheNamespace?: string | undefined;
+    /**
+     * The ID of the VpcLink used for the integration when `connectionType=VPC_LINK` and undefined, otherwise.
+     */
+    ConnectionId?: string | undefined;
+    /**
+     * The type of the network connection to the integration endpoint. The valid value is `INTERNET` for connections through the public routable internet or `VPC_LINK` for private connections between API Gateway and a network load balancer in a VPC. The default value is `INTERNET` .
+     */
+    ConnectionType?: "INTERNET" | "VPC_LINK" | undefined;
+    /**
+     * Specifies how to handle request payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:
+     *
+     * If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the `passthroughBehavior` is configured to support payload pass-through.
+     */
+    ContentHandling?: "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT" | undefined;
+    /**
+     * Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string `arn:aws:iam::\*:user/\*` . To use resource-based permissions on supported AWS services, specify null.
+     */
+    Credentials?: string | undefined;
+    /**
+     * Specifies the integration's HTTP method type. For the Type property, if you specify `MOCK` , this property is optional. For Lambda integrations, you must set the integration method to `POST` . For all other types, you must specify this property.
+     */
+    IntegrationHttpMethod?: string | undefined;
+    /**
+     * Specifies the integration's responses.
+     */
+    IntegrationResponses?: IntegrationResponse[] | undefined;
+    /**
+     * Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in `requestTemplates` . The valid value is one of the following: `WHEN_NO_MATCH` : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. `WHEN_NO_TEMPLATES` : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. `NEVER` : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
+     */
+    PassthroughBehavior?: "WHEN_NO_MATCH" | "WHEN_NO_TEMPLATES" | "NEVER" | undefined;
+    /**
+     * A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of `method.request.{location}.{name}` , where `location` is `querystring` , `path` , or `header` and `name` must be a valid and unique method request parameter name.
+     */
+    RequestParameters?: Record<string, string> | undefined;
+    /**
+     * Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
+     */
+    RequestTemplates?: Record<string, string> | undefined;
+    /**
+     * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
+     * @min 50
+     */
+    TimeoutInMillis?: number | undefined;
+    /**
+     * Specifies an API method integration type. The valid value is one of the following:
+     *
+     * For the HTTP and HTTP proxy integrations, each integration can specify a protocol ( `http/https` ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a `connectionType` of `VPC_LINK` is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
+     */
+    Type: "AWS" | "AWS_PROXY" | "HTTP" | "HTTP_PROXY" | "MOCK";
+    /**
+     * Specifies Uniform Resource Identifier (URI) of the integration endpoint.
+     *
+     * For `HTTP` or `HTTP_PROXY` integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. If `connectionType` is `VPC_LINK` specify the Network Load Balancer DNS name. For `AWS` or `AWS_PROXY` integrations, the URI is of the form `arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}` . Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated AWS service (e.g., s3); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either `arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}` or `arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}`
+     */
+    Uri?: string | undefined;
+};
+/**
+ * `IntegrationResponse` is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.
+ */
+export type IntegrationResponse = {
+    /**
+     * Specifies how to handle response payload content type conversions. Supported values are `CONVERT_TO_BINARY` and `CONVERT_TO_TEXT` , with the following behaviors:
+     *
+     * If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
+     */
+    ContentHandling?: "CONVERT_TO_BINARY" | "CONVERT_TO_TEXT" | undefined;
+    /**
+     * A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of `method.response.header.{name}` , where `name` is a valid and unique header name. The mapped non-static value must match the pattern of `integration.response.header.{name}` or `integration.response.body.{JSON-expression}` , where `name` is a valid and unique response header name and `JSON-expression` is a valid JSON expression without the `$` prefix.
+     */
+    ResponseParameters?: Record<string, string> | undefined;
+    /**
+     * Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
+     */
+    ResponseTemplates?: Record<string, string> | undefined;
+    /**
+     * Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the `.+` regex to match error response. However, make sure that the error response does not contain any newline ( `\n` ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
+     */
+    SelectionPattern?: string | undefined;
+    /**
+     * Specifies the status code that is used to map the integration response to an existing MethodResponse.
+     */
+    StatusCode: string;
+};
+/**
+ * Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
+ */
+export type MethodResponse = {
+    /**
+     * Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
+     */
+    ResponseModels?: Record<string, string> | undefined;
+    /**
+     * A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern `method.response.header.{name}` , where `name` is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in `integration.response.header.{name}` , a static value enclosed within a pair of single quotes (e.g., `'application/json'` ), or a JSON expression from the back-end response payload in the form of `integration.response.body.{JSON-expression}` , where `JSON-expression` is a valid JSON expression without the `$` prefix.)
+     */
+    ResponseParameters?: Record<string, boolean | string> | undefined;
+    /**
+     * The method response's status code.
+     */
+    StatusCode: string;
+};
+//# sourceMappingURL=aws-apigateway-method.d.ts.map

package/out/exports/resources.generated/aws-apigateway-model.d.ts

@@ -0,0 +1,30 @@
+import type { ResourceDefinition } from "../main.ts";
+export type ApiGatewayModel = ResourceDefinition<"AWS::ApiGateway::Model", ApiGatewayModelProps>;
+/**
+ * The `AWS::ApiGateway::Model` resource defines the structure of a request or response payload for an API method.
+ */
+export type ApiGatewayModelProps = {
+    /**
+     * The content-type for the model.
+     */
+    ContentType?: string | undefined;
+    /**
+     * The description of the model.
+     */
+    Description?: string | undefined;
+    /**
+     * A name for the model. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see [Name Type](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-name.html) .
+     *
+     * > If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
+     */
+    Name?: string | undefined;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * The schema for the model. For `application/json` models, this should be JSON schema draft 4 model. Do not include "\*‍/" characters in the description of any properties because such "\*‍/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
+     */
+    Schema?: Record<string, unknown> | string | undefined;
+};
+//# sourceMappingURL=aws-apigateway-model.d.ts.map

package/out/exports/resources.generated/aws-apigateway-requestvalidator.d.ts

@@ -0,0 +1,30 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type ApiGatewayRequestValidator = ResourceDefinitionWithAttributes<"AWS::ApiGateway::RequestValidator", ApiGatewayRequestValidatorProps, ApiGatewayRequestValidatorAttribs>;
+/**
+ * The `AWS::ApiGateway::RequestValidator` resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide* .
+ */
+export type ApiGatewayRequestValidatorProps = {
+    /**
+     * The name of this RequestValidator
+     */
+    Name?: string | undefined;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
+     */
+    ValidateRequestBody?: boolean | undefined;
+    /**
+     * A Boolean flag to indicate whether to validate request parameters ( `true` ) or not ( `false` ).
+     */
+    ValidateRequestParameters?: boolean | undefined;
+};
+export type ApiGatewayRequestValidatorAttribs = {
+    /**
+     * The ID for the request validator. For example: `abc123` .
+     */
+    RequestValidatorId: string;
+};
+//# sourceMappingURL=aws-apigateway-requestvalidator.d.ts.map

package/out/exports/resources.generated/aws-apigateway-resource.d.ts

@@ -0,0 +1,26 @@
+import type { ResourceDefinitionWithAttributes } from "../main.ts";
+export type ApiGatewayResource = ResourceDefinitionWithAttributes<"AWS::ApiGateway::Resource", ApiGatewayResourceProps, ApiGatewayResourceAttribs>;
+/**
+ * The `AWS::ApiGateway::Resource` resource creates a resource in an API.
+ */
+export type ApiGatewayResourceProps = {
+    /**
+     * The parent resource's identifier.
+     */
+    ParentId: string;
+    /**
+     * The last path segment for this resource.
+     */
+    PathPart: string;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+};
+export type ApiGatewayResourceAttribs = {
+    /**
+     * The ID for the resource. For example: `abc123` .
+     */
+    ResourceId: string;
+};
+//# sourceMappingURL=aws-apigateway-resource.d.ts.map

package/out/exports/resources.generated/aws-apigateway-restapi.d.ts

@@ -0,0 +1,133 @@
+import type { ResourceDefinitionWithAttributes, TemplatePolicyDocument, Tag } from "../main.ts";
+export type ApiGatewayRestApi = ResourceDefinitionWithAttributes<"AWS::ApiGateway::RestApi", ApiGatewayRestApiProps, ApiGatewayRestApiAttribs>;
+/**
+ * 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.
+ */
+export type ApiGatewayRestApiProps = {
+    /**
+     * The source of the API key for metering requests according to a usage plan. Valid values are: `HEADER` to read the API key from the `X-API-Key` header of a request. `AUTHORIZER` to read the API key from the `UsageIdentifierKey` from a custom authorizer.
+     */
+    ApiKeySourceType?: string | undefined;
+    /**
+     * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
+     */
+    BinaryMediaTypes?: string[] | undefined;
+    /**
+     * An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
+     */
+    Body?: Record<string, unknown> | string | undefined;
+    /**
+     * The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
+     */
+    BodyS3Location?: S3Location | undefined;
+    /**
+     * The ID of the RestApi that you want to clone from.
+     */
+    CloneFrom?: string | undefined;
+    /**
+     * The description of the RestApi.
+     */
+    Description?: string | undefined;
+    /**
+     * Specifies whether clients can invoke your API by using the default `execute-api` endpoint. By default, clients can invoke your API with the default `https://{api_id}.execute-api.{region}.amazonaws.com` endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint
+     */
+    DisableExecuteApiEndpoint?: boolean | undefined;
+    /**
+     * A list of the endpoint types and IP address types of the API. Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the `Parameters` property.
+     */
+    EndpointConfiguration?: EndpointConfiguration | undefined;
+    /**
+     * A query parameter to indicate whether to rollback the API update ( `true` ) or not ( `false` ) when a warning is encountered. The default value is `false` .
+     */
+    FailOnWarnings?: boolean | undefined;
+    /**
+     * A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
+     */
+    MinimumCompressionSize?: number | undefined;
+    /**
+     * This property applies only when you use OpenAPI to define your REST API. The `Mode` determines how API Gateway handles resource updates.
+     *
+     * Valid values are `overwrite` or `merge` .
+     *
+     * For `overwrite` , the new API definition replaces the existing one. The existing API identifier remains unchanged.
+     *
+     * For `merge` , the new API definition is merged with the existing API.
+     *
+     * If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is `overwrite` . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.
+     *
+     * Use the default mode to define top-level `RestApi` properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
+     */
+    Mode?: string | undefined;
+    /**
+     * The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
+     */
+    Name?: string | undefined;
+    /**
+     * Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set `ignore=documentation` as a `parameters` value, as in the AWS CLI command of `aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'` .
+     */
+    Parameters?: Record<string, string> | string | undefined;
+    /**
+     * A policy document that contains the permissions for the `RestApi` resource. To set the ARN for the policy, use the `!Join` intrinsic function with `""` as delimiter and values of `"execute-api:/"` and `"*"` .
+     * @policy
+     */
+    Policy?: TemplatePolicyDocument | undefined;
+    /**
+     * The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with `aws:` . The tag value can be up to 256 characters.
+     */
+    Tags?: Tag[] | undefined;
+};
+export type ApiGatewayRestApiAttribs = {
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * The root resource ID for a `RestApi` resource, such as `a0bc123d4e` .
+     */
+    RootResourceId: string;
+};
+/**
+ * The `EndpointConfiguration` property type specifies the endpoint types and IP address types of a REST API.
+ *
+ * `EndpointConfiguration` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.
+ */
+export type EndpointConfiguration = {
+    /**
+     * The IP address types that can invoke an API (RestApi). Use `ipv4` to allow only IPv4 addresses to invoke an API, or use `dualstack` to allow both IPv4 and IPv6 addresses to invoke an API. For the `PRIVATE` endpoint type, only `dualstack` is supported.
+     */
+    IpAddressType?: string | undefined;
+    /**
+     * A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is `"EDGE"` . For a regional API and its custom domain name, the endpoint type is `REGIONAL` . For a private API, the endpoint type is `PRIVATE` .
+     */
+    Types?: string[] | undefined;
+    /**
+     * A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for `PRIVATE` endpoint type.
+     */
+    VpcEndpointIds?: string[] | undefined;
+};
+/**
+ * `S3Location` is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.
+ *
+ * > 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.
+ */
+export type S3Location = {
+    /**
+     * The name of the S3 bucket where the OpenAPI file is stored.
+     */
+    Bucket?: string | undefined;
+    /**
+     * The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
+     */
+    ETag?: string | undefined;
+    /**
+     * The file name of the OpenAPI file (Amazon S3 object name).
+     */
+    Key?: string | undefined;
+    /**
+     * For versioning-enabled buckets, a specific version of the OpenAPI file.
+     */
+    Version?: string | undefined;
+};
+//# sourceMappingURL=aws-apigateway-restapi.d.ts.map

package/out/exports/resources.generated/aws-apigateway-stage.d.ts

@@ -0,0 +1,151 @@
+import type { ResourceDefinition, Tag } from "../main.ts";
+export type ApiGatewayStage = ResourceDefinition<"AWS::ApiGateway::Stage", ApiGatewayStageProps>;
+/**
+ * The `AWS::ApiGateway::Stage` resource creates a stage for a deployment.
+ */
+export type ApiGatewayStageProps = {
+    /**
+     * Access log settings, including the access log format and access log destination ARN.
+     */
+    AccessLogSetting?: AccessLogSetting | undefined;
+    /**
+     * Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set `CachingEnabled` to `true` for a method.
+     */
+    CacheClusterEnabled?: boolean | undefined;
+    /**
+     * The stage's cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) .
+     */
+    CacheClusterSize?: string | undefined;
+    /**
+     * Settings for the canary deployment in this stage.
+     */
+    CanarySetting?: CanarySetting | undefined;
+    /**
+     * The identifier of a client certificate for an API stage.
+     */
+    ClientCertificateId?: string | undefined;
+    /**
+     * The identifier of the Deployment that the stage points to.
+     */
+    DeploymentId?: string | undefined;
+    /**
+     * The stage's description.
+     */
+    Description?: string | undefined;
+    /**
+     * The version of the associated API documentation.
+     */
+    DocumentationVersion?: string | undefined;
+    /**
+     * A map that defines the method settings for a Stage resource. Keys (designated as `/{method_setting_key` below) are method paths defined as `{resource_path}/{http_method}` for an individual method override, or `/\*‍/\*` for overriding all methods in the stage.
+     */
+    MethodSettings?: MethodSetting[] | undefined;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
+     */
+    StageName?: string | undefined;
+    /**
+     * The collection of tags. Each tag element is associated with a given resource.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * Specifies whether active tracing with X-ray is enabled for the Stage.
+     */
+    TracingEnabled?: boolean | undefined;
+    /**
+     * A map (string-to-string map) that defines the stage variables, where the variable name is the key and the variable value is the value. Variable names are limited to alphanumeric characters. Values must match the following regular expression: `[A-Za-z0-9-._~:/?#&=,]+` .
+     */
+    Variables?: Record<string, string> | undefined;
+};
+/**
+ * The `AccessLogSetting` property type specifies settings for logging access in this stage.
+ *
+ * `AccessLogSetting` is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.
+ */
+export type AccessLogSetting = {
+    /**
+     * The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with `amazon-apigateway-` . This parameter is required to enable access logging.
+     */
+    DestinationArn?: string | undefined;
+    /**
+     * A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least `$context.requestId` . This parameter is required to enable access logging.
+     */
+    Format?: string | undefined;
+};
+/**
+ * Configuration settings of a canary deployment.
+ */
+export type CanarySetting = {
+    /**
+     * The ID of the canary deployment.
+     */
+    DeploymentId?: string | undefined;
+    /**
+     * The percent (0-100) of traffic diverted to a canary deployment.
+     * @min 0
+     * @max 100
+     */
+    PercentTraffic?: number | undefined;
+    /**
+     * Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
+     */
+    StageVariableOverrides?: Record<string, string> | undefined;
+    /**
+     * A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
+     */
+    UseStageCache?: boolean | undefined;
+};
+/**
+ * The `MethodSetting` property type configures settings for all methods in a stage.
+ *
+ * The `MethodSettings` property of the `AWS::ApiGateway::Stage` resource contains a list of `MethodSetting` property types.
+ */
+export type MethodSetting = {
+    /**
+     * Specifies whether the cached responses are encrypted.
+     */
+    CacheDataEncrypted?: boolean | undefined;
+    /**
+     * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
+     */
+    CacheTtlInSeconds?: number | undefined;
+    /**
+     * Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
+     */
+    CachingEnabled?: boolean | undefined;
+    /**
+     * Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this option for production APIs.
+     */
+    DataTraceEnabled?: boolean | undefined;
+    /**
+     * The HTTP method. To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .
+     */
+    HttpMethod?: string | undefined;
+    /**
+     * Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are `OFF` , `ERROR` , and `INFO` . Choose `ERROR` to write only error-level entries to CloudWatch Logs, or choose `INFO` to include all `ERROR` events as well as extra informational events.
+     */
+    LoggingLevel?: string | undefined;
+    /**
+     * Specifies whether Amazon CloudWatch metrics are enabled for this method.
+     */
+    MetricsEnabled?: boolean | undefined;
+    /**
+     * The resource path for this method. Forward slashes ( `/` ) are encoded as `~1` and the initial slash must include a forward slash. For example, the path value `/resource/subresource` must be encoded as `/~1resource~1subresource` . To specify the root path, use only a slash ( `/` ). To apply settings to multiple resources and methods, specify an asterisk ( `*` ) for the `HttpMethod` and `/*` for the `ResourcePath` . This parameter is required when you specify a `MethodSetting` .
+     */
+    ResourcePath?: string | undefined;
+    /**
+     * Specifies the throttling burst limit.
+     * @min 0
+     */
+    ThrottlingBurstLimit?: number | undefined;
+    /**
+     * Specifies the throttling rate limit.
+     * @min 0
+     */
+    ThrottlingRateLimit?: number | undefined;
+};
+//# sourceMappingURL=aws-apigateway-stage.d.ts.map

package/out/exports/resources.generated/aws-apigateway-usageplan.d.ts

@@ -0,0 +1,93 @@
+import type { ResourceDefinitionWithAttributes, Tag } from "../main.ts";
+export type ApiGatewayUsagePlan = ResourceDefinitionWithAttributes<"AWS::ApiGateway::UsagePlan", ApiGatewayUsagePlanProps, ApiGatewayUsagePlanAttribs>;
+/**
+ * The `AWS::ApiGateway::UsagePlan` resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide* .
+ *
+ * In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
+ */
+export type ApiGatewayUsagePlanProps = {
+    /**
+     * The associated API stages of a usage plan.
+     */
+    ApiStages?: ApiStage[] | undefined;
+    /**
+     * The description of a usage plan.
+     */
+    Description?: string | undefined;
+    /**
+     * The target maximum number of permitted requests per a given unit time interval.
+     */
+    Quota?: QuotaSettings | undefined;
+    /**
+     * The collection of tags. Each tag element is associated with a given resource.
+     */
+    Tags?: Tag[] | undefined;
+    /**
+     * A map containing method level throttling information for API stage in a usage plan.
+     */
+    Throttle?: ThrottleSettings | undefined;
+    /**
+     * The name of a usage plan.
+     */
+    UsagePlanName?: string | undefined;
+};
+export type ApiGatewayUsagePlanAttribs = {
+    /**
+     * The ID for the usage plan. For example: `abc123` .
+     */
+    Id: string;
+};
+/**
+ * API stage name of the associated API stage in a usage plan.
+ */
+export type ApiStage = {
+    /**
+     * API Id of the associated API stage in a usage plan.
+     */
+    ApiId?: string | undefined;
+    /**
+     * API stage name of the associated API stage in a usage plan.
+     */
+    Stage?: string | undefined;
+    /**
+     * Map containing method level throttling information for API stage in a usage plan.
+     */
+    Throttle?: Record<string, ThrottleSettings> | undefined;
+};
+/**
+ * `QuotaSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.
+ *
+ * In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
+ */
+export type QuotaSettings = {
+    /**
+     * The target maximum number of requests that can be made in a given time period.
+     * @min 0
+     */
+    Limit?: number | undefined;
+    /**
+     * The number of requests subtracted from the given limit in the initial time period.
+     * @min 0
+     */
+    Offset?: number | undefined;
+    /**
+     * The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
+     */
+    Period?: string | undefined;
+};
+/**
+ * `ThrottleSettings` is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.
+ */
+export type ThrottleSettings = {
+    /**
+     * The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
+     * @min 0
+     */
+    BurstLimit?: number | undefined;
+    /**
+     * The API target request rate limit.
+     * @min 0
+     */
+    RateLimit?: number | undefined;
+};
+//# sourceMappingURL=aws-apigateway-usageplan.d.ts.map