@pulumi/aws-native 0.81.0 → 0.81.1-alpha.1698259876

package/apigateway/account.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 export declare class Account extends pulumi.CustomResource {
     /**
@@ -18,7 +18,7 @@ export declare class Account extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is Account;
     /**
-     * The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
+     * The ARN of an Amazon CloudWatch role for the current Account.
      */
     readonly cloudWatchRoleArn: pulumi.Output<string | undefined>;
     /**
@@ -35,7 +35,7 @@ export declare class Account extends pulumi.CustomResource {
  */
 export interface AccountArgs {
     /**
-     * The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
+     * The ARN of an Amazon CloudWatch role for the current Account.
      */
     cloudWatchRoleArn?: pulumi.Input<string>;
 }

package/apigateway/account.js

@@ -6,7 +6,7 @@ exports.Account = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 class Account extends pulumi.CustomResource {
     /**

package/apigateway/authorizer.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 export declare class Authorizer extends pulumi.CustomResource {
     /**
@@ -22,24 +22,24 @@ export declare class Authorizer extends pulumi.CustomResource {
      */
     readonly authType: pulumi.Output<string | undefined>;
     /**
-     * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
+     * 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.
      */
     readonly authorizerCredentials: pulumi.Output<string | undefined>;
     readonly authorizerId: pulumi.Output<string>;
     /**
-     * The TTL in seconds of cached authorizer results.
+     * 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.
      */
     readonly authorizerResultTtlInSeconds: pulumi.Output<number | undefined>;
     /**
-     * Specifies the authorizer's Uniform Resource Identifier (URI).
+     * 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``.
      */
     readonly authorizerUri: pulumi.Output<string | undefined>;
     /**
-     * The identity source for which authorization is requested.
+     * 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.
      */
     readonly identitySource: pulumi.Output<string | undefined>;
     /**
-     * A validation expression for the incoming identity token.
+     * 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.
      */
     readonly identityValidationExpression: pulumi.Output<string | undefined>;
     /**
@@ -47,15 +47,15 @@ export declare class Authorizer extends pulumi.CustomResource {
      */
     readonly name: pulumi.Output<string>;
     /**
-     * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
+     * 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.
      */
     readonly providerArns: pulumi.Output<string[] | undefined>;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     readonly restApiId: pulumi.Output<string>;
     /**
-     * The authorizer type.
+     * 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.
      */
     readonly type: pulumi.Output<string>;
     /**
@@ -76,23 +76,23 @@ export interface AuthorizerArgs {
      */
     authType?: pulumi.Input<string>;
     /**
-     * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
+     * 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?: pulumi.Input<string>;
     /**
-     * The TTL in seconds of cached authorizer results.
+     * 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?: pulumi.Input<number>;
     /**
-     * Specifies the authorizer's Uniform Resource Identifier (URI).
+     * 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?: pulumi.Input<string>;
     /**
-     * The identity source for which authorization is requested.
+     * 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?: pulumi.Input<string>;
     /**
-     * A validation expression for the incoming identity token.
+     * 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?: pulumi.Input<string>;
     /**
@@ -100,15 +100,15 @@ export interface AuthorizerArgs {
      */
     name?: pulumi.Input<string>;
     /**
-     * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
+     * 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?: pulumi.Input<pulumi.Input<string>[]>;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
     /**
-     * The authorizer type.
+     * 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: pulumi.Input<string>;
 }

package/apigateway/authorizer.js

@@ -6,7 +6,7 @@ exports.Authorizer = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 class Authorizer extends pulumi.CustomResource {
     /**

package/apigateway/deployment.d.ts

@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "../types/input";
 import * as outputs from "../types/output";
 /**
- * Resource Type definition for AWS::ApiGateway::Deployment
+ * 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.
  */
 export declare class Deployment extends pulumi.CustomResource {
     /**
@@ -20,7 +20,7 @@ export declare class Deployment extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is Deployment;
     /**
-     * Specifies settings for the canary deployment.
+     * The input configuration for a canary deployment.
      */
     readonly deploymentCanarySettings: pulumi.Output<outputs.apigateway.DeploymentCanarySettings | undefined>;
     /**
@@ -28,19 +28,19 @@ export declare class Deployment extends pulumi.CustomResource {
      */
     readonly deploymentId: pulumi.Output<string>;
     /**
-     * A description of the purpose of the API Gateway deployment.
+     * The description for the Deployment resource to create.
      */
     readonly description: pulumi.Output<string | undefined>;
     /**
-     * The ID of the RestApi resource to deploy.
+     * The string identifier of the associated RestApi.
      */
     readonly restApiId: pulumi.Output<string>;
     /**
-     * Configures the stage that API Gateway creates with this deployment.
+     * The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
      */
     readonly stageDescription: pulumi.Output<outputs.apigateway.DeploymentStageDescription | undefined>;
     /**
-     * A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
+     * The name of the Stage resource for the Deployment resource to create.
      */
     readonly stageName: pulumi.Output<string | undefined>;
     /**
@@ -57,23 +57,23 @@ export declare class Deployment extends pulumi.CustomResource {
  */
 export interface DeploymentArgs {
     /**
-     * Specifies settings for the canary deployment.
+     * The input configuration for a canary deployment.
      */
     deploymentCanarySettings?: pulumi.Input<inputs.apigateway.DeploymentCanarySettingsArgs>;
     /**
-     * A description of the purpose of the API Gateway deployment.
+     * The description for the Deployment resource to create.
      */
     description?: pulumi.Input<string>;
     /**
-     * The ID of the RestApi resource to deploy.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
     /**
-     * Configures the stage that API Gateway creates with this deployment.
+     * 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?: pulumi.Input<inputs.apigateway.DeploymentStageDescriptionArgs>;
     /**
-     * A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
+     * The name of the Stage resource for the Deployment resource to create.
      */
     stageName?: pulumi.Input<string>;
 }

package/apigateway/deployment.js

@@ -6,7 +6,7 @@ exports.Deployment = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Deployment
+ * 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.
  */
 class Deployment extends pulumi.CustomResource {
     /**

package/apigateway/documentationPart.d.ts

@@ -2,7 +2,7 @@ import * as pulumi from "@pulumi/pulumi";
 import * as inputs from "../types/input";
 import * as outputs from "../types/output";
 /**
- * Resource Type definition for AWS::ApiGateway::DocumentationPart
+ * 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*.
  */
 export declare class DocumentationPart extends pulumi.CustomResource {
     /**
@@ -24,15 +24,15 @@ export declare class DocumentationPart extends pulumi.CustomResource {
      */
     readonly documentationPartId: pulumi.Output<string>;
     /**
-     * The location of the API entity that the documentation applies to.
+     * The location of the targeted API entity of the to-be-created documentation part.
      */
     readonly location: pulumi.Output<outputs.apigateway.DocumentationPartLocation>;
     /**
-     * The documentation content map of the targeted API entity.
+     * 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.
      */
     readonly properties: pulumi.Output<string>;
     /**
-     * Identifier of the targeted API entity
+     * The string identifier of the associated RestApi.
      */
     readonly restApiId: pulumi.Output<string>;
     /**
@@ -49,15 +49,15 @@ export declare class DocumentationPart extends pulumi.CustomResource {
  */
 export interface DocumentationPartArgs {
     /**
-     * The location of the API entity that the documentation applies to.
+     * The location of the targeted API entity of the to-be-created documentation part.
      */
     location: pulumi.Input<inputs.apigateway.DocumentationPartLocationArgs>;
     /**
-     * The documentation content map of the targeted API entity.
+     * 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: pulumi.Input<string>;
     /**
-     * Identifier of the targeted API entity
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/documentationPart.js

@@ -6,7 +6,7 @@ exports.DocumentationPart = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::DocumentationPart
+ * 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*.
  */
 class DocumentationPart extends pulumi.CustomResource {
     /**

package/apigateway/documentationVersion.d.ts

@@ -1,6 +1,6 @@
 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 class DocumentationVersion extends pulumi.CustomResource {
     /**
@@ -18,15 +18,15 @@ export declare class DocumentationVersion extends pulumi.CustomResource {
      */
     static isInstance(obj: any): obj is DocumentationVersion;
     /**
-     * The description of the API documentation snapshot.
+     * A description about the new documentation snapshot.
      */
     readonly description: pulumi.Output<string | undefined>;
     /**
-     * The version identifier of the API documentation snapshot.
+     * The version identifier of the to-be-updated documentation version.
      */
     readonly documentationVersion: pulumi.Output<string>;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     readonly restApiId: pulumi.Output<string>;
     /**
@@ -43,15 +43,15 @@ export declare class DocumentationVersion extends pulumi.CustomResource {
  */
 export interface DocumentationVersionArgs {
     /**
-     * The description of the API documentation snapshot.
+     * A description about the new documentation snapshot.
      */
     description?: pulumi.Input<string>;
     /**
-     * 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/documentationVersion.js

@@ -6,7 +6,7 @@ exports.DocumentationVersion = 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*.
  */
 class DocumentationVersion extends pulumi.CustomResource {
     /**

package/apigateway/getAccount.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 export declare function getAccount(args: GetAccountArgs, opts?: pulumi.InvokeOptions): Promise<GetAccountResult>;
 export interface GetAccountArgs {
@@ -11,7 +11,7 @@ export interface GetAccountArgs {
 }
 export interface GetAccountResult {
     /**
-     * The Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your account.
+     * The ARN of an Amazon CloudWatch role for the current Account.
      */
     readonly cloudWatchRoleArn?: string;
     /**
@@ -20,7 +20,7 @@ export interface GetAccountResult {
     readonly id?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 export declare function getAccountOutput(args: GetAccountOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAccountResult>;
 export interface GetAccountOutputArgs {

package/apigateway/getAccount.js

@@ -6,7 +6,7 @@ exports.getAccountOutput = exports.getAccount = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 function getAccount(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -16,7 +16,7 @@ function getAccount(args, opts) {
 }
 exports.getAccount = getAccount;
 /**
- * Resource Type definition for AWS::ApiGateway::Account
+ * The ``AWS::ApiGateway::Account`` resource specifies the IAM role that Amazon API Gateway uses to write API logs to Amazon CloudWatch Logs. To avoid overwriting other roles, you should only have one ``AWS::ApiGateway::Account`` resource per region per account.
  */
 function getAccountOutput(args, opts) {
     return pulumi.output(args).apply((a) => getAccount(a, opts));

package/apigateway/getAuthorizer.d.ts

@@ -1,12 +1,12 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 export declare function getAuthorizer(args: GetAuthorizerArgs, opts?: pulumi.InvokeOptions): Promise<GetAuthorizerResult>;
 export interface GetAuthorizerArgs {
     authorizerId: string;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
@@ -16,24 +16,24 @@ export interface GetAuthorizerResult {
      */
     readonly authType?: string;
     /**
-     * Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer.
+     * 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.
      */
     readonly authorizerCredentials?: string;
     readonly authorizerId?: string;
     /**
-     * The TTL in seconds of cached authorizer results.
+     * 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.
      */
     readonly authorizerResultTtlInSeconds?: number;
     /**
-     * Specifies the authorizer's Uniform Resource Identifier (URI).
+     * 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``.
      */
     readonly authorizerUri?: string;
     /**
-     * The identity source for which authorization is requested.
+     * 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.
      */
     readonly identitySource?: string;
     /**
-     * A validation expression for the incoming identity token.
+     * 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.
      */
     readonly identityValidationExpression?: string;
     /**
@@ -41,22 +41,22 @@ export interface GetAuthorizerResult {
      */
     readonly name?: string;
     /**
-     * A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer.
+     * 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.
      */
     readonly providerArns?: string[];
     /**
-     * The authorizer type.
+     * 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.
      */
     readonly type?: string;
 }
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 export declare function getAuthorizerOutput(args: GetAuthorizerOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetAuthorizerResult>;
 export interface GetAuthorizerOutputArgs {
     authorizerId: pulumi.Input<string>;
     /**
-     * The identifier of the API.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getAuthorizer.js

@@ -6,7 +6,7 @@ exports.getAuthorizerOutput = exports.getAuthorizer = void 0;
 const pulumi = require("@pulumi/pulumi");
 const utilities = require("../utilities");
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 function getAuthorizer(args, opts) {
     opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
@@ -17,7 +17,7 @@ function getAuthorizer(args, opts) {
 }
 exports.getAuthorizer = getAuthorizer;
 /**
- * Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
+ * 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.
  */
 function getAuthorizerOutput(args, opts) {
     return pulumi.output(args).apply((a) => getAuthorizer(a, opts));

package/apigateway/getDeployment.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::Deployment
+ * 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.
  */
 export declare function getDeployment(args: GetDeploymentArgs, opts?: pulumi.InvokeOptions): Promise<GetDeploymentResult>;
 export interface GetDeploymentArgs {
@@ -9,7 +9,7 @@ export interface GetDeploymentArgs {
      */
     deploymentId: string;
     /**
-     * The ID of the RestApi resource to deploy.
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
@@ -19,12 +19,12 @@ export interface GetDeploymentResult {
      */
     readonly deploymentId?: string;
     /**
-     * A description of the purpose of the API Gateway deployment.
+     * The description for the Deployment resource to create.
      */
     readonly description?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::Deployment
+ * 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.
  */
 export declare function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDeploymentResult>;
 export interface GetDeploymentOutputArgs {
@@ -33,7 +33,7 @@ export interface GetDeploymentOutputArgs {
      */
     deploymentId: pulumi.Input<string>;
     /**
-     * The ID of the RestApi resource to deploy.
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getDeployment.js

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

package/apigateway/getDocumentationPart.d.ts

@@ -1,6 +1,6 @@
 import * as pulumi from "@pulumi/pulumi";
 /**
- * Resource Type definition for AWS::ApiGateway::DocumentationPart
+ * 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*.
  */
 export declare function getDocumentationPart(args: GetDocumentationPartArgs, opts?: pulumi.InvokeOptions): Promise<GetDocumentationPartResult>;
 export interface GetDocumentationPartArgs {
@@ -9,7 +9,7 @@ export interface GetDocumentationPartArgs {
      */
     documentationPartId: string;
     /**
-     * Identifier of the targeted API entity
+     * The string identifier of the associated RestApi.
      */
     restApiId: string;
 }
@@ -19,12 +19,12 @@ export interface GetDocumentationPartResult {
      */
     readonly documentationPartId?: string;
     /**
-     * The documentation content map of the targeted API entity.
+     * 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.
      */
     readonly properties?: string;
 }
 /**
- * Resource Type definition for AWS::ApiGateway::DocumentationPart
+ * 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*.
  */
 export declare function getDocumentationPartOutput(args: GetDocumentationPartOutputArgs, opts?: pulumi.InvokeOptions): pulumi.Output<GetDocumentationPartResult>;
 export interface GetDocumentationPartOutputArgs {
@@ -33,7 +33,7 @@ export interface GetDocumentationPartOutputArgs {
      */
     documentationPartId: pulumi.Input<string>;
     /**
-     * Identifier of the targeted API entity
+     * The string identifier of the associated RestApi.
      */
     restApiId: pulumi.Input<string>;
 }

package/apigateway/getDocumentationPart.js

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