A resource that can be distributed to callers for executing Method resources that require an API key.

|account_id|text|The AWS Account ID of the resource.|

|region|text|The AWS Region of the resource.|

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|created_date|timestamp without time zone|The timestamp when the API Key was created.|

|customer_id|text|An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.|

|description|text|The description of the API Key.|

|enabled|boolean|Specifies whether the API Key can be used by callers.|

|id|text|The identifier of the API Key.|

|last_updated_date|timestamp without time zone|The timestamp when the API Key was last updated.|

|name|text|The name of the API Key.|

|stage_keys|text[]|A list of Stage resources that are associated with the ApiKey resource.|

|tags|jsonb|The collection of tags. Each tag element is associated with a given resource.|

|value|text|The value of the API Key.|

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

|account_id|text|The AWS Account ID of the resource.|

|region|text|The AWS Region of the resource.|

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|id|text|The identifier of the client certificate.|

|created_date|timestamp without time zone|The timestamp when the client certificate was created.|

|description|text|The description of the client certificate.|

|expiration_date|timestamp without time zone|The timestamp when the client certificate will expire.|

|pem_encoded_certificate|text|The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .|

|tags|jsonb|The collection of tags. Each tag element is associated with a given resource.|

Represents the base path that callers of the API must provide as part of the URL after the domain name.

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|domain_name|text|The custom domain name as an API host name, for example, my-api.example.com.|

|base_path|text|The base path name that callers of the API must provide as part of the URL after the domain name.|

|rest_api_id|text|The string identifier of the associated RestApi.|

|stage|text|The name of the associated stage.|

Represents a custom domain name as a user-friendly host name of an API (RestApi).

|account_id|text|The AWS Account ID of the resource.|

|region|text|The AWS Region of the resource.|

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|certificate_arn|text|The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.|

|certificate_name|text|The name of the certificate that will be used by edge-optimized endpoint for this domain name.|

|certificate_upload_date|timestamp without time zone|The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.|

|distribution_domain_name|text|The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation (https://aws.amazon.com/documentation/cloudfront/).|

|distribution_hosted_zone_id|text|The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).|

|domain_name|text|The custom domain name as an API host name, for example, my-api.example.com.|

|domain_name_status|text|The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.|

|domain_name_status_message|text|An optional text message containing detailed information about status of the DomainName migration.|

|endpoint_configuration_types|text[]|A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.|

|endpoint_configuration_vpc_endpoint_ids|text[]|A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.|

|mutual_tls_authentication_truststore_uri|text|An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.|

|mutual_tls_authentication_truststore_version|text|The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.|

|mutual_tls_authentication_truststore_warnings|text[]|A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.|

|regional_certificate_arn|text|The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.|

|regional_certificate_name|text|The name of the certificate that will be used for validating the regional domain name.|

|regional_domain_name|text|The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.|

|regional_hosted_zone_id|text|The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name (https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-regional-api-custom-domain-create.html) and AWS Regions and Endpoints for API Gateway (https://docs.aws.amazon.com/general/latest/gr/rande.html#apigateway_region).|

|security_policy|text|The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.|

|tags|jsonb|The collection of tags. Each tag element is associated with a given resource.|

Represents an authorization layer for methods.

|rest_api_id|text|The API's identifier. This identifier is unique across all of your APIs in API Gateway.|

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|auth_type|text|Optional customer-defined field, used in OpenAPI imports and exports without functional impact.|

|authorizer_credentials|text|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.|

|authorizer_result_ttl_in_seconds|integer|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.|

|authorizer_uri|text|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.|

|id|text|The identifier for the authorizer resource.|

|identity_source|text|The identity source for which authorization is requested.|

|identity_validation_expression|text|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.|

|name|text|[Required] The name of the authorizer.|

|provider_arns|text[]|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.|

|type|text|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.|

An immutable representation of a RestApi resource that can be called by users using Stages.

|rest_api_id|text|The API's identifier. This identifier is unique across all of your APIs in API Gateway.|

|arn|text|The Amazon Resource Name (ARN) for the resource.|

|api_summary|jsonb|A summary of the RestApi at the date and time that the deployment resource was created.|

|created_date|timestamp without time zone|The date and time that the deployment resource was created.|

|description|text|The description for the deployment resource.|

|id|text|The identifier for the deployment resource.|