@awboost/cfn-resource-types 0.1.183 → 0.1.185

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

@@ -5,9 +5,6 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html}
  */
 export type ApiGatewayAccountProperties = {
-    /**
-     * The ARN of an Amazon CloudWatch role for the current Account.
-     */
     CloudWatchRoleArn?: string;
 };
 /**

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

@@ -5,38 +5,17 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @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;
 };
 /**
@@ -52,13 +31,7 @@ export type ApiGatewayApiKeyAttributes = {
  * @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;
 };
 /**

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

@@ -5,45 +5,15 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @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;
 };
 /**

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

@@ -5,21 +5,9 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @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;
 };
 /**

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

@@ -5,13 +5,7 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @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[];
 };
 /**

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

@@ -6,24 +6,15 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  */
 export type ApiGatewayDeploymentProperties = {
     /**
-     * The input configuration for a canary deployment.
+     * The ``DeploymentCanarySettings`` property type specifies settings for the 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;
 };
 /**
@@ -40,13 +31,7 @@ export type ApiGatewayDeploymentAttributes = {
  * @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;
 };
 /**
@@ -56,17 +41,8 @@ export type AccessLogSetting = {
  * @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;
 };
 /**
@@ -75,17 +51,8 @@ export type CanarySetting = {
  * @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;
 };
 /**
@@ -95,45 +62,21 @@ export type DeploymentCanarySettings = {
  * @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;
 };
 /**
@@ -146,9 +89,6 @@ 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*.

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

@@ -6,16 +6,11 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  */
 export type ApiGatewayDocumentationPartProperties = {
     /**
-     * The location of the targeted API entity of the to-be-created documentation part.
-     */
+       * 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*.
+       */
     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;
 };
 /**
@@ -32,25 +27,10 @@ export type ApiGatewayDocumentationPartAttributes = {
  * @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";
 };
 /**

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

@@ -5,17 +5,12 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html}
  */
 export type ApiGatewayDocumentationVersionProperties = {
-    /**
-     * A description about the new documentation snapshot.
-     */
     Description?: string;
     /**
-     * The version identifier of the to-be-updated documentation version.
      * @minLength `1`
      */
     DocumentationVersion: string;
     /**
-     * The string identifier of the associated RestApi.
      * @minLength `1`
      */
     RestApiId: string;

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

@@ -5,25 +5,10 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html}
  */
 export type ApiGatewayGatewayResponseProperties = {
-    /**
-     * Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
-     */
     ResponseParameters?: Record<string, string>;
-    /**
-     * Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
-     */
     ResponseTemplates?: Record<string, string>;
-    /**
-     * The response type of the associated GatewayResponse.
-     */
     ResponseType: string;
-    /**
-     * The string identifier of the associated RestApi.
-     */
     RestApiId: string;
-    /**
-     * The HTTP status code for this GatewayResponse.
-     */
     StatusCode?: string;
 };
 /**

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

@@ -5,58 +5,25 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html}
  */
 export type ApiGatewayMethodProperties = {
-    /**
-     * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
-     */
     ApiKeyRequired?: boolean;
-    /**
-     * 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[];
     /**
        * 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;
-    /**
-     * The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
-     */
     AuthorizerId?: string;
-    /**
-     * The method's HTTP verb.
-     */
     HttpMethod: string;
     /**
-     * Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
+     * ``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.
      */
     Integration?: Integration;
-    /**
-     * Gets a method response associated with a given HTTP status code.
-     */
     MethodResponses?: MethodResponse[];
-    /**
-     * 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;
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * The identifier of a RequestValidator for request validation.
-     */
     RequestValidatorId?: string;
-    /**
-     * The Resource identifier for the MethodResponse resource.
-     */
     ResourceId: string;
-    /**
-     * The string identifier of the associated RestApi.
-     */
     RestApiId: string;
 };
 /**
@@ -65,65 +32,22 @@ export type ApiGatewayMethodProperties = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integration.html}
  */
 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[];
-    /**
-     * 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;
-    /**
-     * The ID of the VpcLink used for the integration when ``connectionType=VPC_LINK`` and undefined, otherwise.
-     */
     ConnectionId?: string;
-    /**
-     * 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";
-    /**
-       * 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";
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * Specifies the integration's responses.
-     */
     IntegrationResponses?: IntegrationResponse[];
-    /**
-     * 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";
-    /**
-     * 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>;
-    /**
-     * 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>;
     /**
-     * Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
      * @min `50`
      */
     TimeoutInMillis?: number;
-    /**
-       * 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;
 };
 /**
@@ -132,45 +56,19 @@ export type Integration = {
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-integrationresponse.html}
  */
 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";
-    /**
-     * 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>;
-    /**
-     * 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>;
-    /**
-     * 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 LAMlong function, the LAMlong function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
-     */
     SelectionPattern?: string;
-    /**
-     * Specifies the status code that is used to map the integration response to an existing MethodResponse.
-     */
     StatusCode: string;
 };
 /**
  * Type definition for `AWS::ApiGateway::Method.MethodResponse`.
- * 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.
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-method-methodresponse.html}
  */
 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>;
-    /**
-     * 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>;
-    /**
-     * The method response's status code.
-     */
     StatusCode: string;
 };
 /**

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

@@ -5,26 +5,14 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html}
  */
 export type ApiGatewayModelProperties = {
-    /**
-     * The content-type for the model.
-     */
     ContentType?: string;
-    /**
-     * The description of the model.
-     */
     Description?: string;
     /**
        * A name for the model. If you don't specify a name, CFN 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;
-    /**
-     * 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, any> | string;
 };
 /**

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

@@ -5,21 +5,9 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html}
  */
 export type ApiGatewayRequestValidatorProperties = {
-    /**
-     * The name of this RequestValidator
-     */
     Name?: string;
-    /**
-     * 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;
-    /**
-     * A Boolean flag to indicate whether to validate request parameters (``true``) or not (``false``).
-     */
     ValidateRequestParameters?: boolean;
 };
 /**

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

@@ -5,17 +5,8 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html}
  */
 export type ApiGatewayResourceProperties = {
-    /**
-     * 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;
 };
 /**