@awboost/cfn-resource-types 0.1.0

package/lib/AWS-ApiGateway-ApiKey.d.ts

@@ -0,0 +1,89 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html}
+ */
+export type ApiGatewayApiKeyProperties = {
+    /**
+     * An MKT customer identifier, when integrating with the AWS SaaS Marketplace.
+     */
+    CustomerId?: string;
+    /**
+     * The description of the ApiKey.
+     */
+    Description?: string;
+    /**
+     * Specifies whether the ApiKey can be used by callers.
+     */
+    Enabled?: boolean;
+    /**
+     * Specifies whether (``true``) or not (``false``) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.
+     */
+    GenerateDistinctId?: boolean;
+    /**
+       * A name for the API key. If you don't specify a name, CFN generates a unique physical ID and uses that ID for the API key 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;
+    /**
+     * DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
+     */
+    StageKeys?: StageKey[];
+    /**
+     * 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[];
+    /**
+     * Specifies a value of the API key.
+     */
+    Value?: string;
+};
+/**
+ * Attribute type definition for `AWS::ApiGateway::ApiKey`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#aws-resource-apigateway-apikey-return-values}
+ */
+export type ApiGatewayApiKeyAttributes = {
+    APIKeyId: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::ApiKey.StageKey`.
+ * ``StageKey`` is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html}
+ */
+export type StageKey = {
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId?: string;
+    /**
+     * The stage name associated with the stage key.
+     */
+    StageName?: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::ApiKey.Tag`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-tag.html}
+ */
+export type Tag = {
+    /**
+     * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
+     * @minLength `1`
+     * @maxLength `128`
+     */
+    Key: string;
+    /**
+     * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
+     * @maxLength `256`
+     */
+    Value: string;
+};
+/**
+ * The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html}
+ */
+export declare class ApiGatewayApiKey extends $Resource<"AWS::ApiGateway::ApiKey", ApiGatewayApiKeyProperties, ApiGatewayApiKeyAttributes> {
+    static readonly Type = "AWS::ApiGateway::ApiKey";
+    constructor(logicalId: string, properties: ApiGatewayApiKeyProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-ApiKey.d.ts.map

package/lib/AWS-ApiGateway-ApiKey.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::ApiKey`` resource creates a unique key that you can distribute to clients who are executing API Gateway ``Method`` resources that require an API key. To specify which API key clients must use, map the API key with the ``RestApi`` and ``Stage`` resources that include the methods that require a key.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html}
+ */
+export class ApiGatewayApiKey extends $Resource {
+    static Type = "AWS::ApiGateway::ApiKey";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayApiKey.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-ApiKey.js.map

package/lib/AWS-ApiGateway-Authorizer.d.ts

@@ -0,0 +1,64 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html}
+ */
+export type ApiGatewayAuthorizerProperties = {
+    /**
+     * Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
+     */
+    AuthType?: string;
+    /**
+     * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
+     */
+    AuthorizerCredentials?: string;
+    /**
+     * The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
+     */
+    AuthorizerResultTtlInSeconds?: number;
+    /**
+     * Specifies the authorizer's Uniform Resource Identifier (URI). For ``TOKEN`` or ``REQUEST`` authorizers, this must be a well-formed Lambda function URI, for example, ``arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations``. In general, the URI has this form ``arn:aws:apigateway:{region}:lambda:path/{service_api}``, where ``{region}`` is the same as the region hosting the Lambda function, ``path`` indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial ``/``. For Lambda functions, this is usually of the form ``/2015-03-31/functions/[FunctionARN]/invocations``.
+     */
+    AuthorizerUri?: string;
+    /**
+     * The identity source for which authorization is requested. For a ``TOKEN`` or ``COGNITO_USER_POOLS`` authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is ``Auth``, the header mapping expression is ``method.request.header.Auth``. For the ``REQUEST`` authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an ``Auth`` header, a ``Name`` query string parameter are defined as identity sources, this value is ``method.request.header.Auth, method.request.querystring.Name``. These parameters will be used to derive the authorization caching key and to perform runtime validation of the ``REQUEST`` authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
+     */
+    IdentitySource?: string;
+    /**
+     * A validation expression for the incoming identity token. For ``TOKEN`` authorizers, this value is a regular expression. For ``COGNITO_USER_POOLS`` authorizers, API Gateway will match the ``aud`` field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the ``REQUEST`` authorizer.
+     */
+    IdentityValidationExpression?: string;
+    /**
+     * The name of the authorizer.
+     */
+    Name: string;
+    /**
+     * A list of the Amazon Cognito user pool ARNs for the ``COGNITO_USER_POOLS`` authorizer. Each element is of this format: ``arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}``. For a ``TOKEN`` or ``REQUEST`` authorizer, this is not defined.
+     */
+    ProviderARNs?: string[];
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * The authorizer type. Valid values are ``TOKEN`` for a Lambda function using a single authorization token submitted in a custom header, ``REQUEST`` for a Lambda function using incoming request parameters, and ``COGNITO_USER_POOLS`` for using an Amazon Cognito user pool.
+     */
+    Type: string;
+};
+/**
+ * Attribute type definition for `AWS::ApiGateway::Authorizer`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#aws-resource-apigateway-authorizer-return-values}
+ */
+export type ApiGatewayAuthorizerAttributes = {
+    AuthorizerId: string;
+};
+/**
+ * The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html}
+ */
+export declare class ApiGatewayAuthorizer extends $Resource<"AWS::ApiGateway::Authorizer", ApiGatewayAuthorizerProperties, ApiGatewayAuthorizerAttributes> {
+    static readonly Type = "AWS::ApiGateway::Authorizer";
+    constructor(logicalId: string, properties: ApiGatewayAuthorizerProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-Authorizer.d.ts.map

package/lib/AWS-ApiGateway-Authorizer.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::Authorizer`` resource creates an authorization layer that API Gateway activates for methods that have authorization enabled. API Gateway activates the authorizer when a client calls those methods.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html}
+ */
+export class ApiGatewayAuthorizer extends $Resource {
+    static Type = "AWS::ApiGateway::Authorizer";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayAuthorizer.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-Authorizer.js.map

package/lib/AWS-ApiGateway-BasePathMapping.d.ts

@@ -0,0 +1,33 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html}
+ */
+export type ApiGatewayBasePathMappingProperties = {
+    /**
+     * The base path name that callers of the API must provide as part of the URL after the domain name.
+     */
+    BasePath?: string;
+    /**
+     * The domain name of the BasePathMapping resource to be described.
+     */
+    DomainName: string;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId?: string;
+    /**
+     * The name of the associated stage.
+     */
+    Stage?: string;
+};
+/**
+ * The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html}
+ */
+export declare class ApiGatewayBasePathMapping extends $Resource<"AWS::ApiGateway::BasePathMapping", ApiGatewayBasePathMappingProperties, Record<string, never>> {
+    static readonly Type = "AWS::ApiGateway::BasePathMapping";
+    constructor(logicalId: string, properties: ApiGatewayBasePathMappingProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-BasePathMapping.d.ts.map

package/lib/AWS-ApiGateway-BasePathMapping.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::BasePathMapping`` resource creates a base path that clients who call your API must use in the invocation URL.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html}
+ */
+export class ApiGatewayBasePathMapping extends $Resource {
+    static Type = "AWS::ApiGateway::BasePathMapping";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayBasePathMapping.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-BasePathMapping.js.map

package/lib/AWS-ApiGateway-ClientCertificate.d.ts

@@ -0,0 +1,40 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html}
+ */
+export type ApiGatewayClientCertificateProperties = {
+    /**
+     * The description of the client certificate.
+     */
+    Description?: string;
+    /**
+     * The collection of tags. Each tag element is associated with a given resource.
+     */
+    Tags?: Tag[];
+};
+/**
+ * Attribute type definition for `AWS::ApiGateway::ClientCertificate`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#aws-resource-apigateway-clientcertificate-return-values}
+ */
+export type ApiGatewayClientCertificateAttributes = {
+    ClientCertificateId: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::ClientCertificate.Tag`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-clientcertificate-tag.html}
+ */
+export type Tag = {
+    Key: string;
+    Value: string;
+};
+/**
+ * The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html}
+ */
+export declare class ApiGatewayClientCertificate extends $Resource<"AWS::ApiGateway::ClientCertificate", ApiGatewayClientCertificateProperties, ApiGatewayClientCertificateAttributes> {
+    static readonly Type = "AWS::ApiGateway::ClientCertificate";
+    constructor(logicalId: string, properties: ApiGatewayClientCertificateProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-ClientCertificate.d.ts.map

package/lib/AWS-ApiGateway-ClientCertificate.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::ClientCertificate`` resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html}
+ */
+export class ApiGatewayClientCertificate extends $Resource {
+    static Type = "AWS::ApiGateway::ClientCertificate";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayClientCertificate.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-ClientCertificate.js.map

package/lib/AWS-ApiGateway-Deployment.d.ts

@@ -0,0 +1,245 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html}
+ */
+export type ApiGatewayDeploymentProperties = {
+    /**
+     * The input configuration for a canary deployment.
+     */
+    DeploymentCanarySettings?: DeploymentCanarySettings;
+    /**
+     * The description for the Deployment resource to create.
+     */
+    Description?: string;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+    /**
+     * The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
+     */
+    StageDescription?: StageDescription;
+    /**
+     * The name of the Stage resource for the Deployment resource to create.
+     */
+    StageName?: string;
+};
+/**
+ * Attribute type definition for `AWS::ApiGateway::Deployment`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#aws-resource-apigateway-deployment-return-values}
+ */
+export type ApiGatewayDeploymentAttributes = {
+    DeploymentId: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.AccessLogSetting`.
+ * The ``AccessLogSetting`` property type specifies settings for logging access in this stage.
+  ``AccessLogSetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html}
+ */
+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-``.
+     */
+    DestinationArn?: string;
+    /**
+     * A single line format of the access logs of data, as specified by selected $context variables. The format must include at least ``$context.requestId``.
+     */
+    Format?: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.CanarySetting`.
+ * The ``CanarySetting`` property type specifies settings for the canary deployment in this stage.
+ ``CanarySetting`` is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html}
+ */
+export type CanarySetting = {
+    /**
+     * The percent (0-100) of traffic diverted to a canary deployment.
+     */
+    PercentTraffic?: number;
+    /**
+     * 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>;
+    /**
+     * A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
+     */
+    UseStageCache?: boolean;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.DeploymentCanarySettings`.
+ * The ``DeploymentCanarySettings`` property type specifies settings for the canary deployment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html}
+ */
+export type DeploymentCanarySettings = {
+    /**
+     * The percentage (0.0-100.0) of traffic routed to the canary deployment.
+     */
+    PercentTraffic?: number;
+    /**
+     * A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
+     */
+    StageVariableOverrides?: Record<string, string>;
+    /**
+     * A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
+     */
+    UseStageCache?: boolean;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.MethodSetting`.
+ * The ``MethodSetting`` property type configures settings for all methods in a stage.
+ The ``MethodSettings`` property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list of ``MethodSetting`` property types.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html}
+ */
+export type MethodSetting = {
+    /**
+     * Specifies whether the cached responses are encrypted.
+     */
+    CacheDataEncrypted?: boolean;
+    /**
+     * Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
+     */
+    CacheTtlInSeconds?: number;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * The HTTP method.
+     */
+    HttpMethod?: string;
+    /**
+     * 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;
+    /**
+     * Specifies whether Amazon CloudWatch metrics are enabled for this method.
+     */
+    MetricsEnabled?: boolean;
+    /**
+     * 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 (``/``).
+     */
+    ResourcePath?: string;
+    /**
+     * Specifies the throttling burst limit.
+     */
+    ThrottlingBurstLimit?: number;
+    /**
+     * Specifies the throttling rate limit.
+     */
+    ThrottlingRateLimit?: number;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.StageDescription`.
+ * ``StageDescription`` is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html}
+ */
+export type StageDescription = {
+    /**
+     * Specifies settings for logging access in this stage.
+     */
+    AccessLogSetting?: AccessLogSetting;
+    /**
+     * Specifies whether a cache cluster is enabled for the stage.
+     */
+    CacheClusterEnabled?: boolean;
+    /**
+     * The size of the stage's cache cluster. For more information, see [cacheClusterSize](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateStage.html#apigw-CreateStage-request-cacheClusterSize) in the *API Gateway API Reference*.
+     */
+    CacheClusterSize?: string;
+    /**
+     * Indicates whether the cached responses are encrypted.
+     */
+    CacheDataEncrypted?: boolean;
+    /**
+     * The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
+     */
+    CacheTtlInSeconds?: number;
+    /**
+     * Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide*.
+     */
+    CachingEnabled?: boolean;
+    /**
+     * Specifies settings for the canary deployment in this stage.
+     */
+    CanarySetting?: CanarySetting;
+    /**
+     * The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
+     */
+    ClientCertificateId?: string;
+    /**
+     * Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
+     */
+    DataTraceEnabled?: boolean;
+    /**
+     * A description of the purpose of the stage.
+     */
+    Description?: string;
+    /**
+     * The version identifier of the API documentation snapshot.
+     */
+    DocumentationVersion?: string;
+    /**
+     * The logging level for this method. For valid values, see the ``loggingLevel`` property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference*.
+     */
+    LoggingLevel?: string;
+    /**
+     * Configures settings for all of the stage's methods.
+     */
+    MethodSettings?: MethodSetting[];
+    /**
+     * Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
+     */
+    MetricsEnabled?: boolean;
+    /**
+     * An array of arbitrary tags (key-value pairs) to associate with the stage.
+     */
+    Tags?: Tag[];
+    /**
+     * The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
+     */
+    ThrottlingBurstLimit?: number;
+    /**
+     * The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide*.
+     */
+    ThrottlingRateLimit?: number;
+    /**
+       * Specifies whether active tracing with X-ray is enabled for this stage.
+       For more information, see [Trace API Gateway API Execution with X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide*.
+       */
+    TracingEnabled?: boolean;
+    /**
+     * A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: ``[A-Za-z0-9-._~:/?#&=,]+``.
+     */
+    Variables?: Record<string, string>;
+};
+/**
+ * Type definition for `AWS::ApiGateway::Deployment.Tag`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-tag.html}
+ */
+export type Tag = {
+    /**
+     * The key name of the tag
+     */
+    Key: string;
+    /**
+     * The value for the tag
+     */
+    Value: string;
+};
+/**
+ * The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html}
+ */
+export declare class ApiGatewayDeployment extends $Resource<"AWS::ApiGateway::Deployment", ApiGatewayDeploymentProperties, ApiGatewayDeploymentAttributes> {
+    static readonly Type = "AWS::ApiGateway::Deployment";
+    constructor(logicalId: string, properties: ApiGatewayDeploymentProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-Deployment.d.ts.map

package/lib/AWS-ApiGateway-Deployment.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::Deployment`` resource deploys an API Gateway ``RestApi`` resource to a stage so that clients can call the API over the internet. The stage acts as an environment.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html}
+ */
+export class ApiGatewayDeployment extends $Resource {
+    static Type = "AWS::ApiGateway::Deployment";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayDeployment.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-Deployment.js.map

package/lib/AWS-ApiGateway-DocumentationPart.d.ts

@@ -0,0 +1,64 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
+/**
+ * The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html}
+ */
+export type ApiGatewayDocumentationPartProperties = {
+    /**
+     * The location of the targeted API entity of the to-be-created documentation part.
+     */
+    Location: Location;
+    /**
+     * The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.
+     */
+    Properties: string;
+    /**
+     * The string identifier of the associated RestApi.
+     */
+    RestApiId: string;
+};
+/**
+ * Attribute type definition for `AWS::ApiGateway::DocumentationPart`.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#aws-resource-apigateway-documentationpart-return-values}
+ */
+export type ApiGatewayDocumentationPartAttributes = {
+    DocumentationPartId: string;
+};
+/**
+ * Type definition for `AWS::ApiGateway::DocumentationPart.Location`.
+ * The ``Location`` property specifies the location of the Amazon API Gateway API entity that the documentation applies to. ``Location`` is a property of the [AWS::ApiGateway::DocumentationPart](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html) resource.
+ For more information about each property, including constraints and valid values, see [DocumentationPart](https://docs.aws.amazon.com/apigateway/latest/api/API_DocumentationPartLocation.html) in the *Amazon API Gateway REST API Reference*.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html}
+ */
+export type Location = {
+    /**
+     * The HTTP verb of a method. It is a valid field for the API entity types of ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``method`` attribute must match that of the parent entity exactly.
+     */
+    Method?: string;
+    /**
+     * The name of the targeted API entity. It is a valid and required field for the API entity types of ``AUTHORIZER``, ``MODEL``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY`` and ``RESPONSE_HEADER``. It is an invalid field for any other entity type.
+     */
+    Name?: string;
+    /**
+     * The URL path of the target. It is a valid field for the API entity types of ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``/`` for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``path`` attribute must match that of the parent entity as a prefix.
+     */
+    Path?: string;
+    /**
+     * The HTTP status code of a response. It is a valid field for the API entity types of ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. The default value is ``*`` for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other ``location`` attributes, the child entity's ``statusCode`` attribute must match that of the parent entity exactly.
+     */
+    StatusCode?: string;
+    /**
+     * The type of API entity to which the documentation content applies. Valid values are ``API``, ``AUTHORIZER``, ``MODEL``, ``RESOURCE``, ``METHOD``, ``PATH_PARAMETER``, ``QUERY_PARAMETER``, ``REQUEST_HEADER``, ``REQUEST_BODY``, ``RESPONSE``, ``RESPONSE_HEADER``, and ``RESPONSE_BODY``. Content inheritance does not apply to any entity of the ``API``, ``AUTHORIZER``, ``METHOD``, ``MODEL``, ``REQUEST_BODY``, or ``RESOURCE`` type.
+     */
+    Type?: "API" | "AUTHORIZER" | "MODEL" | "RESOURCE" | "METHOD" | "PATH_PARAMETER" | "QUERY_PARAMETER" | "REQUEST_HEADER" | "REQUEST_BODY" | "RESPONSE" | "RESPONSE_HEADER" | "RESPONSE_BODY";
+};
+/**
+ * The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html}
+ */
+export declare class ApiGatewayDocumentationPart extends $Resource<"AWS::ApiGateway::DocumentationPart", ApiGatewayDocumentationPartProperties, ApiGatewayDocumentationPartAttributes> {
+    static readonly Type = "AWS::ApiGateway::DocumentationPart";
+    constructor(logicalId: string, properties: ApiGatewayDocumentationPartProperties, options?: $ResourceOptions);
+}
+//# sourceMappingURL=AWS-ApiGateway-DocumentationPart.d.ts.map

package/lib/AWS-ApiGateway-DocumentationPart.js

@@ -0,0 +1,12 @@
+import { Resource as $Resource } from "@awboost/cfn-template-builder/template/Resource";
+/**
+ * The ``AWS::ApiGateway::DocumentationPart`` resource creates a documentation part for an API. For more information, see [Representation of API Documentation in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-documenting-api-content-representation.html) in the *API Gateway Developer Guide*.
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html}
+ */
+export class ApiGatewayDocumentationPart extends $Resource {
+    static Type = "AWS::ApiGateway::DocumentationPart";
+    constructor(logicalId, properties, options) {
+        super(logicalId, ApiGatewayDocumentationPart.Type, properties, options);
+    }
+}
+//# sourceMappingURL=AWS-ApiGateway-DocumentationPart.js.map