@pulumi/aws-native 0.81.0 → 0.82.0

package/apigateway/getDocumentationVersion.d.ts

@@ -1,35 +1,35 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * A snapshot of the documentation of an API.
+ * The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation 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*.
  */
 export declare function getDocumentationVersion(args: GetDocumentationVersionArgs, opts?: pulumi.InvokeOptions): Promise<GetDocumentationVersionResult>;
 export interface GetDocumentationVersionArgs {
     /**
-     * The version identifier of the API documentation snapshot.
+     * The version identifier of the to-be-updated documentation version.
      */
     documentationVersion: string;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
 export interface GetDocumentationVersionResult {
     /**
-     * The description of the API documentation snapshot.
+     * A description about the new documentation snapshot.
      */
     readonly description?: string;
 }
 /**
- * A snapshot of the documentation of an API.
+ * The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation 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*.
  */
 export declare function getDocumentationVersionOutput(args: GetDocumentationVersionOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDocumentationVersionResult>;
 export interface GetDocumentationVersionOutputArgs {
     /**
-     * The version identifier of the API documentation snapshot.
+     * The version identifier of the to-be-updated documentation version.
      */
     documentationVersion: pulumi.Input<string>;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getDocumentationVersion.js

@@ -6,7 +6,7 @@ exports.getDocumentationVersionOutput = exports.getDocumentationVersion = void 0
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * A snapshot of the documentation of an API.
+ * The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation 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*.
  */
 function getDocumentationVersion(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,7 +17,7 @@ function getDocumentationVersion(args, opts) {
 }
 exports.getDocumentationVersion = getDocumentationVersion;
 /**
- * A snapshot of the documentation of an API.
+ * The ``AWS::ApiGateway::DocumentationVersion`` resource creates a snapshot of the documentation 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*.
  */
 function getDocumentationVersionOutput(args, opts) {
     return pulumi.output(args).apply((a) => getDocumentationVersion(a, opts));

package/apigateway/getMethod.d.ts

@@ -2,80 +2,81 @@ import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "../types/output";
 import * as enums from "../types/enums";
 /**
- * Resource Type definition for AWS::ApiGateway::Method
+ * The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  */
 export declare function getMethod(args: GetMethodArgs, opts?: pulumi.InvokeOptions): Promise<GetMethodResult>;
 export interface GetMethodArgs {
     /**
-     * The backend system that the method calls when it receives a request.
+     * The method's HTTP verb.
      */
     httpMethod: string;
     /**
-     * The ID of an API Gateway resource.
+     * The Resource identifier for the MethodResponse resource.
      */
     resourceId: string;
     /**
-     * The ID of the RestApi resource in which API Gateway creates the method.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
 export interface GetMethodResult {
     /**
-     * Indicates whether the method requires clients to submit a valid API key.
+     * A boolean flag specifying whether a valid ApiKey is required to invoke this method.
      */
     readonly apiKeyRequired?: boolean;
     /**
-     * A list of authorization scopes configured on the method.
+     * 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.
      */
     readonly authorizationScopes?: string[];
     /**
-     * The method's authorization type.
+     * 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.
      */
     readonly authorizationType?: enums.apigateway.MethodAuthorizationType;
     /**
-     * The identifier of the authorizer to use on this method.
+     * The identifier of an authorizer to use on this method. The method's authorization type must be ``CUSTOM`` or ``COGNITO_USER_POOLS``.
      */
     readonly authorizerId?: string;
     /**
-     * The backend system that the method calls when it receives a request.
+     * Represents an ``HTTP``, ``HTTP_PROXY``, ``AWS``, ``AWS_PROXY``, or Mock integration.
      */
     readonly integration?: outputs.apigateway.MethodIntegration;
     /**
-     * The responses that can be sent to the client who calls the method.
+     * Gets a method response associated with a given HTTP status code.
      */
     readonly methodResponses?: outputs.apigateway.MethodResponse[];
     /**
-     * A friendly operation name for the method.
+     * 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.
      */
     readonly operationName?: string;
     /**
-     * The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a Model resource name as the value.
+     * 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).
      */
     readonly requestModels?: any;
     /**
-     * The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value.
+     * 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.
      */
     readonly requestParameters?: any;
     /**
-     * The ID of the associated request validator.
+     * The identifier of a RequestValidator for request validation.
      */
     readonly requestValidatorId?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Method
+ * The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  */
 export declare function getMethodOutput(args: GetMethodOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetMethodResult>;
 export interface GetMethodOutputArgs {
     /**
-     * The backend system that the method calls when it receives a request.
+     * The method's HTTP verb.
      */
     httpMethod: pulumi.Input<string>;
     /**
-     * The ID of an API Gateway resource.
+     * The Resource identifier for the MethodResponse resource.
      */
     resourceId: pulumi.Input<string>;
     /**
-     * The ID of the RestApi resource in which API Gateway creates the method.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getMethod.js

@@ -6,7 +6,7 @@ exports.getMethodOutput = exports.getMethod = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Method
+ * The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  */
 function getMethod(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -18,7 +18,7 @@ function getMethod(args, opts) {
 }
 exports.getMethod = getMethod;
 /**
- * Resource Type definition for AWS::ApiGateway::Method
+ * The ``AWS::ApiGateway::Method`` resource creates API Gateway methods that define the parameters and body that clients must send in their requests.
  */
 function getMethodOutput(args, opts) {
     return pulumi.output(args).apply((a) => getMethod(a, opts));

package/apigateway/getMethod.js.map

@@ -1 +1 @@
-{"version":3,"file":"getMethod.js","sourceRoot":"","sources":["../../apigateway/getMethod.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAmB,EAAE,IAA2B;IAEtE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iCAAiC,EAAE;QAC5D,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,8BAQC;AA2DD;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAyB,EAAE,IAA2B;IAClF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACpE,CAAC;AAFD,0CAEC"}
+{"version":3,"file":"getMethod.js","sourceRoot":"","sources":["../../apigateway/getMethod.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,SAAS,CAAC,IAAmB,EAAE,IAA2B;IAEtE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,iCAAiC,EAAE;QAC5D,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,YAAY,EAAE,IAAI,CAAC,UAAU;QAC7B,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AARD,8BAQC;AA4DD;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAyB,EAAE,IAA2B;IAClF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACpE,CAAC;AAFD,0CAEC"}

package/apigateway/getModel.d.ts

@@ -1,39 +1,41 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::Model
+ * The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
  */
 export declare function getModel(args: GetModelArgs, opts?: pulumi.InvokeOptions): Promise<GetModelResult>;
 export interface GetModelArgs {
     /**
-     * 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.
+     * 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 ID of a REST API with which to associate this model.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
 export interface GetModelResult {
     /**
-     * A description that identifies this model.
+     * The description of the model.
      */
     readonly description?: string;
     /**
-     * The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
+     * The schema for the model. For ``application/json`` models, this should be JSON schema draft 4 model. Do not include "\*&#47;" characters in the description of any properties because such "\*&#47;" 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.
      */
     readonly schema?: any;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Model
+ * The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
  */
 export declare function getModelOutput(args: GetModelOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetModelResult>;
 export interface GetModelOutputArgs {
     /**
-     * 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.
+     * 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: pulumi.Input<string>;
     /**
-     * The ID of a REST API with which to associate this model.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getModel.js

@@ -6,7 +6,7 @@ exports.getModelOutput = exports.getModel = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Model
+ * The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
  */
 function getModel(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,7 +17,7 @@ function getModel(args, opts) {
 }
 exports.getModel = getModel;
 /**
- * Resource Type definition for AWS::ApiGateway::Model
+ * The ``AWS::ApiGateway::Model`` resource defines the structure of a request or response payload for an API method.
  */
 function getModelOutput(args, opts) {
     return pulumi.output(args).apply((a) => getModel(a, opts));

package/apigateway/getModel.js.map

@@ -1 +1 @@
-{"version":3,"file":"getModel.js","sourceRoot":"","sources":["../../apigateway/getModel.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IAEpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,4BAOC;AAuBD;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC;AAFD,wCAEC"}
+{"version":3,"file":"getModel.js","sourceRoot":"","sources":["../../apigateway/getModel.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AACzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,QAAQ,CAAC,IAAkB,EAAE,IAA2B;IAEpE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,gCAAgC,EAAE;QAC3D,MAAM,EAAE,IAAI,CAAC,IAAI;QACjB,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAPD,4BAOC;AAwBD;;GAEG;AACH,SAAgB,cAAc,CAAC,IAAwB,EAAE,IAA2B;IAChF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACnE,CAAC;AAFD,wCAEC"}

package/apigateway/getResource.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::Resource
+ * The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
  */
 export declare function getResource(args: GetResourceArgs, opts?: pulumi.InvokeOptions): Promise<GetResourceResult>;
 export interface GetResourceArgs {
@@ -9,7 +9,7 @@ export interface GetResourceArgs {
      */
     resourceId: string;
     /**
-     * The ID of the RestApi resource in which you want to create this resource..
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
@@ -20,7 +20,7 @@ export interface GetResourceResult {
     readonly resourceId?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Resource
+ * The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
  */
 export declare function getResourceOutput(args: GetResourceOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetResourceResult>;
 export interface GetResourceOutputArgs {
@@ -29,7 +29,7 @@ export interface GetResourceOutputArgs {
      */
     resourceId: pulumi.Input<string>;
     /**
-     * The ID of the RestApi resource in which you want to create this resource..
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getResource.js

@@ -6,7 +6,7 @@ exports.getResourceOutput = exports.getResource = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Resource
+ * The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
  */
 function getResource(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,7 +17,7 @@ function getResource(args, opts) {
 }
 exports.getResource = getResource;
 /**
- * Resource Type definition for AWS::ApiGateway::Resource
+ * The ``AWS::ApiGateway::Resource`` resource creates a resource in an API.
  */
 function getResourceOutput(args, opts) {
     return pulumi.output(args).apply((a) => getResource(a, opts));

package/apigateway/getRestApi.d.ts

@@ -1,27 +1,56 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "../types/output";
 /**
- * Resource Type definition for AWS::ApiGateway::RestApi.
+ * 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 declare function getRestApi(args: GetRestApiArgs, opts?: pulumi.InvokeOptions): Promise<GetRestApiResult>;
 export interface GetRestApiArgs {
     restApiId: string;
 }
 export interface GetRestApiResult {
+    /**
+     * 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.
+     */
     readonly apiKeySourceType?: string;
+    /**
+     * The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
+     */
     readonly binaryMediaTypes?: string[];
+    /**
+     * The description of the RestApi.
+     */
     readonly description?: string;
+    /**
+     * 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
+     */
     readonly disableExecuteApiEndpoint?: boolean;
+    /**
+     * A list of the endpoint 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.
+     */
     readonly endpointConfiguration?: outputs.apigateway.RestApiEndpointConfiguration;
+    /**
+     * 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.
+     */
     readonly minimumCompressionSize?: number;
+    /**
+     * The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
+     */
     readonly name?: string;
+    /**
+     * 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 ``"*"``.
+     */
     readonly policy?: any;
     readonly restApiId?: string;
     readonly rootResourceId?: string;
+    /**
+     * 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.
+     */
     readonly tags?: outputs.apigateway.RestApiTag[];
 }
 /**
- * Resource Type definition for AWS::ApiGateway::RestApi.
+ * 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 declare function getRestApiOutput(args: GetRestApiOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetRestApiResult>;
 export interface GetRestApiOutputArgs {

package/apigateway/getRestApi.js

@@ -6,7 +6,8 @@ exports.getRestApiOutput = exports.getRestApi = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::RestApi.
+ * 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.
  */
 function getRestApi(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -16,7 +17,8 @@ function getRestApi(args, opts) {
 }
 exports.getRestApi = getRestApi;
 /**
- * Resource Type definition for AWS::ApiGateway::RestApi.
+ * 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.
  */
 function getRestApiOutput(args, opts) {
     return pulumi.output(args).apply((a) => getRestApi(a, opts));

package/apigateway/getRestApi.js.map

@@ -1 +1 @@
-{"version":3,"file":"getRestApi.js","sourceRoot":"","sources":["../../apigateway/getRestApi.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,0CAA0C;AAE1C;;GAEG;AACH,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IAExE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,EAAE;QAC7D,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AAmBD;;GAEG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACrE,CAAC;AAFD,4CAEC"}
+{"version":3,"file":"getRestApi.js","sourceRoot":"","sources":["../../apigateway/getRestApi.ts"],"names":[],"mappings":";AAAA,wEAAwE;AACxE,iFAAiF;;;AAEjF,yCAAyC;AAIzC,0CAA0C;AAE1C;;;GAGG;AACH,SAAgB,UAAU,CAAC,IAAoB,EAAE,IAA2B;IAExE,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,SAAS,CAAC,oBAAoB,EAAE,EAAE,IAAI,IAAI,EAAE,CAAC,CAAC;IACzE,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,kCAAkC,EAAE;QAC7D,WAAW,EAAE,IAAI,CAAC,SAAS;KAC9B,EAAE,IAAI,CAAC,CAAC;AACb,CAAC;AAND,gCAMC;AA8CD;;;GAGG;AACH,SAAgB,gBAAgB,CAAC,IAA0B,EAAE,IAA2B;IACpF,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAM,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAA;AACrE,CAAC;AAFD,4CAEC"}

package/apigateway/getStage.d.ts

@@ -1,80 +1,80 @@
 import * as pulumi from "@pulumi/pulumi";
 import * as outputs from "../types/output";
 /**
- * Resource Type definition for AWS::ApiGateway::Stage
+ * The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
  */
 export declare function getStage(args: GetStageArgs, opts?: pulumi.InvokeOptions): Promise<GetStageResult>;
 export interface GetStageArgs {
     /**
-     * The ID of the RestApi resource that you're deploying with this stage.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
     /**
-     * The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
+     * 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;
 }
 export interface GetStageResult {
     /**
-     * Specifies settings for logging access in this stage.
+     * Access log settings, including the access log format and access log destination ARN.
      */
     readonly accessLogSetting?: outputs.apigateway.StageAccessLogSetting;
     /**
-     * Indicates whether cache clustering is enabled for the stage.
+     * Specifies whether a cache cluster is enabled for the stage.
      */
     readonly cacheClusterEnabled?: boolean;
     /**
-     * The stage's cache cluster size.
+     * 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).
      */
     readonly cacheClusterSize?: string;
     /**
-     * Specifies settings for the canary deployment in this stage.
+     * Settings for the canary deployment in this stage.
      */
     readonly canarySetting?: outputs.apigateway.StageCanarySetting;
     /**
-     * The ID of the client certificate that API Gateway uses to call your integration endpoints in the stage.
+     * The identifier of a client certificate for an API stage.
      */
     readonly clientCertificateId?: string;
     /**
-     * The ID of the deployment that the stage is associated with. This parameter is required to create a stage.
+     * The identifier of the Deployment that the stage points to.
      */
     readonly deploymentId?: string;
     /**
-     * A description of the stage.
+     * The stage's description.
      */
     readonly description?: string;
     /**
-     * The version ID of the API documentation snapshot.
+     * The version of the associated API documentation.
      */
     readonly documentationVersion?: string;
     /**
-     * Settings for all methods in the stage.
+     * 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 ``/\*&#47;\*`` for overriding all methods in the stage.
      */
     readonly methodSettings?: outputs.apigateway.StageMethodSetting[];
     /**
-     * An array of arbitrary tags (key-value pairs) to associate with the stage.
+     * The collection of tags. Each tag element is associated with a given resource.
      */
     readonly tags?: outputs.apigateway.StageTag[];
     /**
-     * Specifies whether active X-Ray tracing is enabled for this stage.
+     * Specifies whether active tracing with X-ray is enabled for the Stage.
      */
     readonly tracingEnabled?: boolean;
     /**
-     * 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.
+     * 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-._~:/?#&=,]+``.
      */
     readonly variables?: any;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Stage
+ * The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
  */
 export declare function getStageOutput(args: GetStageOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetStageResult>;
 export interface GetStageOutputArgs {
     /**
-     * The ID of the RestApi resource that you're deploying with this stage.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
     /**
-     * The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
+     * 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: pulumi.Input<string>;
 }

package/apigateway/getStage.js

@@ -6,7 +6,7 @@ exports.getStageOutput = exports.getStage = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Stage
+ * The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
  */
 function getStage(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,7 +17,7 @@ function getStage(args, opts) {
 }
 exports.getStage = getStage;
 /**
- * Resource Type definition for AWS::ApiGateway::Stage
+ * The ``AWS::ApiGateway::Stage`` resource creates a stage for a deployment.
  */
 function getStageOutput(args, opts) {
     return pulumi.output(args).apply((a) => getStage(a, opts));

package/apigateway/getUsagePlanKey.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::UsagePlanKey
+ * The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
  */
 export declare function getUsagePlanKey(args: GetUsagePlanKeyArgs, opts?: pulumi.InvokeOptions): Promise<GetUsagePlanKeyResult>;
 export interface GetUsagePlanKeyArgs {
@@ -16,7 +16,7 @@ export interface GetUsagePlanKeyResult {
     readonly id?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::UsagePlanKey
+ * The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
  */
 export declare function getUsagePlanKeyOutput(args: GetUsagePlanKeyOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetUsagePlanKeyResult>;
 export interface GetUsagePlanKeyOutputArgs {

package/apigateway/getUsagePlanKey.js

@@ -6,7 +6,7 @@ exports.getUsagePlanKeyOutput = exports.getUsagePlanKey = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::UsagePlanKey
+ * The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
  */
 function getUsagePlanKey(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -16,7 +16,7 @@ function getUsagePlanKey(args, opts) {
 }
 exports.getUsagePlanKey = getUsagePlanKey;
 /**
- * Resource Type definition for AWS::ApiGateway::UsagePlanKey
+ * The ``AWS::ApiGateway::UsagePlanKey`` resource associates an API key with a usage plan. This association determines which users the usage plan is applied to.
  */
 function getUsagePlanKeyOutput(args, opts) {
     return pulumi.output(args).apply((a) => getUsagePlanKey(a, opts));