@aws-cdk/aws-apigateway
- Version 1.204.0
- Published
- 5.2 MB
- 14 dependencies
- Apache-2.0 license
Install
npm i @aws-cdk/aws-apigateway
yarn add @aws-cdk/aws-apigateway
pnpm add @aws-cdk/aws-apigateway
Overview
The CDK Construct Library for AWS::ApiGateway
Index
Classes
AccessLogField
- contextAccountId()
- contextApiId()
- contextAuthorizer()
- contextAuthorizerClaims()
- contextAuthorizerIntegrationLatency()
- contextAuthorizerPrincipalId()
- contextAwsEndpointRequestId()
- contextDomainName()
- contextDomainPrefix()
- contextErrorMessage()
- contextErrorMessageString()
- contextErrorResponseType()
- contextErrorValidationErrorString()
- contextExtendedRequestId()
- contextHttpMethod()
- contextIdentityAccountId()
- contextIdentityApiKey()
- contextIdentityApiKeyId()
- contextIdentityCaller()
- contextIdentityCognitoAuthenticationProvider()
- contextIdentityCognitoAuthenticationType()
- contextIdentityCognitoIdentityId()
- contextIdentityCognitoIdentityPoolId()
- contextIdentityPrincipalOrgId()
- contextIdentitySourceIp()
- contextIdentityUser()
- contextIdentityUserAgent()
- contextIdentityUserArn()
- contextIntegrationLatency()
- contextIntegrationStatus()
- contextPath()
- contextProtocol()
- contextRequestId()
- contextRequestOverrideHeader()
- contextRequestOverridePath()
- contextRequestOverrideQuerystring()
- contextRequestTime()
- contextRequestTimeEpoch()
- contextResourceId()
- contextResourcePath()
- contextResponseLatency()
- contextResponseLength()
- contextResponseOverrideHeader()
- contextResponseOverrideStatus()
- contextStage()
- contextStatus()
- contextWafResponseCode()
- contextWebaclArn()
- contextXrayTraceId()
CfnDomainName
- attrDistributionDomainName
- attrDistributionHostedZoneId
- attrRegionalDomainName
- attrRegionalHostedZoneId
- certificateArn
- CFN_RESOURCE_TYPE_NAME
- cfnProperties
- domainName
- endpointConfiguration
- inspect()
- mutualTlsAuthentication
- ownershipVerificationCertificateArn
- regionalCertificateArn
- renderProperties()
- securityPolicy
- tags
ResponseType
- ACCESS_DENIED
- API_CONFIGURATION_ERROR
- AUTHORIZER_CONFIGURATION_ERROR
- AUTHORIZER_FAILURE
- BAD_REQUEST_BODY
- BAD_REQUEST_PARAMETERS
- DEFAULT_4XX
- DEFAULT_5XX
- EXPIRED_TOKEN
- INTEGRATION_FAILURE
- INTEGRATION_TIMEOUT
- INVALID_API_KEY
- INVALID_SIGNATURE
- MISSING_AUTHENTICATION_TOKEN
- of()
- QUOTA_EXCEEDED
- REQUEST_TOO_LARGE
- RESOURCE_NOT_FOUND
- responseType
- THROTTLED
- UNAUTHORIZED
- UNSUPPORTED_MEDIA_TYPE
- WAF_FILTERED
RestApiBase
- addApiKey()
- addDomainName()
- addGatewayResponse()
- addUsagePlan()
- arnForExecuteApi()
- cloudWatchAccount
- configureCloudWatchRole()
- configureDeployment()
- deploymentStage
- domainName
- latestDeployment
- metric()
- metricCacheHitCount()
- metricCacheMissCount()
- metricClientError()
- metricCount()
- metricIntegrationLatency()
- metricLatency()
- metricServerError()
- restApiId
- restApiName
- restApiRootResourceId
- root
- urlForPath()
Interfaces
JsonSchema
- 'enum'
- additionalItems
- additionalProperties
- allOf
- anyOf
- contains
- default
- definitions
- dependencies
- description
- exclusiveMaximum
- exclusiveMinimum
- format
- id
- items
- maximum
- maxItems
- maxLength
- maxProperties
- minimum
- minItems
- minLength
- minProperties
- multipleOf
- not
- oneOf
- pattern
- patternProperties
- properties
- propertyNames
- ref
- required
- schema
- title
- type
- uniqueItems
Enums
Namespaces
Classes
class AccessLogField
class AccessLogField {}
$context variables that can be used to customize access log pattern.
method contextAccountId
static contextAccountId: () => string;
The API owner's AWS account ID.
method contextApiId
static contextApiId: () => string;
The identifier API Gateway assigns to your API.
method contextAuthorizer
static contextAuthorizer: (property: string) => string;
The stringified value of the specified key-value pair of the
context
map returned from an API Gateway Lambda authorizer function.Parameter property
key of the context map.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
method contextAuthorizerClaims
static contextAuthorizerClaims: (property: string) => string;
A property of the claims returned from the Amazon Cognito user pool after the method caller is successfully authenticated.
Parameter property
A property key of the claims.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html
method contextAuthorizerIntegrationLatency
static contextAuthorizerIntegrationLatency: () => string;
The authorizer latency in ms.
method contextAuthorizerPrincipalId
static contextAuthorizerPrincipalId: () => string;
The principal user identification associated with the token sent by the client and returned from an API Gateway Lambda authorizer (formerly known as a custom authorizer).
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-use-lambda-authorizer.html
method contextAwsEndpointRequestId
static contextAwsEndpointRequestId: () => string;
The AWS endpoint's request ID.
method contextDomainName
static contextDomainName: () => string;
The full domain name used to invoke the API. This should be the same as the incoming
Host
header.
method contextDomainPrefix
static contextDomainPrefix: () => string;
The first label of the
$context.domainName
. This is often used as a caller/customer identifier.
method contextErrorMessage
static contextErrorMessage: () => string;
A string containing an API Gateway error message.
method contextErrorMessageString
static contextErrorMessageString: () => string;
The quoted value of $context.error.message, namely "$context.error.message".
method contextErrorResponseType
static contextErrorResponseType: () => string;
A type of GatewayResponse. This variable can only be used for simple variable substitution in a GatewayResponse body-mapping template, which is not processed by the Velocity Template Language engine, and in access logging.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-websocket-api-logging.html
https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html
method contextErrorValidationErrorString
static contextErrorValidationErrorString: () => string;
A string containing a detailed validation error message.
method contextExtendedRequestId
static contextExtendedRequestId: () => string;
The extended ID that API Gateway assigns to the API request, which contains more useful information for debugging/troubleshooting.
method contextHttpMethod
static contextHttpMethod: () => string;
The HTTP method used. Valid values include:
DELETE
,GET
,HEAD
,OPTIONS
,PATCH
,POST
, andPUT
.
method contextIdentityAccountId
static contextIdentityAccountId: () => string;
The AWS account ID associated with the request.
method contextIdentityApiKey
static contextIdentityApiKey: () => string;
For API methods that require an API key, this variable is the API key associated with the method request. For methods that don't require an API key, this variable is
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html
method contextIdentityApiKeyId
static contextIdentityApiKeyId: () => string;
The API key ID associated with an API request that requires an API key.
method contextIdentityCaller
static contextIdentityCaller: () => string;
The principal identifier of the caller making the request.
method contextIdentityCognitoAuthenticationProvider
static contextIdentityCognitoAuthenticationProvider: () => string;
The Amazon Cognito authentication provider used by the caller making the request. Available only if the request was signed with Amazon Cognito credentials.
See Also
https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-identity.html
method contextIdentityCognitoAuthenticationType
static contextIdentityCognitoAuthenticationType: () => string;
The Amazon Cognito authentication type of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.
method contextIdentityCognitoIdentityId
static contextIdentityCognitoIdentityId: () => string;
The Amazon Cognito identity ID of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.
method contextIdentityCognitoIdentityPoolId
static contextIdentityCognitoIdentityPoolId: () => string;
The Amazon Cognito identity pool ID of the caller making the request. Available only if the request was signed with Amazon Cognito credentials.
method contextIdentityPrincipalOrgId
static contextIdentityPrincipalOrgId: () => string;
The AWS organization ID.
method contextIdentitySourceIp
static contextIdentitySourceIp: () => string;
The source IP address of the TCP connection making the request to API Gateway. Warning: You should not trust this value if there is any chance that the
X-Forwarded-For
header could be forged.
method contextIdentityUser
static contextIdentityUser: () => string;
The principal identifier of the user making the request. Used in Lambda authorizers.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-lambda-authorizer-output.html
method contextIdentityUserAgent
static contextIdentityUserAgent: () => string;
The User-Agent header of the API caller.
method contextIdentityUserArn
static contextIdentityUserArn: () => string;
The Amazon Resource Name (ARN) of the effective user identified after authentication.
See Also
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html
method contextIntegrationLatency
static contextIntegrationLatency: () => string;
The integration latency in ms.
method contextIntegrationStatus
static contextIntegrationStatus: () => string;
For Lambda proxy integration, this parameter represents the status code returned from AWS Lambda, not from the backend Lambda function.
method contextPath
static contextPath: () => string;
The request path. For example, for a non-proxy request URL of https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child, this value is /{stage}/root/child.
method contextProtocol
static contextProtocol: () => string;
The request protocol, for example, HTTP/1.1.
method contextRequestId
static contextRequestId: () => string;
The ID that API Gateway assigns to the API request.
method contextRequestOverrideHeader
static contextRequestOverrideHeader: (headerName: string) => string;
The request header override. If this parameter is defined, it contains the headers to be used instead of the HTTP Headers that are defined in the Integration Request pane.
Parameter headerName
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
method contextRequestOverridePath
static contextRequestOverridePath: (pathName: string) => string;
The request path override. If this parameter is defined, it contains the request path to be used instead of the URL Path Parameters that are defined in the Integration Request pane.
Parameter pathName
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
method contextRequestOverrideQuerystring
static contextRequestOverrideQuerystring: (querystringName: string) => string;
The request query string override. If this parameter is defined, it contains the request query strings to be used instead of the URL Query String Parameters that are defined in the Integration Request pane.
Parameter querystringName
method contextRequestTime
static contextRequestTime: () => string;
The CLF-formatted request time (dd/MMM/yyyy:HH:mm:ss +-hhmm).
method contextRequestTimeEpoch
static contextRequestTimeEpoch: () => string;
The Epoch-formatted request time.
method contextResourceId
static contextResourceId: () => string;
The identifier that API Gateway assigns to your resource.
method contextResourcePath
static contextResourcePath: () => string;
The path to your resource. For example, for the non-proxy request URI of
https://{rest-api-id.execute-api.{region}.amazonaws.com/{stage}/root/child
, The $context.resourcePath value is/root/child
.See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-create-api-step-by-step.html
method contextResponseLatency
static contextResponseLatency: () => string;
The response latency in ms.
method contextResponseLength
static contextResponseLength: () => string;
The response payload length.
method contextResponseOverrideHeader
static contextResponseOverrideHeader: (headerName: string) => string;
The response header override. If this parameter is defined, it contains the header to be returned instead of the Response header that is defined as the Default mapping in the Integration Response pane.
Parameter headerName
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
method contextResponseOverrideStatus
static contextResponseOverrideStatus: () => string;
The response status code override. If this parameter is defined, it contains the status code to be returned instead of the Method response status that is defined as the Default mapping in the Integration Response pane.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-override-request-response-parameters.html
method contextStage
static contextStage: () => string;
The deployment stage of the API request (for example,
Beta
orProd
).
method contextStatus
static contextStatus: () => string;
The method response status.
method contextWafResponseCode
static contextWafResponseCode: () => string;
The response received from AWS WAF:
WAF_ALLOW
orWAF_BLOCK
. Will not be set if the stage is not associated with a web ACL.See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
method contextWebaclArn
static contextWebaclArn: () => string;
The complete ARN of the web ACL that is used to decide whether to allow or block the request. Will not be set if the stage is not associated with a web ACL.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-control-access-aws-waf.html
method contextXrayTraceId
static contextXrayTraceId: () => string;
The trace ID for the X-Ray trace.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-enabling-xray.html
class AccessLogFormat
class AccessLogFormat {}
factory methods for access log format.
method clf
static clf: () => AccessLogFormat;
Generate Common Log Format.
method custom
static custom: (format: string) => AccessLogFormat;
Custom log format. You can create any log format string. You can easily get the $ context variable by using the methods of AccessLogField.
Parameter format
Example 1
apigateway.AccessLogFormat.custom(JSON.stringify({ requestId: apigateway.AccessLogField.contextRequestId(), sourceIp: apigateway.AccessLogField.contextIdentitySourceIp(), method: apigateway.AccessLogField.contextHttpMethod(), userContext: { sub: apigateway.AccessLogField.contextAuthorizerClaims('sub'), email: apigateway.AccessLogField.contextAuthorizerClaims('email') } }))
method jsonWithStandardFields
static jsonWithStandardFields: ( fields?: JsonWithStandardFieldProps) => AccessLogFormat;
Access log will be produced in the JSON format with a set of fields most useful in the access log. All fields are turned on by default with the option to turn off specific fields.
method toString
toString: () => string;
Output a format string to be used with CloudFormation.
class ApiDefinition
abstract class ApiDefinition {}
Represents an OpenAPI definition asset.
method bind
abstract bind: (scope: Construct) => ApiDefinitionConfig;
Called when the specification is initialized to allow this object to bind to the stack, add resources and have fun.
Parameter scope
The binding scope. Don't be smart about trying to down-cast or assume it's initialized. You may just use it as a construct scope.
method bindAfterCreate
bindAfterCreate: (_scope: Construct, _restApi: IRestApi) => void;
Called after the CFN RestApi resource has been created to allow the Api Definition to bind to it. Specifically it's required to allow assets to add metadata for tooling like SAM CLI to be able to find their origins.
method fromAsset
static fromAsset: ( file: string, options?: s3_assets.AssetOptions) => AssetApiDefinition;
Loads the API specification from a local disk asset.
method fromBucket
static fromBucket: ( bucket: s3.IBucket, key: string, objectVersion?: string) => S3ApiDefinition;
Creates an API definition from a specification file in an S3 bucket
method fromInline
static fromInline: (definition: any) => InlineApiDefinition;
Create an API definition from an inline object. The inline object must follow the schema of OpenAPI 2.0 or OpenAPI 3.0
Example 1
apigateway.ApiDefinition.fromInline({ openapi: '3.0.2', paths: { '/pets': { get: { 'responses': { 200: { content: { 'application/json': { schema: { $ref: '#/components/schemas/Empty', }, }, }, }, }, 'x-amazon-apigateway-integration': { responses: { default: { statusCode: '200', }, }, requestTemplates: { 'application/json': '{"statusCode": 200}', }, passthroughBehavior: 'when_no_match', type: 'mock', }, }, }, }, components: { schemas: { Empty: { title: 'Empty Schema', type: 'object', }, }, }, });
class ApiKey
class ApiKey extends ApiKeyBase {}
An API Gateway ApiKey.
An ApiKey can be distributed to API clients that are executing requests for Method resources that require an Api Key.
constructor
constructor(scope: Construct, id: string, props?: ApiKeyProps);
property keyArn
readonly keyArn: string;
property keyId
readonly keyId: string;
method fromApiKeyId
static fromApiKeyId: (scope: Construct, id: string, apiKeyId: string) => IApiKey;
Import an ApiKey by its Id
class AssetApiDefinition
class AssetApiDefinition extends ApiDefinition {}
OpenAPI specification from a local file.
constructor
constructor(path: string, options?: s3_assets.AssetOptions);
method bind
bind: (scope: Construct) => ApiDefinitionConfig;
method bindAfterCreate
bindAfterCreate: (scope: Construct, restApi: IRestApi) => void;
class Authorizer
abstract class Authorizer extends Resource implements IAuthorizer {}
Base class for all custom authorizers
constructor
constructor(scope: Construct, id: string, props?: ResourceProps);
property authorizationType
readonly authorizationType?: AuthorizationType;
property authorizerId
abstract readonly authorizerId: string;
method isAuthorizer
static isAuthorizer: (x: any) => x is Authorizer;
Return whether the given object is an Authorizer.
class AwsIntegration
class AwsIntegration extends Integration {}
This type of integration lets an API expose AWS service actions. It is intended for calling all AWS service actions, but is not recommended for calling a Lambda function, because the Lambda custom integration is a legacy technology.
constructor
constructor(props: AwsIntegrationProps);
method bind
bind: (method: Method) => IntegrationConfig;
class BasePathMapping
class BasePathMapping extends Resource {}
This resource creates a base path that clients who call your API must use in the invocation URL.
Unless you're importing a domain with
DomainName.fromDomainNameAttributes()
, you can useDomainName.addBasePathMapping()
to define mappings.
constructor
constructor(scope: Construct, id: string, props: BasePathMappingProps);
class CfnAccount
class CfnAccount extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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 oneAWS::ApiGateway::Account
resource per region per account.AWS::ApiGateway::Account external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnAccountProps);
Create a new
AWS::ApiGateway::Account
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrId
readonly attrId: string;
The ID for the account. For example:
abc123
. Id
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property cloudWatchRoleArn
cloudWatchRoleArn: string;
The ARN of an Amazon CloudWatch role for the current Account.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnApiKey
class CfnApiKey extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::ApiKey
The
AWS::ApiGateway::ApiKey
resource creates a unique key that you can distribute to clients who are executing API GatewayMethod
resources that require an API key. To specify which API key clients must use, map the API key with theRestApi
andStage
resources that include the methods that require a key.AWS::ApiGateway::ApiKey external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnApiKeyProps);
Create a new
AWS::ApiGateway::ApiKey
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrApiKeyId
readonly attrApiKeyId: string;
The ID for the API key. For example:
abc123
. APIKeyId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property customerId
customerId: string;
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
property description
description: string;
The description of the ApiKey.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
property enabled
enabled: any;
Specifies whether the ApiKey can be used by callers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
property generateDistinctId
generateDistinctId: any;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
property name
name: string;
A name for the API key. If you don't specify a name, AWS CloudFormation 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
property stageKeys
stageKeys: any;
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys
property tags
readonly tags: cdk.TagManager;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags
property value
value: string;
Specifies a value of the API key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnApiMappingV2
class CfnApiMappingV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::ApiMapping
AWS::ApiGatewayV2::ApiMapping deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnApiMappingV2Props);
Create a new
AWS::ApiGatewayV2::ApiMapping
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::ApiMapping.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid
property apiMappingKey
apiMappingKey: string;
AWS::ApiGatewayV2::ApiMapping.ApiMappingKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property domainName
domainName: string;
AWS::ApiGatewayV2::ApiMapping.DomainName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname
property stage
stage: string;
AWS::ApiGatewayV2::ApiMapping.Stage
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnApiV2
class CfnApiV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Api
AWS::ApiGatewayV2::Api deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props?: CfnApiV2Props);
Create a new
AWS::ApiGatewayV2::Api
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiKeySelectionExpression
apiKeySelectionExpression: string;
AWS::ApiGatewayV2::Api.ApiKeySelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression
property basePath
basePath: string;
AWS::ApiGatewayV2::Api.BasePath
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath
property body
body: any;
AWS::ApiGatewayV2::Api.Body
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body
property bodyS3Location
bodyS3Location: any;
AWS::ApiGatewayV2::Api.BodyS3Location
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property corsConfiguration
corsConfiguration: any;
AWS::ApiGatewayV2::Api.CorsConfiguration
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration
property credentialsArn
credentialsArn: string;
AWS::ApiGatewayV2::Api.CredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn
property description
description: string;
AWS::ApiGatewayV2::Api.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description
property disableSchemaValidation
disableSchemaValidation: any;
AWS::ApiGatewayV2::Api.DisableSchemaValidation
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation
property failOnWarnings
failOnWarnings: any;
AWS::ApiGatewayV2::Api.FailOnWarnings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings
property name
name: string;
AWS::ApiGatewayV2::Api.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name
property protocolType
protocolType: string;
AWS::ApiGatewayV2::Api.ProtocolType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype
property routeKey
routeKey: string;
AWS::ApiGatewayV2::Api.RouteKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey
property routeSelectionExpression
routeSelectionExpression: string;
AWS::ApiGatewayV2::Api.RouteSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression
property tags
readonly tags: cdk.TagManager;
AWS::ApiGatewayV2::Api.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags
property target
target: string;
AWS::ApiGatewayV2::Api.Target
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target
property version
version: string;
AWS::ApiGatewayV2::Api.Version
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnAuthorizer
class CfnAuthorizer extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::Authorizer
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.AWS::ApiGateway::Authorizer external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnAuthorizerProps);
Create a new
AWS::ApiGateway::Authorizer
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrAuthorizerId
readonly attrAuthorizerId: string;
The ID for the authorizer. For example:
abc123
. AuthorizerId
property authorizerCredentials
authorizerCredentials: 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials
property authorizerResultTtlInSeconds
authorizerResultTtlInSeconds: number;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds
property authorizerUri
authorizerUri: string;
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
property authType
authType: string;
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property identitySource
identitySource: string;
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
property identityValidationExpression
identityValidationExpression: string;
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression
property name
name: string;
The name of the authorizer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name
property providerArns
providerArns: 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 aTOKEN
orREQUEST
authorizer, this is not defined.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
property type
type: 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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnAuthorizerV2
class CfnAuthorizerV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Authorizer
AWS::ApiGatewayV2::Authorizer deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnAuthorizerV2Props);
Create a new
AWS::ApiGatewayV2::Authorizer
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::Authorizer.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid
property authorizerCredentialsArn
authorizerCredentialsArn: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn
property authorizerResultTtlInSeconds
authorizerResultTtlInSeconds: number;
AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds
property authorizerType
authorizerType: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype
property authorizerUri
authorizerUri: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerUri
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property identitySource
identitySource: string[];
AWS::ApiGatewayV2::Authorizer.IdentitySource
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource
property identityValidationExpression
identityValidationExpression: string;
AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression
property jwtConfiguration
jwtConfiguration: any;
AWS::ApiGatewayV2::Authorizer.JwtConfiguration
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration
property name
name: string;
AWS::ApiGatewayV2::Authorizer.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnBasePathMapping
class CfnBasePathMapping extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::BasePathMapping
The
AWS::ApiGateway::BasePathMapping
resource creates a base path that clients who call your API must use in the invocation URL.AWS::ApiGateway::BasePathMapping external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnBasePathMappingProps);
Create a new
AWS::ApiGateway::BasePathMapping
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property basePath
basePath: string;
The base path name that callers of the API must provide as part of the URL after the domain name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property domainName
domainName: string;
The domain name of the BasePathMapping resource to be described.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname
property id
id: string;
AWS::ApiGateway::BasePathMapping.Id
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid
property stage
stage: string;
The name of the associated stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnClientCertificate
class CfnClientCertificate extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::ClientCertificate
The
AWS::ApiGateway::ClientCertificate
resource creates a client certificate that API Gateway uses to configure client-side SSL authentication for sending requests to the integration endpoint.AWS::ApiGateway::ClientCertificate external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnClientCertificateProps);
Create a new
AWS::ApiGateway::ClientCertificate
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrClientCertificateId
readonly attrClientCertificateId: string;
The ID for the client certificate. For example:
abc123
. ClientCertificateId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property description
description: string;
The description of the client certificate.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description
property tags
readonly tags: cdk.TagManager;
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDeployment
class CfnDeployment extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::Deployment
The
AWS::ApiGateway::Deployment
resource deploys an API GatewayRestApi
resource to a stage so that clients can call the API over the internet. The stage acts as an environment.AWS::ApiGateway::Deployment external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnDeploymentProps);
Create a new
AWS::ApiGateway::Deployment
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrDeploymentId
readonly attrDeploymentId: string;
The ID for the deployment. For example:
abc123
. DeploymentId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property deploymentCanarySettings
deploymentCanarySettings: any;
The input configuration for a canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings
property description
description: string;
The description for the Deployment resource to create.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
property stageDescription
stageDescription: any;
The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
property stageName
stageName: string;
The name of the Stage resource for the Deployment resource to create.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDeploymentV2
class CfnDeploymentV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Deployment
AWS::ApiGatewayV2::Deployment deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnDeploymentV2Props);
Create a new
AWS::ApiGatewayV2::Deployment
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::Deployment.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property description
description: string;
AWS::ApiGatewayV2::Deployment.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description
property stageName
stageName: string;
AWS::ApiGatewayV2::Deployment.StageName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDocumentationPart
class CfnDocumentationPart extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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* .AWS::ApiGateway::DocumentationPart external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnDocumentationPartProps);
Create a new
AWS::ApiGateway::DocumentationPart
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrDocumentationPartId
readonly attrDocumentationPartId: string;
The ID for the documentation part. DocumentationPartId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property location
location: any;
The location of the targeted API entity of the to-be-created documentation part.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
property properties
properties: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDocumentationVersion
class CfnDocumentationVersion extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::DocumentationVersion
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* .AWS::ApiGateway::DocumentationVersion external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html
constructor
constructor( scope: cdk.Construct, id: string, props: CfnDocumentationVersionProps);
Create a new
AWS::ApiGateway::DocumentationVersion
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property description
description: string;
A description about the new documentation snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description
property documentationVersion
documentationVersion: string;
The version identifier of the to-be-updated documentation version.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDomainName
class CfnDomainName extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::DomainName
The
AWS::ApiGateway::DomainName
resource specifies a custom domain name for your API in API Gateway.You can use a custom domain name to provide a URL that's more intuitive and easier to recall. For more information about using custom domain names, see [Set up Custom Domain Name for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html) in the *API Gateway Developer Guide* .
AWS::ApiGateway::DomainName external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnDomainNameProps);
Create a new
AWS::ApiGateway::DomainName
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrDistributionDomainName
readonly attrDistributionDomainName: string;
The Amazon CloudFront distribution domain name that's mapped to the custom domain name. This is only applicable for endpoints whose type is
EDGE
.Example:
d111111abcdef8.cloudfront.net
DistributionDomainName
property attrDistributionHostedZoneId
readonly attrDistributionHostedZoneId: string;
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The only valid value is
Z2FDTNDATAQYW2
for all regions. DistributionHostedZoneId
property attrRegionalDomainName
readonly attrRegionalDomainName: string;
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. RegionalDomainName
property attrRegionalHostedZoneId
readonly attrRegionalHostedZoneId: string;
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. RegionalHostedZoneId
property certificateArn
certificateArn: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property domainName
domainName: string;
The custom domain name as an API host name, for example,
my-api.example.com
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
property endpointConfiguration
endpointConfiguration: any;
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
property mutualTlsAuthentication
mutualTlsAuthentication: any;
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication
property ownershipVerificationCertificateArn
ownershipVerificationCertificateArn: string;
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn
property regionalCertificateArn
regionalCertificateArn: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn
property securityPolicy
securityPolicy: string;
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy
property tags
readonly tags: cdk.TagManager;
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnDomainNameV2
class CfnDomainNameV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::DomainName
AWS::ApiGatewayV2::DomainName deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnDomainNameV2Props);
Create a new
AWS::ApiGatewayV2::DomainName
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrRegionalDomainName
readonly attrRegionalDomainName: string;
RegionalDomainName
property attrRegionalHostedZoneId
readonly attrRegionalHostedZoneId: string;
RegionalHostedZoneId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property domainName
domainName: string;
AWS::ApiGatewayV2::DomainName.DomainName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname
property domainNameConfigurations
domainNameConfigurations: any;
AWS::ApiGatewayV2::DomainName.DomainNameConfigurations
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations
property tags
readonly tags: cdk.TagManager;
AWS::ApiGatewayV2::DomainName.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnGatewayResponse
class CfnGatewayResponse extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::GatewayResponse
The
AWS::ApiGateway::GatewayResponse
resource creates a gateway response for your API. For more information, see [API Gateway Responses](https://docs.aws.amazon.com/apigateway/latest/developerguide/customize-gateway-responses.html#api-gateway-gatewayResponse-definition) in the *API Gateway Developer Guide* .AWS::ApiGateway::GatewayResponse external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnGatewayResponseProps);
Create a new
AWS::ApiGateway::GatewayResponse
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrId
readonly attrId: string;
The ID for the gateway response. For example:
abc123
. Id
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property responseParameters
responseParameters: any;
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
property responseTemplates
responseTemplates: any;
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
property responseType
responseType: string;
The response type of the associated GatewayResponse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid
property statusCode
statusCode: string;
The HTTP status code for this GatewayResponse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnIntegrationResponseV2
class CfnIntegrationResponseV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::IntegrationResponse
AWS::ApiGatewayV2::IntegrationResponse deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnIntegrationResponseV2Props);
Create a new
AWS::ApiGatewayV2::IntegrationResponse
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::IntegrationResponse.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property contentHandlingStrategy
contentHandlingStrategy: string;
AWS::ApiGatewayV2::IntegrationResponse.ContentHandlingStrategy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy
property integrationId
integrationId: string;
AWS::ApiGatewayV2::IntegrationResponse.IntegrationId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid
property integrationResponseKey
integrationResponseKey: string;
AWS::ApiGatewayV2::IntegrationResponse.IntegrationResponseKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey
property responseParameters
responseParameters: any;
AWS::ApiGatewayV2::IntegrationResponse.ResponseParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters
property responseTemplates
responseTemplates: any;
AWS::ApiGatewayV2::IntegrationResponse.ResponseTemplates
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates
property templateSelectionExpression
templateSelectionExpression: string;
AWS::ApiGatewayV2::IntegrationResponse.TemplateSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnIntegrationV2
class CfnIntegrationV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Integration
AWS::ApiGatewayV2::Integration deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnIntegrationV2Props);
Create a new
AWS::ApiGatewayV2::Integration
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::Integration.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property connectionType
connectionType: string;
AWS::ApiGatewayV2::Integration.ConnectionType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype
property contentHandlingStrategy
contentHandlingStrategy: string;
AWS::ApiGatewayV2::Integration.ContentHandlingStrategy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy
property credentialsArn
credentialsArn: string;
AWS::ApiGatewayV2::Integration.CredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn
property description
description: string;
AWS::ApiGatewayV2::Integration.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description
property integrationMethod
integrationMethod: string;
AWS::ApiGatewayV2::Integration.IntegrationMethod
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod
property integrationType
integrationType: string;
AWS::ApiGatewayV2::Integration.IntegrationType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype
property integrationUri
integrationUri: string;
AWS::ApiGatewayV2::Integration.IntegrationUri
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri
property passthroughBehavior
passthroughBehavior: string;
AWS::ApiGatewayV2::Integration.PassthroughBehavior
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior
property payloadFormatVersion
payloadFormatVersion: string;
AWS::ApiGatewayV2::Integration.PayloadFormatVersion
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion
property requestParameters
requestParameters: any;
AWS::ApiGatewayV2::Integration.RequestParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters
property requestTemplates
requestTemplates: any;
AWS::ApiGatewayV2::Integration.RequestTemplates
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates
property templateSelectionExpression
templateSelectionExpression: string;
AWS::ApiGatewayV2::Integration.TemplateSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression
property timeoutInMillis
timeoutInMillis: number;
AWS::ApiGatewayV2::Integration.TimeoutInMillis
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnMethod
class CfnMethod extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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.AWS::ApiGateway::Method external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnMethodProps);
Create a new
AWS::ApiGateway::Method
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiKeyRequired
apiKeyRequired: any;
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
property authorizationScopes
authorizationScopes: string[];
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
property authorizationType
authorizationType: 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, specifyCUSTOM
orCOGNITO_USER_POOLS
for this property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
property authorizerId
authorizerId: string;
The identifier of an authorizer to use on this method. The method's authorization type must be
CUSTOM
orCOGNITO_USER_POOLS
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property httpMethod
httpMethod: string;
The method's HTTP verb.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
property integration
integration: any;
Represents an
HTTP
,HTTP_PROXY
,AWS
,AWS_PROXY
, or Mock integration.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
property methodResponses
methodResponses: any;
Gets a method response associated with a given HTTP status code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
property operationName
operationName: string;
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
property requestModels
requestModels: any;
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).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
property requestParameters
requestParameters: any;
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}
, wherelocation
isquerystring
,path
, orheader
andname
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
property requestValidatorId
requestValidatorId: string;
The identifier of a RequestValidator for request validation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
property resourceId
resourceId: string;
The Resource identifier for the MethodResponse resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnModel
class CfnModel extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::Model
The
AWS::ApiGateway::Model
resource defines the structure of a request or response payload for an API method.AWS::ApiGateway::Model external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnModelProps);
Create a new
AWS::ApiGateway::Model
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property contentType
contentType: string;
The content-type for the model.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype
property description
description: string;
The description of the model.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description
property name
name: string;
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. 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
property schema
schema: any;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnModelV2
class CfnModelV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Model
AWS::ApiGatewayV2::Model deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnModelV2Props);
Create a new
AWS::ApiGatewayV2::Model
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::Model.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property contentType
contentType: string;
AWS::ApiGatewayV2::Model.ContentType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype
property description
description: string;
AWS::ApiGatewayV2::Model.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description
property name
name: string;
AWS::ApiGatewayV2::Model.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name
property schema
schema: any;
AWS::ApiGatewayV2::Model.Schema
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnRequestValidator
class CfnRequestValidator extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::RequestValidator
The
AWS::ApiGateway::RequestValidator
resource sets up basic validation rules for incoming requests to your API. For more information, see [Enable Basic Request Validation for an API in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-request-validation.html) in the *API Gateway Developer Guide* .AWS::ApiGateway::RequestValidator external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnRequestValidatorProps);
Create a new
AWS::ApiGateway::RequestValidator
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrRequestValidatorId
readonly attrRequestValidatorId: string;
The ID for the request validator. For example:
abc123
. RequestValidatorId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property name
name: string;
The name of this RequestValidator
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
property validateRequestBody
validateRequestBody: any;
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
property validateRequestParameters
validateRequestParameters: any;
A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnResource
class CfnResource extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::Resource
The
AWS::ApiGateway::Resource
resource creates a resource in an API.AWS::ApiGateway::Resource external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnResourceProps);
Create a new
AWS::ApiGateway::Resource
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrResourceId
readonly attrResourceId: string;
The ID for the resource. For example:
abc123
. ResourceId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property parentId
parentId: string;
The parent resource's identifier.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
property pathPart
pathPart: string;
The last path segment for this resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnRestApi
class CfnRestApi extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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.
AWS::ApiGateway::RestApi external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnRestApiProps);
Create a new
AWS::ApiGateway::RestApi
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiKeySourceType
apiKeySourceType: string;
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
property attrRestApiId
readonly attrRestApiId: string;
The string identifier of the associated RestApi. RestApiId
property attrRootResourceId
readonly attrRootResourceId: string;
The root resource ID for a
RestApi
resource, such asa0bc123d4e
. RootResourceId
property binaryMediaTypes
binaryMediaTypes: string[];
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
property body
body: any;
An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body
property bodyS3Location
bodyS3Location: any;
The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property cloneFrom
cloneFrom: string;
The ID of the RestApi that you want to clone from.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
property description
description: string;
The description of the RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
property disableExecuteApiEndpoint
disableExecuteApiEndpoint: any;
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpointhttp://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint
property endpointConfiguration
endpointConfiguration: any;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
property failOnWarnings
failOnWarnings: any;
A query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. The default value isfalse
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
property minimumCompressionSize
minimumCompressionSize: number;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
property mode
mode: string;
This property applies only when you use OpenAPI to define your REST API. The
Mode
determines how API Gateway handles resource updates.Valid values are
overwrite
ormerge
.For
overwrite
, the new API definition replaces the existing one. The existing API identifier remains unchanged.For
merge
, the new API definition is merged with the existing API.If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is
overwrite
. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.Use the default mode to define top-level
RestApi
properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
property name
name: string;
The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
property parameters
parameters: any;
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set
ignore=documentation
as aparameters
value, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
property policy
policy: any;
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"*"
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy
property tags
readonly tags: cdk.TagManager;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnRouteResponseV2
class CfnRouteResponseV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::RouteResponse
AWS::ApiGatewayV2::RouteResponse deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnRouteResponseV2Props);
Create a new
AWS::ApiGatewayV2::RouteResponse
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::RouteResponse.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property modelSelectionExpression
modelSelectionExpression: string;
AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression
property responseModels
responseModels: any;
AWS::ApiGatewayV2::RouteResponse.ResponseModels
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels
property responseParameters
responseParameters: any;
AWS::ApiGatewayV2::RouteResponse.ResponseParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters
property routeId
routeId: string;
AWS::ApiGatewayV2::RouteResponse.RouteId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid
property routeResponseKey
routeResponseKey: string;
AWS::ApiGatewayV2::RouteResponse.RouteResponseKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnRouteV2
class CfnRouteV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Route
AWS::ApiGatewayV2::Route deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnRouteV2Props);
Create a new
AWS::ApiGatewayV2::Route
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiId
apiId: string;
AWS::ApiGatewayV2::Route.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid
property apiKeyRequired
apiKeyRequired: any;
AWS::ApiGatewayV2::Route.ApiKeyRequired
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
property authorizationScopes
authorizationScopes: string[];
AWS::ApiGatewayV2::Route.AuthorizationScopes
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes
property authorizationType
authorizationType: string;
AWS::ApiGatewayV2::Route.AuthorizationType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype
property authorizerId
authorizerId: string;
AWS::ApiGatewayV2::Route.AuthorizerId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property modelSelectionExpression
modelSelectionExpression: string;
AWS::ApiGatewayV2::Route.ModelSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression
property operationName
operationName: string;
AWS::ApiGatewayV2::Route.OperationName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname
property requestModels
requestModels: any;
AWS::ApiGatewayV2::Route.RequestModels
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels
property requestParameters
requestParameters: any;
AWS::ApiGatewayV2::Route.RequestParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters
property routeKey
routeKey: string;
AWS::ApiGatewayV2::Route.RouteKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey
property routeResponseSelectionExpression
routeResponseSelectionExpression: string;
AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression
property target
target: string;
AWS::ApiGatewayV2::Route.Target
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnStage
class CfnStage extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::Stage
The
AWS::ApiGateway::Stage
resource creates a stage for a deployment.AWS::ApiGateway::Stage external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnStageProps);
Create a new
AWS::ApiGateway::Stage
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property accessLogSetting
accessLogSetting: any;
Access log settings, including the access log format and access log destination ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting
property cacheClusterEnabled
cacheClusterEnabled: any;
Specifies whether a cache cluster is enabled for the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled
property cacheClusterSize
cacheClusterSize: string;
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) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize
property canarySetting
canarySetting: any;
Settings for the canary deployment in this stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property clientCertificateId
clientCertificateId: string;
The identifier of a client certificate for an API stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid
property deploymentId
deploymentId: string;
The identifier of the Deployment that the stage points to.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
property description
description: string;
The stage's description.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description
property documentationVersion
documentationVersion: string;
The version of the associated API documentation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion
property methodSettings
methodSettings: any;
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/\* /\*
for overriding all methods in the stage.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings
property restApiId
restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid
property stageName
stageName: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename
property tags
readonly tags: cdk.TagManager;
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags
property tracingEnabled
tracingEnabled: any;
Specifies whether active tracing with X-ray is enabled for the Stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled
property variables
variables: any;
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-._~:/?#&=,]+
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnStageV2
class CfnStageV2 extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGatewayV2::Stage
AWS::ApiGatewayV2::Stage deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html
Deprecated
moved to package aws-apigatewayv2
constructor
constructor(scope: Construct, id: string, props: CfnStageV2Props);
Create a new
AWS::ApiGatewayV2::Stage
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property accessLogSettings
accessLogSettings: any;
AWS::ApiGatewayV2::Stage.AccessLogSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings
property apiId
apiId: string;
AWS::ApiGatewayV2::Stage.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid
property autoDeploy
autoDeploy: any;
AWS::ApiGatewayV2::Stage.AutoDeploy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property clientCertificateId
clientCertificateId: string;
AWS::ApiGatewayV2::Stage.ClientCertificateId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid
property defaultRouteSettings
defaultRouteSettings: any;
AWS::ApiGatewayV2::Stage.DefaultRouteSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings
property deploymentId
deploymentId: string;
AWS::ApiGatewayV2::Stage.DeploymentId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid
property description
description: string;
AWS::ApiGatewayV2::Stage.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description
property routeSettings
routeSettings: any;
AWS::ApiGatewayV2::Stage.RouteSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings
property stageName
stageName: string;
AWS::ApiGatewayV2::Stage.StageName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename
property stageVariables
stageVariables: any;
AWS::ApiGatewayV2::Stage.StageVariables
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables
property tags
readonly tags: cdk.TagManager;
AWS::ApiGatewayV2::Stage.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnUsagePlan
class CfnUsagePlan extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::UsagePlan
The
AWS::ApiGateway::UsagePlan
resource creates a usage plan for deployed APIs. A usage plan sets a target for the throttling and quota limits on individual client API keys. For more information, see [Creating and Using API Usage Plans in Amazon API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-api-usage-plans.html) in the *API Gateway Developer Guide* .In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
AWS::ApiGateway::UsagePlan external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
constructor
constructor(scope: cdk.Construct, id: string, props?: CfnUsagePlanProps);
Create a new
AWS::ApiGateway::UsagePlan
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property apiStages
apiStages: any;
The associated API stages of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages
property attrId
readonly attrId: string;
The ID for the usage plan. For example:
abc123
. Id
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property description
description: string;
The description of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description
property quota
quota: any;
The target maximum number of permitted requests per a given unit time interval.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota
property tags
readonly tags: cdk.TagManager;
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags
property throttle
throttle: any;
A map containing method level throttling information for API stage in a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle
property usagePlanName
usagePlanName: string;
The name of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnUsagePlanKey
class CfnUsagePlanKey extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
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.AWS::ApiGateway::UsagePlanKey external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnUsagePlanKeyProps);
Create a new
AWS::ApiGateway::UsagePlanKey
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrId
readonly attrId: string;
The ID for the usage plan key. For example:
abc123
. Id
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property keyId
keyId: string;
The Id of the UsagePlanKey resource to be deleted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
property keyType
keyType: string;
The type of a UsagePlanKey resource for a plan customer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
property usagePlanId
usagePlanId: string;
The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CfnVpcLink
class CfnVpcLink extends cdk.CfnResource implements cdk.IInspectable {}
A CloudFormation
AWS::ApiGateway::VpcLink
The
AWS::ApiGateway::VpcLink
resource creates an API Gateway VPC link for a REST API to access resources in an Amazon Virtual Private Cloud (VPC). For more information, see [vpclink:create](https://docs.aws.amazon.com/apigateway/latest/api/API_CreateVpcLink.html) in theAmazon API Gateway REST API Reference
.AWS::ApiGateway::VpcLink external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html
constructor
constructor(scope: cdk.Construct, id: string, props: CfnVpcLinkProps);
Create a new
AWS::ApiGateway::VpcLink
.Parameter scope
scope in which this resource is defined
Parameter id
scoped id of the resource
Parameter props
resource properties
property attrVpcLinkId
readonly attrVpcLinkId: string;
VpcLinkId
property CFN_RESOURCE_TYPE_NAME
static readonly CFN_RESOURCE_TYPE_NAME: string;
The CloudFormation resource type name for this resource class.
property cfnProperties
readonly cfnProperties: { [key: string]: any };
property description
description: string;
The description of the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description
property name
name: string;
The name used to label and identify the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name
property tags
readonly tags: cdk.TagManager;
An array of arbitrary tags (key-value pairs) to associate with the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags
property targetArns
targetArns: string[];
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns
method inspect
inspect: (inspector: cdk.TreeInspector) => void;
Examines the CloudFormation resource and discloses attributes.
Parameter inspector
tree inspector to collect and process attributes
method renderProperties
protected renderProperties: (props: { [key: string]: any }) => { [key: string]: any;};
class CognitoUserPoolsAuthorizer
class CognitoUserPoolsAuthorizer extends Authorizer implements IAuthorizer {}
Cognito user pools based custom authorizer
AWS::ApiGateway::Authorizer
constructor
constructor( scope: Construct, id: string, props: CognitoUserPoolsAuthorizerProps);
property authorizationType
readonly authorizationType?: AuthorizationType;
The authorization type of this authorizer.
property authorizerArn
readonly authorizerArn: string;
The ARN of the authorizer to be used in permission policies, such as IAM and resource-based grants.
property authorizerId
readonly authorizerId: string;
The id of the authorizer.
class Cors
class Cors {}
property ALL_METHODS
static readonly ALL_METHODS: string[];
All HTTP methods.
property ALL_ORIGINS
static readonly ALL_ORIGINS: string[];
All origins.
property DEFAULT_HEADERS
static readonly DEFAULT_HEADERS: string[];
The set of default headers allowed for CORS and useful for API Gateway.
class Deployment
class Deployment extends Resource {}
A Deployment of a REST API.
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
Normally, you don't need to define deployments manually. The RestApi construct manages a Deployment resource that represents the latest model. It can be accessed through
restApi.latestDeployment
(unlessdeploy: false
is set when defining theRestApi
).If you manually define this resource, you will need to know that since deployments are immutable, as long as the resource's logical ID doesn't change, the deployment will represent the snapshot in time in which the resource was created. This means that if you modify the RestApi model (i.e. add methods or resources), these changes will not be reflected unless a new deployment resource is created.
To achieve this behavior, the method
addToLogicalId(data)
can be used to augment the logical ID generated for the deployment resource such that it will include arbitrary data. This is done automatically for therestApi.latestDeployment
deployment.Furthermore, since a deployment does not reference any of the REST API resources and methods, CloudFormation will likely provision it before these resources are created, which means that it will represent a "half-baked" model. Use the
node.addDependency(dep)
method to circumvent that. This is done automatically for therestApi.latestDeployment
deployment.
constructor
constructor(scope: Construct, id: string, props: DeploymentProps);
property api
readonly api: IRestApi;
property deploymentId
readonly deploymentId: string;
method addToLogicalId
addToLogicalId: (data: any) => void;
Adds a component to the hash that determines this Deployment resource's logical ID.
This should be called by constructs of the API Gateway model that want to invalidate the deployment when their settings change. The component will be resolve()ed during synthesis so tokens are welcome.
class DomainName
class DomainName extends Resource implements IDomainName {}
constructor
constructor(scope: Construct, id: string, props: DomainNameProps);
property domainName
readonly domainName: string;
property domainNameAliasDomainName
readonly domainNameAliasDomainName: string;
property domainNameAliasHostedZoneId
readonly domainNameAliasHostedZoneId: string;
method addBasePathMapping
addBasePathMapping: ( targetApi: IRestApi, options?: BasePathMappingOptions) => BasePathMapping;
Maps this domain to an API endpoint.
Parameter targetApi
That target API endpoint, requests will be mapped to the deployment stage.
Parameter options
Options for mapping to base path with or without a stage
method fromDomainNameAttributes
static fromDomainNameAttributes: ( scope: Construct, id: string, attrs: DomainNameAttributes) => IDomainName;
Imports an existing domain name.
class EmptyModel
class EmptyModel implements IModel {}
Represents a reference to a REST API's Empty model, which is available as part of the model collection by default. This can be used for mapping JSON responses from an integration to what is returned to a client, where strong typing is not required. In the absence of any defined model, the Empty model will be used to return the response payload unmapped.
Definition { "$schema" : "http://json-schema.org/draft-04/schema#", "title" : "Empty Schema", "type" : "object" }
See Also
https://docs.amazonaws.cn/en_us/apigateway/latest/developerguide/models-mappings.html#models-mappings-models
Deprecated
You should use Model.EMPTY_MODEL
property modelId
readonly modelId: string;
class ErrorModel
class ErrorModel implements IModel {}
Represents a reference to a REST API's Error model, which is available as part of the model collection by default. This can be used for mapping error JSON responses from an integration to a client, where a simple generic message field is sufficient to map and return an error payload.
Definition { "$schema" : "http://json-schema.org/draft-04/schema#", "title" : "Error Schema", "type" : "object", "properties" : { "message" : { "type" : "string" } } }
Deprecated
You should use Model.ERROR_MODEL
property modelId
readonly modelId: string;
class GatewayResponse
class GatewayResponse extends Resource implements IGatewayResponse {}
Configure the response received by clients, produced from the API Gateway backend.
AWS::ApiGateway::GatewayResponse
constructor
constructor(scope: Construct, id: string, props: GatewayResponseProps);
class HttpIntegration
class HttpIntegration extends Integration {}
You can integrate an API method with an HTTP endpoint using the HTTP proxy integration or the HTTP custom integration,.
With the proxy integration, the setup is simple. You only need to set the HTTP method and the HTTP endpoint URI, according to the backend requirements, if you are not concerned with content encoding or caching.
With the custom integration, the setup is more involved. In addition to the proxy integration setup steps, you need to specify how the incoming request data is mapped to the integration request and how the resulting integration response data is mapped to the method response.
constructor
constructor(url: string, props?: HttpIntegrationProps);
class IdentitySource
class IdentitySource {}
Represents an identity source.
The source can be specified either as a literal value (e.g:
Auth
) which cannot be blank, or as an unresolved string token.
method context
static context: (context: string) => string;
Provides a properly formatted request context identity source.
Parameter context
the name of the context variable the
IdentitySource
will represent.Returns
a request context identity source.
method header
static header: (headerName: string) => string;
Provides a properly formatted header identity source.
Parameter headerName
the name of the header the
IdentitySource
will represent.Returns
a header identity source.
method queryString
static queryString: (queryString: string) => string;
Provides a properly formatted query string identity source.
Parameter queryString
the name of the query string the
IdentitySource
will represent.Returns
a query string identity source.
method stageVariable
static stageVariable: (stageVariable: string) => string;
Provides a properly formatted API Gateway stage variable identity source.
Parameter stageVariable
the name of the stage variable the
IdentitySource
will represent.Returns
an API Gateway stage variable identity source.
class InlineApiDefinition
class InlineApiDefinition extends ApiDefinition {}
OpenAPI specification from an inline JSON object.
constructor
constructor(definition: any);
method bind
bind: (_scope: Construct) => ApiDefinitionConfig;
class Integration
class Integration {}
Base class for backend integrations for an API Gateway method.
Use one of the concrete classes such as
MockIntegration
,AwsIntegration
,LambdaIntegration
or implement on your own by specifying the set of props.
constructor
constructor(props: IntegrationProps);
method bind
bind: (_method: Method) => IntegrationConfig;
Can be overridden by subclasses to allow the integration to interact with the method being integrated, access the REST API object, method ARNs, etc.
class LambdaIntegration
class LambdaIntegration extends AwsIntegration {}
Integrates an AWS Lambda function to an API Gateway method.
Example 1
declare const resource: apigateway.Resource; declare const handler: lambda.Function; resource.addMethod('GET', new apigateway.LambdaIntegration(handler));
constructor
constructor(handler: lambda.IFunction, options?: LambdaIntegrationOptions);
method bind
bind: (method: Method) => IntegrationConfig;
class LambdaRestApi
class LambdaRestApi extends RestApi {}
Defines an API Gateway REST API with AWS Lambda proxy integration.
Use the
proxy
property to define a greedy proxy ("{proxy+}") and "ANY" method from the specified path. If not defined, you will need to explicity add resources and methods to the API.
constructor
constructor(scope: Construct, id: string, props: LambdaRestApiProps);
class LogGroupLogDestination
class LogGroupLogDestination implements IAccessLogDestination {}
Use CloudWatch Logs as a custom access log destination for API Gateway.
constructor
constructor(logGroup: ILogGroup);
method bind
bind: (_stage: IStage) => AccessLogDestinationConfig;
Binds this destination to the CloudWatch Logs.
class Method
class Method extends Resource {}
constructor
constructor(scope: Construct, id: string, props: MethodProps);
property api
readonly api: IRestApi;
The API Gateway RestApi associated with this method.
property httpMethod
readonly httpMethod: string;
property methodArn
readonly methodArn: string;
Returns an execute-api ARN for this method:
arn:aws:execute-api:{region}:{account}:{restApiId}/{stage}/{method}/{path}
NOTE: {stage} will refer to the
restApi.deploymentStage
, which will automatically set if auto-deploy is enabled, or can be explicitly assigned. When not configured, {stage} will be set to '*', as a shorthand for 'all stages'.
property methodId
readonly methodId: string;
property resource
readonly resource: IResource;
property restApi
readonly restApi: RestApi;
The RestApi associated with this Method
Deprecated
- Throws an error if this Resource is not associated with an instance of
RestApi
. Useapi
instead.
property testMethodArn
readonly testMethodArn: string;
Returns an execute-api ARN for this method's "test-invoke-stage" stage. This stage is used by the AWS Console UI when testing the method.
method addMethodResponse
addMethodResponse: (methodResponse: MethodResponse) => void;
Add a method response to this method
class MockIntegration
class MockIntegration extends Integration {}
This type of integration lets API Gateway return a response without sending the request further to the backend. This is useful for API testing because it can be used to test the integration set up without incurring charges for using the backend and to enable collaborative development of an API. In collaborative development, a team can isolate their development effort by setting up simulations of API components owned by other teams by using the MOCK integrations. It is also used to return CORS-related headers to ensure that the API method permits CORS access. In fact, the API Gateway console integrates the OPTIONS method to support CORS with a mock integration. Gateway responses are other examples of mock integrations.
constructor
constructor(options?: IntegrationOptions);
class Model
class Model extends Resource implements IModel {}
constructor
constructor(scope: Construct, id: string, props: ModelProps);
property EMPTY_MODEL
static readonly EMPTY_MODEL: IModel;
Represents a reference to a REST API's Empty model, which is available as part of the model collection by default. This can be used for mapping JSON responses from an integration to what is returned to a client, where strong typing is not required. In the absence of any defined model, the Empty model will be used to return the response payload unmapped.
Definition { "$schema" : "http://json-schema.org/draft-04/schema#", "title" : "Empty Schema", "type" : "object" }
See Also
https://docs.amazonaws.cn/en_us/apigateway/latest/developerguide/models-mappings.html#models-mappings-models
property ERROR_MODEL
static readonly ERROR_MODEL: IModel;
Represents a reference to a REST API's Error model, which is available as part of the model collection by default. This can be used for mapping error JSON responses from an integration to a client, where a simple generic message field is sufficient to map and return an error payload.
Definition { "$schema" : "http://json-schema.org/draft-04/schema#", "title" : "Error Schema", "type" : "object", "properties" : { "message" : { "type" : "string" } } }
property modelId
readonly modelId: string;
Returns the model name, such as 'myModel'
method fromModelName
static fromModelName: ( scope: Construct, id: string, modelName: string) => IModel;
class ProxyResource
class ProxyResource extends Resource {}
Defines a {proxy+} greedy resource and an ANY method on a route.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-set-up-simple-proxy.html
constructor
constructor(scope: Construct, id: string, props: ProxyResourceProps);
property anyMethod
readonly anyMethod?: Method;
If
props.anyMethod
istrue
, this will be the reference to the 'ANY' method associated with this proxy resource.
method addMethod
addMethod: ( httpMethod: string, integration?: Integration, options?: MethodOptions) => Method;
class RateLimitedApiKey
class RateLimitedApiKey extends ApiKeyBase {}
An API Gateway ApiKey, for which a rate limiting configuration can be specified.
AWS::ApiGateway::ApiKey
constructor
constructor(scope: Construct, id: string, props?: RateLimitedApiKeyProps);
property keyArn
readonly keyArn: string;
property keyId
readonly keyId: string;
class RequestAuthorizer
class RequestAuthorizer extends LambdaAuthorizer {}
Request-based lambda authorizer that recognizes the caller's identity via request parameters, such as headers, paths, query strings, stage variables, or context variables. Based on the request, authorization is performed by a lambda function.
AWS::ApiGateway::Authorizer
constructor
constructor(scope: Construct, id: string, props: RequestAuthorizerProps);
property authorizerArn
readonly authorizerArn: string;
property authorizerId
readonly authorizerId: string;
class RequestValidator
class RequestValidator extends Resource implements IRequestValidator {}
constructor
constructor(scope: Construct, id: string, props: RequestValidatorProps);
property requestValidatorId
readonly requestValidatorId: string;
ID of the request validator, such as abc123
method fromRequestValidatorId
static fromRequestValidatorId: ( scope: Construct, id: string, requestValidatorId: string) => IRequestValidator;
class Resource
class Resource extends ResourceBase {}
constructor
constructor(scope: Construct, id: string, props: ResourceProps);
property api
readonly api: IRestApi;
property defaultCorsPreflightOptions
readonly defaultCorsPreflightOptions?: CorsOptions;
property defaultIntegration
readonly defaultIntegration?: Integration;
property defaultMethodOptions
readonly defaultMethodOptions?: MethodOptions;
property parentResource
readonly parentResource?: IResource;
property path
readonly path: string;
property resourceId
readonly resourceId: string;
property restApi
readonly restApi: RestApi;
The RestApi associated with this Resource
Deprecated
- Throws an error if this Resource is not associated with an instance of
RestApi
. Useapi
instead.
method fromResourceAttributes
static fromResourceAttributes: ( scope: Construct, id: string, attrs: ResourceAttributes) => IResource;
Import an existing resource
class ResourceBase
abstract class ResourceBase extends ResourceConstruct implements IResource {}
constructor
constructor(scope: Construct, id: string);
property api
abstract readonly api: IRestApi;
property defaultCorsPreflightOptions
abstract readonly defaultCorsPreflightOptions?: CorsOptions;
property defaultIntegration
abstract readonly defaultIntegration?: Integration;
property defaultMethodOptions
abstract readonly defaultMethodOptions?: MethodOptions;
property parentResource
abstract readonly parentResource?: IResource;
property path
abstract readonly path: string;
property resourceId
abstract readonly resourceId: string;
property restApi
abstract readonly restApi: RestApi;
Deprecated
- Throws an error if this Resource is not associated with an instance of
RestApi
. Useapi
instead.
property url
readonly url: string;
Deprecated
- Throws error in some use cases that have been enabled since this deprecation notice. Use
RestApi.urlForPath()
instead.
method addCorsPreflight
addCorsPreflight: (options: CorsOptions) => Method;
method addMethod
addMethod: ( httpMethod: string, integration?: Integration, options?: MethodOptions) => Method;
method addProxy
addProxy: (options?: ProxyResourceOptions) => ProxyResource;
method addResource
addResource: (pathPart: string, options?: ResourceOptions) => Resource;
method getResource
getResource: (pathPart: string) => IResource | undefined;
method resourceForPath
resourceForPath: (path: string) => Resource;
class ResponseType
class ResponseType {}
Supported types of gateway responses.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
property ACCESS_DENIED
static readonly ACCESS_DENIED: ResponseType;
The gateway response for authorization failure.
property API_CONFIGURATION_ERROR
static readonly API_CONFIGURATION_ERROR: ResponseType;
The gateway response for an invalid API configuration.
property AUTHORIZER_CONFIGURATION_ERROR
static readonly AUTHORIZER_CONFIGURATION_ERROR: ResponseType;
The gateway response for failing to connect to a custom or Amazon Cognito authorizer.
property AUTHORIZER_FAILURE
static readonly AUTHORIZER_FAILURE: ResponseType;
The gateway response when a custom or Amazon Cognito authorizer failed to authenticate the caller.
property BAD_REQUEST_BODY
static readonly BAD_REQUEST_BODY: ResponseType;
The gateway response when the request body cannot be validated according to an enabled request validator.
property BAD_REQUEST_PARAMETERS
static readonly BAD_REQUEST_PARAMETERS: ResponseType;
The gateway response when the request parameter cannot be validated according to an enabled request validator.
property DEFAULT_4XX
static readonly DEFAULT_4XX: ResponseType;
The default gateway response for an unspecified response type with the status code of 4XX.
property DEFAULT_5XX
static readonly DEFAULT_5XX: ResponseType;
The default gateway response for an unspecified response type with a status code of 5XX.
property EXPIRED_TOKEN
static readonly EXPIRED_TOKEN: ResponseType;
The gateway response for an AWS authentication token expired error.
property INTEGRATION_FAILURE
static readonly INTEGRATION_FAILURE: ResponseType;
The gateway response for an integration failed error.
property INTEGRATION_TIMEOUT
static readonly INTEGRATION_TIMEOUT: ResponseType;
The gateway response for an integration timed out error.
property INVALID_API_KEY
static readonly INVALID_API_KEY: ResponseType;
The gateway response for an invalid API key submitted for a method requiring an API key.
property INVALID_SIGNATURE
static readonly INVALID_SIGNATURE: ResponseType;
The gateway response for an invalid AWS signature error.
property MISSING_AUTHENTICATION_TOKEN
static readonly MISSING_AUTHENTICATION_TOKEN: ResponseType;
The gateway response for a missing authentication token error, including the cases when the client attempts to invoke an unsupported API method or resource.
property QUOTA_EXCEEDED
static readonly QUOTA_EXCEEDED: ResponseType;
The gateway response for the usage plan quota exceeded error.
property REQUEST_TOO_LARGE
static readonly REQUEST_TOO_LARGE: ResponseType;
The gateway response for the request too large error.
property RESOURCE_NOT_FOUND
static readonly RESOURCE_NOT_FOUND: ResponseType;
The gateway response when API Gateway cannot find the specified resource after an API request passes authentication and authorization.
property responseType
readonly responseType: string;
Valid value of response type.
property THROTTLED
static readonly THROTTLED: ResponseType;
The gateway response when usage plan, method, stage, or account level throttling limits exceeded.
property UNAUTHORIZED
static readonly UNAUTHORIZED: ResponseType;
The gateway response when the custom or Amazon Cognito authorizer failed to authenticate the caller.
property UNSUPPORTED_MEDIA_TYPE
static readonly UNSUPPORTED_MEDIA_TYPE: ResponseType;
The gateway response when a payload is of an unsupported media type, if strict passthrough behavior is enabled.
property WAF_FILTERED
static readonly WAF_FILTERED: ResponseType;
The gateway response when a request is blocked by AWS WAF.
method of
static of: (type: string) => ResponseType;
A custom response type to support future cases.
class RestApi
class RestApi extends RestApiBase {}
Represents a REST API in Amazon API Gateway.
Use
addResource
andaddMethod
to configure the API model.By default, the API will automatically be deployed and accessible from a public endpoint.
constructor
constructor(scope: Construct, id: string, props?: RestApiProps);
property methods
readonly methods: Method[];
The list of methods bound to this RestApi
property restApiId
readonly restApiId: string;
property restApiRootResourceId
readonly restApiRootResourceId: string;
property root
readonly root: IResource;
property url
readonly url: string;
The deployed root URL of this REST API.
method addModel
addModel: (id: string, props: ModelOptions) => Model;
Adds a new model.
method addRequestValidator
addRequestValidator: ( id: string, props: RequestValidatorOptions) => RequestValidator;
Adds a new request validator.
method fromRestApiAttributes
static fromRestApiAttributes: ( scope: Construct, id: string, attrs: RestApiAttributes) => IRestApi;
Import an existing RestApi that can be configured with additional Methods and Resources.
method fromRestApiId
static fromRestApiId: ( scope: Construct, id: string, restApiId: string) => IRestApi;
Import an existing RestApi.
method validate
protected validate: () => string[];
Performs validation of the REST API.
class RestApiBase
abstract class RestApiBase extends Resource implements IRestApi {}
Base implementation that are common to various implementations of IRestApi
constructor
constructor(scope: Construct, id: string, props?: RestApiBaseProps);
property cloudWatchAccount
protected cloudWatchAccount?: CfnAccount;
property deploymentStage
deploymentStage: Stage;
API Gateway stage that points to the latest deployment (if defined).
If
deploy
is disabled, you will need to explicitly assign this value in order to set up integrations.
property domainName
readonly domainName: DomainName;
The first domain name mapped to this API, if defined through the
domainName
configuration prop, or added viaaddDomainName
property latestDeployment
readonly latestDeployment: Deployment;
API Gateway deployment that represents the latest changes of the API. This resource will be automatically updated every time the REST API model changes. This will be undefined if
deploy
is false.
property restApiId
abstract readonly restApiId: string;
The ID of this API Gateway RestApi.
property restApiName
readonly restApiName: string;
A human friendly name for this Rest API. Note that this is different from
restApiId
.
property restApiRootResourceId
abstract readonly restApiRootResourceId: string;
The resource ID of the root resource.
property root
abstract readonly root: IResource;
Represents the root resource of this API endpoint ('/'). Resources and Methods are added to this resource.
method addApiKey
addApiKey: (id: string, options?: ApiKeyOptions) => IApiKey;
Add an ApiKey
method addDomainName
addDomainName: (id: string, options: DomainNameOptions) => DomainName;
Defines an API Gateway domain name and maps it to this API.
Parameter id
The construct id
Parameter options
custom domain options
method addGatewayResponse
addGatewayResponse: ( id: string, options: GatewayResponseOptions) => GatewayResponse;
Adds a new gateway response.
method addUsagePlan
addUsagePlan: (id: string, props?: UsagePlanProps) => UsagePlan;
Adds a usage plan.
method arnForExecuteApi
arnForExecuteApi: (method?: string, path?: string, stage?: string) => string;
method configureCloudWatchRole
protected configureCloudWatchRole: (apiResource: CfnRestApi) => void;
Deprecated
This method will be made internal. No replacement
method configureDeployment
protected configureDeployment: (props: RestApiBaseProps) => void;
Deprecated
This method will be made internal. No replacement
method metric
metric: ( metricName: string, props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Returns the given named metric for this API
method metricCacheHitCount
metricCacheHitCount: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the number of requests served from the API cache in a given period.
Default: sum over 5 minutes
method metricCacheMissCount
metricCacheMissCount: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the number of requests served from the backend in a given period, when API caching is enabled.
Default: sum over 5 minutes
method metricClientError
metricClientError: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the number of client-side errors captured in a given period.
Default: sum over 5 minutes
method metricCount
metricCount: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the total number API requests in a given period.
Default: sample count over 5 minutes
method metricIntegrationLatency
metricIntegrationLatency: ( props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the time between when API Gateway relays a request to the backend and when it receives a response from the backend.
Default: average over 5 minutes.
method metricLatency
metricLatency: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
The time between when API Gateway receives a request from a client and when it returns a response to the client. The latency includes the integration latency and other API Gateway overhead.
Default: average over 5 minutes.
method metricServerError
metricServerError: (props?: cloudwatch.MetricOptions) => cloudwatch.Metric;
Metric for the number of server-side errors captured in a given period.
Default: sum over 5 minutes
method urlForPath
urlForPath: (path?: string) => string;
Returns the URL for an HTTP path.
Fails if
deploymentStage
is not set either bydeploy
or explicitly.
class S3ApiDefinition
class S3ApiDefinition extends ApiDefinition {}
OpenAPI specification from an S3 archive.
constructor
constructor(bucket: s3.IBucket, key: string, objectVersion?: string);
method bind
bind: (_scope: Construct) => ApiDefinitionConfig;
class SpecRestApi
class SpecRestApi extends RestApiBase {}
Represents a REST API in Amazon API Gateway, created with an OpenAPI specification.
Some properties normally accessible on
See Also
RestApi - such as the description - must be declared in the specification. All Resources and Methods need to be defined as part of the OpenAPI specification file, and cannot be added via the CDK.
By default, the API will automatically be deployed and accessible from a public endpoint.
AWS::ApiGateway::RestApi
constructor
constructor(scope: Construct, id: string, props: SpecRestApiProps);
property restApiId
readonly restApiId: string;
The ID of this API Gateway RestApi.
property restApiRootResourceId
readonly restApiRootResourceId: string;
The resource ID of the root resource.
property root
readonly root: IResource;
class Stage
class Stage extends Resource implements IStage {}
constructor
constructor(scope: Construct, id: string, props: StageProps);
property restApi
readonly restApi: IRestApi;
property stageArn
readonly stageArn: string;
Returns the resource ARN for this stage:
arn:aws:apigateway:{region}::/restapis/{restApiId}/stages/{stageName}
Note that this is separate from the execute-api ARN for methods and resources within this stage.
property stageName
readonly stageName: string;
method urlForPath
urlForPath: (path?: string) => string;
Returns the invoke URL for a certain path.
Parameter path
The resource path
class StepFunctionsIntegration
class StepFunctionsIntegration {}
Options to integrate with various StepFunction API
method startExecution
static startExecution: ( stateMachine: sfn.IStateMachine, options?: StepFunctionsExecutionIntegrationOptions) => AwsIntegration;
Integrates a Synchronous Express State Machine from AWS Step Functions to an API Gateway method.
Example 1
const stateMachine = new stepfunctions.StateMachine(this, 'MyStateMachine', { stateMachineType: stepfunctions.StateMachineType.EXPRESS, definition: stepfunctions.Chain.start(new stepfunctions.Pass(this, 'Pass')), });
const api = new apigateway.RestApi(this, 'Api', { restApiName: 'MyApi', }); api.root.addMethod('GET', apigateway.StepFunctionsIntegration.startExecution(stateMachine));
class StepFunctionsRestApi
class StepFunctionsRestApi extends RestApi {}
Defines an API Gateway REST API with a Synchrounous Express State Machine as a proxy integration.
constructor
constructor(scope: Construct, id: string, props: StepFunctionsRestApiProps);
class TokenAuthorizer
class TokenAuthorizer extends LambdaAuthorizer {}
Token based lambda authorizer that recognizes the caller's identity as a bearer token, such as a JSON Web Token (JWT) or an OAuth token. Based on the token, authorization is performed by a lambda function.
AWS::ApiGateway::Authorizer
constructor
constructor(scope: Construct, id: string, props: TokenAuthorizerProps);
property authorizerArn
readonly authorizerArn: string;
property authorizerId
readonly authorizerId: string;
class UsagePlan
class UsagePlan extends UsagePlanBase {}
constructor
constructor(scope: Construct, id: string, props?: UsagePlanProps);
property usagePlanId
readonly usagePlanId: string;
method addApiStage
addApiStage: (apiStage: UsagePlanPerApiStage) => void;
Adds an apiStage.
Parameter apiStage
method fromUsagePlanId
static fromUsagePlanId: ( scope: Construct, id: string, usagePlanId: string) => IUsagePlan;
Import an externally defined usage plan using its ARN.
Parameter scope
the construct that will "own" the imported usage plan.
Parameter id
the id of the imported usage plan in the construct tree.
Parameter usagePlanId
the id of an existing usage plan.
class VpcLink
class VpcLink extends Resource implements IVpcLink {}
Define a new VPC Link Specifies an API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
constructor
constructor(scope: Construct, id: string, props?: VpcLinkProps);
property vpcLinkId
readonly vpcLinkId: string;
Physical ID of the VpcLink resource
method addTargets
addTargets: (...targets: elbv2.INetworkLoadBalancer[]) => void;
method fromVpcLinkId
static fromVpcLinkId: ( scope: Construct, id: string, vpcLinkId: string) => IVpcLink;
Import a VPC Link by its Id
method validate
protected validate: () => string[];
Interfaces
interface AccessLogDestinationConfig
interface AccessLogDestinationConfig {}
Options when binding a log destination to a RestApi Stage.
property destinationArn
readonly destinationArn: string;
The Amazon Resource Name (ARN) of the destination resource
interface AddApiKeyOptions
interface AddApiKeyOptions {}
Options to the UsagePlan.addApiKey() method
property overrideLogicalId
readonly overrideLogicalId?: string;
Override the CloudFormation logical id of the AWS::ApiGateway::UsagePlanKey resource - autogenerated by the CDK
interface ApiDefinitionConfig
interface ApiDefinitionConfig {}
Post-Binding Configuration for a CDK construct
property inlineDefinition
readonly inlineDefinition?: any;
Inline specification (mutually exclusive with
s3Location
).- API definition is not defined inline
property s3Location
readonly s3Location?: ApiDefinitionS3Location;
The location of the specification in S3 (mutually exclusive with
inlineDefinition
).- API definition is not an S3 location
interface ApiDefinitionS3Location
interface ApiDefinitionS3Location {}
S3 location of the API definition file
interface ApiKeyOptions
interface ApiKeyOptions extends ResourceOptions {}
The options for creating an API Key.
property apiKeyName
readonly apiKeyName?: string;
A name for the API key. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the API key name. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name automically generated name
property description
readonly description?: string;
A description of the purpose of the API key. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description none
property value
readonly value?: string;
The value of the API key. Must be at least 20 characters long. https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value none
interface ApiKeyProps
interface ApiKeyProps extends ApiKeyOptions {}
ApiKey Properties.
property customerId
readonly customerId?: string;
An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid none
property enabled
readonly enabled?: boolean;
Indicates whether the API key can be used by clients. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled true
property generateDistinctId
readonly generateDistinctId?: boolean;
Specifies whether the key identifier is distinct from the created API key value. http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid false
property resources
readonly resources?: IRestApi[];
A list of resources this api key is associated with. none
interface AwsIntegrationProps
interface AwsIntegrationProps {}
property action
readonly action?: string;
The AWS action to perform in the integration.
Use
actionParams
to specify key-value params for the action.Mutually exclusive with
path
.
property actionParameters
readonly actionParameters?: { [key: string]: string;};
Parameters for the action.
action
must be set, andpath
must be undefined. The action params will be URL encoded.
property integrationHttpMethod
readonly integrationHttpMethod?: string;
The integration's HTTP method type.
POST
property options
readonly options?: IntegrationOptions;
Integration options, such as content handling, request/response mapping, etc.
property path
readonly path?: string;
The path to use for path-base APIs.
For example, for S3 GET, you can set path to
bucket/key
. For lambda, you can set path to2015-03-31/functions/${function-arn}/invocations
Mutually exclusive with the
action
options.
property proxy
readonly proxy?: boolean;
Use AWS_PROXY integration.
false
property region
readonly region?: string;
The region of the integrated AWS service.
- same region as the stack
property service
readonly service: string;
The name of the integrated AWS service (e.g.
s3
)
property subdomain
readonly subdomain?: string;
A designated subdomain supported by certain AWS service for fast host-name lookup.
interface BasePathMappingOptions
interface BasePathMappingOptions {}
property basePath
readonly basePath?: string;
The base path name that callers of the API must provide in the URL after the domain name (e.g.
example.com/base-path
). If you specify this property, it can't be an empty string.- map requests from the domain root (e.g.
example.com
). If this is undefined, no additional mappings will be allowed on this domain name.
property stage
readonly stage?: Stage;
The Deployment stage of API [disable-awslint:ref-via-interface] - map to deploymentStage of restApi otherwise stage needs to pass in URL
interface BasePathMappingProps
interface BasePathMappingProps extends BasePathMappingOptions {}
property domainName
readonly domainName: IDomainName;
The DomainName to associate with this base path mapping.
property restApi
readonly restApi: IRestApi;
The RestApi resource to target.
interface CfnAccountProps
interface CfnAccountProps {}
Properties for defining a
CfnAccount
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html
property cloudWatchRoleArn
readonly cloudWatchRoleArn?: string;
The ARN of an Amazon CloudWatch role for the current Account.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-account.html#cfn-apigateway-account-cloudwatchrolearn
interface CfnApiKeyProps
interface CfnApiKeyProps {}
Properties for defining a
CfnApiKey
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html
property customerId
readonly customerId?: string;
An AWS Marketplace customer identifier, when integrating with the AWS SaaS Marketplace.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-customerid
property description
readonly description?: string;
The description of the ApiKey.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-description
property enabled
readonly enabled?: boolean | cdk.IResolvable;
Specifies whether the ApiKey can be used by callers.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-enabled
property generateDistinctId
readonly generateDistinctId?: boolean | cdk.IResolvable;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-generatedistinctid
property name
readonly name?: string;
A name for the API key. If you don't specify a name, AWS CloudFormation 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-name
property stageKeys
readonly stageKeys?: | Array<CfnApiKey.StageKeyProperty | cdk.IResolvable> | cdk.IResolvable;
DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-stagekeys
property tags
readonly tags?: cdk.CfnTag[];
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags
property value
readonly value?: string;
Specifies a value of the API key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-value
interface CfnApiMappingV2Props
interface CfnApiMappingV2Props {}
Properties for defining a
AWS::ApiGatewayV2::ApiMapping
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::ApiMapping.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apiid
property apiMappingKey
readonly apiMappingKey?: string;
AWS::ApiGatewayV2::ApiMapping.ApiMappingKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-apimappingkey
property domainName
readonly domainName: string;
AWS::ApiGatewayV2::ApiMapping.DomainName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-domainname
property stage
readonly stage: string;
AWS::ApiGatewayV2::ApiMapping.Stage
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-apimapping.html#cfn-apigatewayv2-apimapping-stage
interface CfnApiV2Props
interface CfnApiV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Api
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html
Deprecated
moved to package aws-apigatewayv2
property apiKeySelectionExpression
readonly apiKeySelectionExpression?: string;
AWS::ApiGatewayV2::Api.ApiKeySelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-apikeyselectionexpression
property basePath
readonly basePath?: string;
AWS::ApiGatewayV2::Api.BasePath
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-basepath
property body
readonly body?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Api.Body
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-body
property bodyS3Location
readonly bodyS3Location?: CfnApiV2.BodyS3LocationProperty | cdk.IResolvable;
AWS::ApiGatewayV2::Api.BodyS3Location
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-bodys3location
property corsConfiguration
readonly corsConfiguration?: CfnApiV2.CorsProperty | cdk.IResolvable;
AWS::ApiGatewayV2::Api.CorsConfiguration
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-corsconfiguration
property credentialsArn
readonly credentialsArn?: string;
AWS::ApiGatewayV2::Api.CredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-credentialsarn
property description
readonly description?: string;
AWS::ApiGatewayV2::Api.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-description
property disableSchemaValidation
readonly disableSchemaValidation?: boolean | cdk.IResolvable;
AWS::ApiGatewayV2::Api.DisableSchemaValidation
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-disableschemavalidation
property failOnWarnings
readonly failOnWarnings?: boolean | cdk.IResolvable;
AWS::ApiGatewayV2::Api.FailOnWarnings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-failonwarnings
property name
readonly name?: string;
AWS::ApiGatewayV2::Api.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-name
property protocolType
readonly protocolType?: string;
AWS::ApiGatewayV2::Api.ProtocolType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-protocoltype
property routeKey
readonly routeKey?: string;
AWS::ApiGatewayV2::Api.RouteKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routekey
property routeSelectionExpression
readonly routeSelectionExpression?: string;
AWS::ApiGatewayV2::Api.RouteSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-routeselectionexpression
property tags
readonly tags?: any;
AWS::ApiGatewayV2::Api.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-tags
property target
readonly target?: string;
AWS::ApiGatewayV2::Api.Target
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-target
property version
readonly version?: string;
AWS::ApiGatewayV2::Api.Version
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-api.html#cfn-apigatewayv2-api-version
interface CfnAuthorizerProps
interface CfnAuthorizerProps {}
Properties for defining a
CfnAuthorizer
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html
property authorizerCredentials
readonly authorizerCredentials?: 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizercredentials
property authorizerResultTtlInSeconds
readonly authorizerResultTtlInSeconds?: number;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizerresultttlinseconds
property authorizerUri
readonly authorizerUri?: string;
Specifies the authorizer's Uniform Resource Identifier (URI). For
TOKEN
orREQUEST
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 formarn: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
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
property authType
readonly authType?: string;
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authtype
property identitySource
readonly identitySource?: string;
The identity source for which authorization is requested. For a
TOKEN
orCOGNITO_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 isAuth
, the header mapping expression ismethod.request.header.Auth
. For theREQUEST
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 anAuth
header, aName
query string parameter are defined as identity sources, this value ismethod.request.header.Auth, method.request.querystring.Name
. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUEST
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identitysource
property identityValidationExpression
readonly identityValidationExpression?: string;
A validation expression for the incoming identity token. For
TOKEN
authorizers, this value is a regular expression. ForCOGNITO_USER_POOLS
authorizers, API Gateway will match theaud
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 theREQUEST
authorizer.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-identityvalidationexpression
property name
readonly name: string;
The name of the authorizer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-name
property providerArns
readonly providerArns?: 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 aTOKEN
orREQUEST
authorizer, this is not defined.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
property type
readonly type: 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, andCOGNITO_USER_POOLS
for using an Amazon Cognito user pool.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-type
interface CfnAuthorizerV2Props
interface CfnAuthorizerV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Authorizer
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Authorizer.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-apiid
property authorizerCredentialsArn
readonly authorizerCredentialsArn?: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerCredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizercredentialsarn
property authorizerResultTtlInSeconds
readonly authorizerResultTtlInSeconds?: number;
AWS::ApiGatewayV2::Authorizer.AuthorizerResultTtlInSeconds
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizerresultttlinseconds
property authorizerType
readonly authorizerType: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizertype
property authorizerUri
readonly authorizerUri?: string;
AWS::ApiGatewayV2::Authorizer.AuthorizerUri
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-authorizeruri
property identitySource
readonly identitySource: string[];
AWS::ApiGatewayV2::Authorizer.IdentitySource
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identitysource
property identityValidationExpression
readonly identityValidationExpression?: string;
AWS::ApiGatewayV2::Authorizer.IdentityValidationExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-identityvalidationexpression
property jwtConfiguration
readonly jwtConfiguration?: | CfnAuthorizerV2.JWTConfigurationProperty | cdk.IResolvable;
AWS::ApiGatewayV2::Authorizer.JwtConfiguration
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-jwtconfiguration
property name
readonly name: string;
AWS::ApiGatewayV2::Authorizer.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-authorizer.html#cfn-apigatewayv2-authorizer-name
interface CfnBasePathMappingProps
interface CfnBasePathMappingProps {}
Properties for defining a
CfnBasePathMapping
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html
property basePath
readonly basePath?: string;
The base path name that callers of the API must provide as part of the URL after the domain name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-basepath
property domainName
readonly domainName: string;
The domain name of the BasePathMapping resource to be described.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-domainname
property id
readonly id?: string;
AWS::ApiGateway::BasePathMapping.Id
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-id
property restApiId
readonly restApiId?: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-restapiid
property stage
readonly stage?: string;
The name of the associated stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-basepathmapping.html#cfn-apigateway-basepathmapping-stage
interface CfnClientCertificateProps
interface CfnClientCertificateProps {}
Properties for defining a
CfnClientCertificate
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html
property description
readonly description?: string;
The description of the client certificate.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-description
property tags
readonly tags?: cdk.CfnTag[];
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-clientcertificate.html#cfn-apigateway-clientcertificate-tags
interface CfnDeploymentProps
interface CfnDeploymentProps {}
Properties for defining a
CfnDeployment
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html
property deploymentCanarySettings
readonly deploymentCanarySettings?: | CfnDeployment.DeploymentCanarySettingsProperty | cdk.IResolvable;
The input configuration for a canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings
property description
readonly description?: string;
The description for the Deployment resource to create.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
property stageDescription
readonly stageDescription?: | CfnDeployment.StageDescriptionProperty | cdk.IResolvable;
The description of the Stage resource for the Deployment resource to create. To specify a stage description, you must also provide a stage name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
property stageName
readonly stageName?: string;
The name of the Stage resource for the Deployment resource to create.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagename
interface CfnDeploymentV2Props
interface CfnDeploymentV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Deployment
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Deployment.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-apiid
property description
readonly description?: string;
AWS::ApiGatewayV2::Deployment.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-description
property stageName
readonly stageName?: string;
AWS::ApiGatewayV2::Deployment.StageName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-deployment.html#cfn-apigatewayv2-deployment-stagename
interface CfnDocumentationPartProps
interface CfnDocumentationPartProps {}
Properties for defining a
CfnDocumentationPart
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html
property location
readonly location: CfnDocumentationPart.LocationProperty | cdk.IResolvable;
The location of the targeted API entity of the to-be-created documentation part.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
property properties
readonly properties: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-restapiid
interface CfnDocumentationVersionProps
interface CfnDocumentationVersionProps {}
Properties for defining a
CfnDocumentationVersion
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html
property description
readonly description?: string;
A description about the new documentation snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-description
property documentationVersion
readonly documentationVersion: string;
The version identifier of the to-be-updated documentation version.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-restapiid
interface CfnDomainNameProps
interface CfnDomainNameProps {}
Properties for defining a
CfnDomainName
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html
property certificateArn
readonly certificateArn?: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-certificatearn
property domainName
readonly domainName?: string;
The custom domain name as an API host name, for example,
my-api.example.com
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
property endpointConfiguration
readonly endpointConfiguration?: | CfnDomainName.EndpointConfigurationProperty | cdk.IResolvable;
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-endpointconfiguration
property mutualTlsAuthentication
readonly mutualTlsAuthentication?: | CfnDomainName.MutualTlsAuthenticationProperty | cdk.IResolvable;
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-mutualtlsauthentication
property ownershipVerificationCertificateArn
readonly ownershipVerificationCertificateArn?: string;
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the RegionalCertificateArn.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-ownershipverificationcertificatearn
property regionalCertificateArn
readonly regionalCertificateArn?: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-regionalcertificatearn
property securityPolicy
readonly securityPolicy?: string;
The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are
TLS_1_0
andTLS_1_2
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-securitypolicy
property tags
readonly tags?: cdk.CfnTag[];
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-tags
interface CfnDomainNameV2Props
interface CfnDomainNameV2Props {}
Properties for defining a
AWS::ApiGatewayV2::DomainName
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html
Deprecated
moved to package aws-apigatewayv2
property domainName
readonly domainName: string;
AWS::ApiGatewayV2::DomainName.DomainName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainname
property domainNameConfigurations
readonly domainNameConfigurations?: | Array<CfnDomainNameV2.DomainNameConfigurationProperty | cdk.IResolvable> | cdk.IResolvable;
AWS::ApiGatewayV2::DomainName.DomainNameConfigurations
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-domainnameconfigurations
property tags
readonly tags?: any;
AWS::ApiGatewayV2::DomainName.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-domainname.html#cfn-apigatewayv2-domainname-tags
interface CfnGatewayResponseProps
interface CfnGatewayResponseProps {}
Properties for defining a
CfnGatewayResponse
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html
property responseParameters
readonly responseParameters?: | { [key: string]: string; } | cdk.IResolvable;
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
property responseTemplates
readonly responseTemplates?: | { [key: string]: string; } | cdk.IResolvable;
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
property responseType
readonly responseType: string;
The response type of the associated GatewayResponse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-restapiid
property statusCode
readonly statusCode?: string;
The HTTP status code for this GatewayResponse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-statuscode
interface CfnIntegrationResponseV2Props
interface CfnIntegrationResponseV2Props {}
Properties for defining a
AWS::ApiGatewayV2::IntegrationResponse
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::IntegrationResponse.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-apiid
property contentHandlingStrategy
readonly contentHandlingStrategy?: string;
AWS::ApiGatewayV2::IntegrationResponse.ContentHandlingStrategy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-contenthandlingstrategy
property integrationId
readonly integrationId: string;
AWS::ApiGatewayV2::IntegrationResponse.IntegrationId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationid
property integrationResponseKey
readonly integrationResponseKey: string;
AWS::ApiGatewayV2::IntegrationResponse.IntegrationResponseKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-integrationresponsekey
property responseParameters
readonly responseParameters?: any | cdk.IResolvable;
AWS::ApiGatewayV2::IntegrationResponse.ResponseParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responseparameters
property responseTemplates
readonly responseTemplates?: any | cdk.IResolvable;
AWS::ApiGatewayV2::IntegrationResponse.ResponseTemplates
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-responsetemplates
property templateSelectionExpression
readonly templateSelectionExpression?: string;
AWS::ApiGatewayV2::IntegrationResponse.TemplateSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integrationresponse.html#cfn-apigatewayv2-integrationresponse-templateselectionexpression
interface CfnIntegrationV2Props
interface CfnIntegrationV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Integration
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Integration.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-apiid
property connectionType
readonly connectionType?: string;
AWS::ApiGatewayV2::Integration.ConnectionType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-connectiontype
property contentHandlingStrategy
readonly contentHandlingStrategy?: string;
AWS::ApiGatewayV2::Integration.ContentHandlingStrategy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-contenthandlingstrategy
property credentialsArn
readonly credentialsArn?: string;
AWS::ApiGatewayV2::Integration.CredentialsArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-credentialsarn
property description
readonly description?: string;
AWS::ApiGatewayV2::Integration.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-description
property integrationMethod
readonly integrationMethod?: string;
AWS::ApiGatewayV2::Integration.IntegrationMethod
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationmethod
property integrationType
readonly integrationType: string;
AWS::ApiGatewayV2::Integration.IntegrationType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationtype
property integrationUri
readonly integrationUri?: string;
AWS::ApiGatewayV2::Integration.IntegrationUri
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-integrationuri
property passthroughBehavior
readonly passthroughBehavior?: string;
AWS::ApiGatewayV2::Integration.PassthroughBehavior
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-passthroughbehavior
property payloadFormatVersion
readonly payloadFormatVersion?: string;
AWS::ApiGatewayV2::Integration.PayloadFormatVersion
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-payloadformatversion
property requestParameters
readonly requestParameters?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Integration.RequestParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requestparameters
property requestTemplates
readonly requestTemplates?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Integration.RequestTemplates
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-requesttemplates
property templateSelectionExpression
readonly templateSelectionExpression?: string;
AWS::ApiGatewayV2::Integration.TemplateSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-templateselectionexpression
property timeoutInMillis
readonly timeoutInMillis?: number;
AWS::ApiGatewayV2::Integration.TimeoutInMillis
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-integration.html#cfn-apigatewayv2-integration-timeoutinmillis
interface CfnMethodProps
interface CfnMethodProps {}
Properties for defining a
CfnMethod
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html
property apiKeyRequired
readonly apiKeyRequired?: boolean | cdk.IResolvable;
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-apikeyrequired
property authorizationScopes
readonly authorizationScopes?: string[];
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes
property authorizationType
readonly authorizationType?: 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, specifyCUSTOM
orCOGNITO_USER_POOLS
for this property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationtype
property authorizerId
readonly authorizerId?: string;
The identifier of an authorizer to use on this method. The method's authorization type must be
CUSTOM
orCOGNITO_USER_POOLS
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizerid
property httpMethod
readonly httpMethod: string;
The method's HTTP verb.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
property integration
readonly integration?: CfnMethod.IntegrationProperty | cdk.IResolvable;
Represents an
HTTP
,HTTP_PROXY
,AWS
,AWS_PROXY
, or Mock integration.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
property methodResponses
readonly methodResponses?: | Array<CfnMethod.MethodResponseProperty | cdk.IResolvable> | cdk.IResolvable;
Gets a method response associated with a given HTTP status code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
property operationName
readonly operationName?: string;
A human-friendly operation identifier for the method. For example, you can assign the
operationName
ofListPets
for theGET /pets
method in thePetStore
example.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
property requestModels
readonly requestModels?: | { [key: string]: string; } | cdk.IResolvable;
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).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
property requestParameters
readonly requestParameters?: | { [key: string]: boolean | cdk.IResolvable; } | cdk.IResolvable;
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}
, wherelocation
isquerystring
,path
, orheader
andname
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
property requestValidatorId
readonly requestValidatorId?: string;
The identifier of a RequestValidator for request validation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
property resourceId
readonly resourceId: string;
The Resource identifier for the MethodResponse resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-restapiid
interface CfnModelProps
interface CfnModelProps {}
Properties for defining a
CfnModel
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html
property contentType
readonly contentType?: string;
The content-type for the model.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-contenttype
property description
readonly description?: string;
The description of the model.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-description
property name
readonly name?: string;
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. 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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-name
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
property schema
readonly schema?: any | cdk.IResolvable;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-schema
interface CfnModelV2Props
interface CfnModelV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Model
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Model.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-apiid
property contentType
readonly contentType?: string;
AWS::ApiGatewayV2::Model.ContentType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-contenttype
property description
readonly description?: string;
AWS::ApiGatewayV2::Model.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-description
property name
readonly name: string;
AWS::ApiGatewayV2::Model.Name
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-name
property schema
readonly schema: any | cdk.IResolvable;
AWS::ApiGatewayV2::Model.Schema
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-model.html#cfn-apigatewayv2-model-schema
interface CfnRequestValidatorProps
interface CfnRequestValidatorProps {}
Properties for defining a
CfnRequestValidator
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html
property name
readonly name?: string;
The name of this RequestValidator
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
property validateRequestBody
readonly validateRequestBody?: boolean | cdk.IResolvable;
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
property validateRequestParameters
readonly validateRequestParameters?: boolean | cdk.IResolvable;
A Boolean flag to indicate whether to validate request parameters (
true
) or not (false
).http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestparameters
interface CfnResourceProps
interface CfnResourceProps {}
Properties for defining a
CfnResource
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html
property parentId
readonly parentId: string;
The parent resource's identifier.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
property pathPart
readonly pathPart: string;
The last path segment for this resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-restapiid
interface CfnRestApiProps
interface CfnRestApiProps {}
Properties for defining a
CfnRestApi
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
property apiKeySourceType
readonly apiKeySourceType?: string;
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
property binaryMediaTypes
readonly binaryMediaTypes?: string[];
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-binarymediatypes
property body
readonly body?: any | cdk.IResolvable;
An OpenAPI specification that defines a set of RESTful APIs in JSON format. For YAML templates, you can also provide the specification in YAML format.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-body
property bodyS3Location
readonly bodyS3Location?: CfnRestApi.S3LocationProperty | cdk.IResolvable;
The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-bodys3location
property cloneFrom
readonly cloneFrom?: string;
The ID of the RestApi that you want to clone from.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
property description
readonly description?: string;
The description of the RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-description
property disableExecuteApiEndpoint
readonly disableExecuteApiEndpoint?: boolean | cdk.IResolvable;
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpointhttp://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-disableexecuteapiendpoint
property endpointConfiguration
readonly endpointConfiguration?: | CfnRestApi.EndpointConfigurationProperty | cdk.IResolvable;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-endpointconfiguration
property failOnWarnings
readonly failOnWarnings?: boolean | cdk.IResolvable;
A query parameter to indicate whether to rollback the API update (
true
) or not (false
) when a warning is encountered. The default value isfalse
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-failonwarnings
property minimumCompressionSize
readonly minimumCompressionSize?: number;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-minimumcompressionsize
property mode
readonly mode?: string;
This property applies only when you use OpenAPI to define your REST API. The
Mode
determines how API Gateway handles resource updates.Valid values are
overwrite
ormerge
.For
overwrite
, the new API definition replaces the existing one. The existing API identifier remains unchanged.For
merge
, the new API definition is merged with the existing API.If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is
overwrite
. For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.Use the default mode to define top-level
RestApi
properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
property name
readonly name?: string;
The name of the RestApi. A name is required if the REST API is not based on an OpenAPI specification.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
property parameters
readonly parameters?: | { [key: string]: string; } | cdk.IResolvable;
Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set
ignore=documentation
as aparameters
value, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-parameters
property policy
readonly policy?: any | cdk.IResolvable;
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"*"
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-policy
property tags
readonly tags?: cdk.CfnTag[];
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-tags
interface CfnRouteResponseV2Props
interface CfnRouteResponseV2Props {}
Properties for defining a
AWS::ApiGatewayV2::RouteResponse
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::RouteResponse.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-apiid
property modelSelectionExpression
readonly modelSelectionExpression?: string;
AWS::ApiGatewayV2::RouteResponse.ModelSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-modelselectionexpression
property responseModels
readonly responseModels?: any | cdk.IResolvable;
AWS::ApiGatewayV2::RouteResponse.ResponseModels
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responsemodels
property responseParameters
readonly responseParameters?: any | cdk.IResolvable;
AWS::ApiGatewayV2::RouteResponse.ResponseParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-responseparameters
property routeId
readonly routeId: string;
AWS::ApiGatewayV2::RouteResponse.RouteId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeid
property routeResponseKey
readonly routeResponseKey: string;
AWS::ApiGatewayV2::RouteResponse.RouteResponseKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-routeresponse.html#cfn-apigatewayv2-routeresponse-routeresponsekey
interface CfnRouteV2Props
interface CfnRouteV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Route
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html
Deprecated
moved to package aws-apigatewayv2
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Route.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apiid
property apiKeyRequired
readonly apiKeyRequired?: boolean | cdk.IResolvable;
AWS::ApiGatewayV2::Route.ApiKeyRequired
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-apikeyrequired
property authorizationScopes
readonly authorizationScopes?: string[];
AWS::ApiGatewayV2::Route.AuthorizationScopes
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationscopes
property authorizationType
readonly authorizationType?: string;
AWS::ApiGatewayV2::Route.AuthorizationType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizationtype
property authorizerId
readonly authorizerId?: string;
AWS::ApiGatewayV2::Route.AuthorizerId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-authorizerid
property modelSelectionExpression
readonly modelSelectionExpression?: string;
AWS::ApiGatewayV2::Route.ModelSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-modelselectionexpression
property operationName
readonly operationName?: string;
AWS::ApiGatewayV2::Route.OperationName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-operationname
property requestModels
readonly requestModels?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Route.RequestModels
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestmodels
property requestParameters
readonly requestParameters?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Route.RequestParameters
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-requestparameters
property routeKey
readonly routeKey: string;
AWS::ApiGatewayV2::Route.RouteKey
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routekey
property routeResponseSelectionExpression
readonly routeResponseSelectionExpression?: string;
AWS::ApiGatewayV2::Route.RouteResponseSelectionExpression
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-routeresponseselectionexpression
property target
readonly target?: string;
AWS::ApiGatewayV2::Route.Target
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-route.html#cfn-apigatewayv2-route-target
interface CfnStageProps
interface CfnStageProps {}
Properties for defining a
CfnStage
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html
property accessLogSetting
readonly accessLogSetting?: CfnStage.AccessLogSettingProperty | cdk.IResolvable;
Access log settings, including the access log format and access log destination ARN.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting
property cacheClusterEnabled
readonly cacheClusterEnabled?: boolean | cdk.IResolvable;
Specifies whether a cache cluster is enabled for the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclusterenabled
property cacheClusterSize
readonly cacheClusterSize?: string;
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) .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustersize
property canarySetting
readonly canarySetting?: CfnStage.CanarySettingProperty | cdk.IResolvable;
Settings for the canary deployment in this stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-canarysetting
property clientCertificateId
readonly clientCertificateId?: string;
The identifier of a client certificate for an API stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-clientcertificateid
property deploymentId
readonly deploymentId?: string;
The identifier of the Deployment that the stage points to.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-deploymentid
property description
readonly description?: string;
The stage's description.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-description
property documentationVersion
readonly documentationVersion?: string;
The version of the associated API documentation.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-documentationversion
property methodSettings
readonly methodSettings?: | Array<CfnStage.MethodSettingProperty | cdk.IResolvable> | cdk.IResolvable;
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/\* /\*
for overriding all methods in the stage.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-methodsettings
property restApiId
readonly restApiId: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-restapiid
property stageName
readonly stageName?: string;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-stagename
property tags
readonly tags?: cdk.CfnTag[];
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tags
property tracingEnabled
readonly tracingEnabled?: boolean | cdk.IResolvable;
Specifies whether active tracing with X-ray is enabled for the Stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-tracingenabled
property variables
readonly variables?: | { [key: string]: string; } | cdk.IResolvable;
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-._~:/?#&=,]+
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-variables
interface CfnStageV2Props
interface CfnStageV2Props {}
Properties for defining a
AWS::ApiGatewayV2::Stage
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html
Deprecated
moved to package aws-apigatewayv2
property accessLogSettings
readonly accessLogSettings?: | CfnStageV2.AccessLogSettingsProperty | cdk.IResolvable;
AWS::ApiGatewayV2::Stage.AccessLogSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-accesslogsettings
property apiId
readonly apiId: string;
AWS::ApiGatewayV2::Stage.ApiId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-apiid
property autoDeploy
readonly autoDeploy?: boolean | cdk.IResolvable;
AWS::ApiGatewayV2::Stage.AutoDeploy
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-autodeploy
property clientCertificateId
readonly clientCertificateId?: string;
AWS::ApiGatewayV2::Stage.ClientCertificateId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-clientcertificateid
property defaultRouteSettings
readonly defaultRouteSettings?: | CfnStageV2.RouteSettingsProperty | cdk.IResolvable;
AWS::ApiGatewayV2::Stage.DefaultRouteSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-defaultroutesettings
property deploymentId
readonly deploymentId?: string;
AWS::ApiGatewayV2::Stage.DeploymentId
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-deploymentid
property description
readonly description?: string;
AWS::ApiGatewayV2::Stage.Description
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-description
property routeSettings
readonly routeSettings?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Stage.RouteSettings
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-routesettings
property stageName
readonly stageName: string;
AWS::ApiGatewayV2::Stage.StageName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagename
property stageVariables
readonly stageVariables?: any | cdk.IResolvable;
AWS::ApiGatewayV2::Stage.StageVariables
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-stagevariables
property tags
readonly tags?: any;
AWS::ApiGatewayV2::Stage.Tags
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigatewayv2-stage.html#cfn-apigatewayv2-stage-tags
interface CfnUsagePlanKeyProps
interface CfnUsagePlanKeyProps {}
Properties for defining a
CfnUsagePlanKey
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html
property keyId
readonly keyId: string;
The Id of the UsagePlanKey resource to be deleted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keyid
property keyType
readonly keyType: string;
The type of a UsagePlanKey resource for a plan customer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-keytype
property usagePlanId
readonly usagePlanId: string;
The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplankey.html#cfn-apigateway-usageplankey-usageplanid
interface CfnUsagePlanProps
interface CfnUsagePlanProps {}
Properties for defining a
CfnUsagePlan
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html
property apiStages
readonly apiStages?: | Array<CfnUsagePlan.ApiStageProperty | cdk.IResolvable> | cdk.IResolvable;
The associated API stages of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-apistages
property description
readonly description?: string;
The description of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-description
property quota
readonly quota?: CfnUsagePlan.QuotaSettingsProperty | cdk.IResolvable;
The target maximum number of permitted requests per a given unit time interval.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-quota
property tags
readonly tags?: cdk.CfnTag[];
The collection of tags. Each tag element is associated with a given resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-tags
property throttle
readonly throttle?: CfnUsagePlan.ThrottleSettingsProperty | cdk.IResolvable;
A map containing method level throttling information for API stage in a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-throttle
property usagePlanName
readonly usagePlanName?: string;
The name of a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html#cfn-apigateway-usageplan-usageplanname
interface CfnVpcLinkProps
interface CfnVpcLinkProps {}
Properties for defining a
CfnVpcLink
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html
property description
readonly description?: string;
The description of the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-description
property name
readonly name: string;
The name used to label and identify the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-name
property tags
readonly tags?: cdk.CfnTag[];
An array of arbitrary tags (key-value pairs) to associate with the VPC link.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-tags
property targetArns
readonly targetArns: string[];
The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-vpclink.html#cfn-apigateway-vpclink-targetarns
interface CognitoUserPoolsAuthorizerProps
interface CognitoUserPoolsAuthorizerProps {}
Properties for CognitoUserPoolsAuthorizer
property authorizerName
readonly authorizerName?: string;
An optional human friendly name for the authorizer. Note that, this is not the primary identifier of the authorizer.
- the unique construct ID
property cognitoUserPools
readonly cognitoUserPools: cognito.IUserPool[];
The user pools to associate with this authorizer.
property identitySource
readonly identitySource?: string;
The request header mapping expression for the bearer token. This is typically passed as part of the header, in which case this should be
method.request.header.Authorizer
where Authorizer is the header containing the bearer token.See Also
https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
IdentitySource.header('Authorization')
property resultsCacheTtl
readonly resultsCacheTtl?: Duration;
How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0.
Duration.minutes(5)
interface CorsOptions
interface CorsOptions {}
property allowCredentials
readonly allowCredentials?: boolean;
The Access-Control-Allow-Credentials response header tells browsers whether to expose the response to frontend JavaScript code when the request's credentials mode (Request.credentials) is "include".
When a request's credentials mode (Request.credentials) is "include", browsers will only expose the response to frontend JavaScript code if the Access-Control-Allow-Credentials value is true.
Credentials are cookies, authorization headers or TLS client certificates.
See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials false
property allowHeaders
readonly allowHeaders?: string[];
The Access-Control-Allow-Headers response header is used in response to a preflight request which includes the Access-Control-Request-Headers to indicate which HTTP headers can be used during the actual request.
See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Headers Cors.DEFAULT_HEADERS
property allowMethods
readonly allowMethods?: string[];
The Access-Control-Allow-Methods response header specifies the method or methods allowed when accessing the resource in response to a preflight request.
If
ANY
is specified, it will be expanded toCors.ALL_METHODS
.See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Methods Cors.ALL_METHODS
property allowOrigins
readonly allowOrigins: string[];
Specifies the list of origins that are allowed to make requests to this resource. If you wish to allow all origins, specify
Cors.ALL_ORIGINS
or[ * ]
.Responses will include the
Access-Control-Allow-Origin
response header. IfCors.ALL_ORIGINS
is specified, theVary: Origin
response header will also be included.See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Origin
property disableCache
readonly disableCache?: boolean;
Sets Access-Control-Max-Age to -1, which means that caching is disabled. This option cannot be used with
maxAge
.- cache is enabled
property exposeHeaders
readonly exposeHeaders?: string[];
The Access-Control-Expose-Headers response header indicates which headers can be exposed as part of the response by listing their names.
If you want clients to be able to access other headers, you have to list them using the Access-Control-Expose-Headers header.
See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers
- only the 6 CORS-safelisted response headers are exposed: Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma
property maxAge
readonly maxAge?: Duration;
The Access-Control-Max-Age response header indicates how long the results of a preflight request (that is the information contained in the Access-Control-Allow-Methods and Access-Control-Allow-Headers headers) can be cached.
To disable caching altogether use
disableCache: true
.See Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Max-Age - browser-specific (see reference)
property statusCode
readonly statusCode?: number;
Specifies the response status code returned from the OPTIONS method.
204
interface DeploymentProps
interface DeploymentProps {}
property api
readonly api: IRestApi;
The Rest API to deploy.
property description
readonly description?: string;
A description of the purpose of the API Gateway deployment.
- No description.
property retainDeployments
readonly retainDeployments?: boolean;
When an API Gateway model is updated, a new deployment will automatically be created. If this is true, the old API Gateway Deployment resource will not be deleted. This will allow manually reverting back to a previous deployment in case for example
false
interface DomainNameAttributes
interface DomainNameAttributes {}
property domainName
readonly domainName: string;
The domain name (e.g.
example.com
)
property domainNameAliasHostedZoneId
readonly domainNameAliasHostedZoneId: string;
The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
property domainNameAliasTarget
readonly domainNameAliasTarget: string;
The Route53 alias target to use in order to connect a record set to this domain through an alias.
interface DomainNameOptions
interface DomainNameOptions {}
property basePath
readonly basePath?: string;
The base path name that callers of the API must provide in the URL after the domain name (e.g.
example.com/base-path
). If you specify this property, it can't be an empty string.- map requests from the domain root (e.g.
example.com
). If this is undefined, no additional mappings will be allowed on this domain name.
property certificate
readonly certificate: acm.ICertificate;
The reference to an AWS-managed certificate for use by the edge-optimized endpoint for the domain name. For "EDGE" domain names, the certificate needs to be in the US East (N. Virginia) region.
property domainName
readonly domainName: string;
The custom domain name for your API. Uppercase letters are not supported.
property endpointType
readonly endpointType?: EndpointType;
The type of endpoint for this DomainName. REGIONAL
property mtls
readonly mtls?: MTLSConfig;
The mutual TLS authentication configuration for a custom domain name. - mTLS is not configured.
property securityPolicy
readonly securityPolicy?: SecurityPolicy;
The Transport Layer Security (TLS) version + cipher suite for this domain name.
See Also
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html SecurityPolicy.TLS_1_0
interface DomainNameProps
interface DomainNameProps extends DomainNameOptions {}
property mapping
readonly mapping?: IRestApi;
If specified, all requests to this domain will be mapped to the production deployment of this API. If you wish to map this domain to multiple APIs with different base paths, don't specify this option and use
addBasePathMapping
.- you will have to call
addBasePathMapping
to map this domain to API endpoints.
interface EndpointConfiguration
interface EndpointConfiguration {}
The endpoint configuration of a REST API, including VPCs and endpoint types.
EndpointConfiguration is a property of the AWS::ApiGateway::RestApi resource.
property types
readonly types: EndpointType[];
A list of endpoint types of an API or its custom domain name.
EndpointType.EDGE
property vpcEndpoints
readonly vpcEndpoints?: IVpcEndpoint[];
A list of VPC Endpoints against which to create Route53 ALIASes
- no ALIASes are created for the endpoint.
interface GatewayResponseOptions
interface GatewayResponseOptions {}
Options to add gateway response.
property responseHeaders
readonly responseHeaders?: { [key: string]: string;};
Custom headers parameters for response. - no headers
property statusCode
readonly statusCode?: string;
Http status code for response. - standard http status code for the response type.
property templates
readonly templates?: { [key: string]: string;};
Custom templates to get mapped as response. - Response from api will be returned without applying any transformation.
property type
readonly type: ResponseType;
Response type to associate with gateway response.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/supported-gateway-response-types.html
interface GatewayResponseProps
interface GatewayResponseProps extends GatewayResponseOptions {}
Properties for a new gateway response.
property restApi
readonly restApi: IRestApi;
Rest api resource to target.
interface HttpIntegrationProps
interface HttpIntegrationProps {}
property httpMethod
readonly httpMethod?: string;
HTTP method to use when invoking the backend URL. GET
property options
readonly options?: IntegrationOptions;
Integration options, such as request/resopnse mapping, content handling, etc.
defaults based on
IntegrationOptions
defaults
property proxy
readonly proxy?: boolean;
Determines whether to use proxy integration or custom integration.
true
interface IAccessLogDestination
interface IAccessLogDestination {}
Access log destination for a RestApi Stage.
method bind
bind: (stage: IStage) => AccessLogDestinationConfig;
Binds this destination to the RestApi Stage.
interface IApiKey
interface IApiKey extends IResourceBase {}
API keys are alphanumeric string values that you distribute to app developer customers to grant access to your API
interface IAuthorizer
interface IAuthorizer {}
Represents an API Gateway authorizer.
property authorizationType
readonly authorizationType?: AuthorizationType;
The authorization type of this authorizer.
property authorizerId
readonly authorizerId: string;
The authorizer ID.
interface IDomainName
interface IDomainName extends IResource {}
property domainName
readonly domainName: string;
The domain name (e.g.
example.com
)DomainName
property domainNameAliasDomainName
readonly domainNameAliasDomainName: string;
The Route53 alias target to use in order to connect a record set to this domain through an alias.
DistributionDomainName,RegionalDomainName
property domainNameAliasHostedZoneId
readonly domainNameAliasHostedZoneId: string;
The Route53 hosted zone ID to use in order to connect a record set to this domain through an alias.
DistributionHostedZoneId,RegionalHostedZoneId
interface IGatewayResponse
interface IGatewayResponse extends IResource {}
Represents gateway response resource.
interface IModel
interface IModel {}
property modelId
readonly modelId: string;
Returns the model name, such as 'myModel'
interface IntegrationConfig
interface IntegrationConfig {}
Result of binding an Integration to a Method.
property deploymentToken
readonly deploymentToken?: string;
This value is included in computing the Deployment's fingerprint. When the fingerprint changes, a new deployment is triggered. This property should contain values associated with the Integration that upon changing should trigger a fresh the Deployment needs to be refreshed. undefined deployments are not triggered for any change to this integration.
property integrationHttpMethod
readonly integrationHttpMethod?: string;
The integration's HTTP method type. - no integration method specified.
property options
readonly options?: IntegrationOptions;
Integration options. - no integration options
property type
readonly type: IntegrationType;
Specifies an API method integration type.
property uri
readonly uri?: string;
The Uniform Resource Identifier (URI) for the integration.
See Also
https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri - no URI. Usually applies to MOCK integration
interface IntegrationOptions
interface IntegrationOptions {}
property cacheKeyParameters
readonly cacheKeyParameters?: string[];
A list of request parameters whose values are to be cached. It determines request parameters that will make it into the cache key.
property cacheNamespace
readonly cacheNamespace?: string;
An API-specific tag group of related cached parameters.
property connectionType
readonly connectionType?: ConnectionType;
The type of network connection to the integration endpoint. - ConnectionType.VPC_LINK if
vpcLink
property is configured; ConnectionType.Internet otherwise.
property contentHandling
readonly contentHandling?: ContentHandling;
Specifies how to handle request payload content type conversions.
none if this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the
passthroughBehaviors
property is configured to support payload pass-through.
property credentialsPassthrough
readonly credentialsPassthrough?: boolean;
Requires that the caller's identity be passed through from the request.
Caller identity is not passed through
property credentialsRole
readonly credentialsRole?: iam.IRole;
An IAM role that API Gateway assumes.
Mutually exclusive with
credentialsPassThrough
.A role is not assumed
property integrationResponses
readonly integrationResponses?: IntegrationResponse[];
The response that API Gateway provides after a method's backend completes processing a request. API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.
property passthroughBehavior
readonly passthroughBehavior?: PassthroughBehavior;
Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.
property requestParameters
readonly requestParameters?: { [dest: string]: string;};
The request parameters that API Gateway sends with the backend request. Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.
Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.
The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.
property requestTemplates
readonly requestTemplates?: { [contentType: string]: string;};
A map of Apache Velocity templates that are applied on the request payload. The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:
{ "application/json": "{ \"statusCode\": 200 }" }See Also
http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
property timeout
readonly timeout?: Duration;
The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds.
Duration.seconds(29)
property vpcLink
readonly vpcLink?: IVpcLink;
The VpcLink used for the integration. Required if connectionType is VPC_LINK
interface IntegrationProps
interface IntegrationProps {}
property integrationHttpMethod
readonly integrationHttpMethod?: string;
The integration's HTTP method type. Required unless you use a MOCK integration.
property options
readonly options?: IntegrationOptions;
Integration options.
property type
readonly type: IntegrationType;
Specifies an API method integration type.
property uri
readonly uri?: any;
The Uniform Resource Identifier (URI) for the integration.
- If you specify HTTP for the
type
property, specify the API endpoint URL. - If you specify MOCK for thetype
property, don't specify this property. - If you specify AWS for thetype
property, specify an AWS service that follows this form:arn:partition:apigateway:region:subdomain.service|service:path|action/service_api.
For example, a Lambda function URI follows this form: arn:partition:apigateway:region:lambda:path/path. The path is usually in the form /2015-03-31/functions/LambdaFunctionARN/invocations.See Also
https://docs.aws.amazon.com/apigateway/api-reference/resource/integration/#uri
interface IntegrationResponse
interface IntegrationResponse {}
property contentHandling
readonly contentHandling?: ContentHandling;
Specifies how to handle request payload content type conversions.
none the request payload is passed through from the method request to the integration request without modification.
property responseParameters
readonly responseParameters?: { [destination: string]: string;};
The response parameters from the backend response that API Gateway sends to the method response.
Use the destination as the key and the source as the value:
- The destination must be an existing response parameter in the MethodResponse property. - The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on the destination specified in the request.
See Also
http://docs.aws.amazon.com/apigateway/latest/developerguide/request-response-data-mappings.html
property responseTemplates
readonly responseTemplates?: { [contentType: string]: string;};
The templates that are used to transform the integration response body. Specify templates as key-value pairs, with a content type as the key and a template as the value.
See Also
http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
property selectionPattern
readonly selectionPattern?: 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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-integration-settings-integration-response.html
property statusCode
readonly statusCode: string;
The status code that API Gateway uses to map the integration response to a MethodResponse status code.
interface IRequestValidator
interface IRequestValidator extends IResource {}
property requestValidatorId
readonly requestValidatorId: string;
ID of the request validator, such as abc123
interface IResource
interface IResource extends IResourceBase {}
property api
readonly api: IRestApi;
The rest API that this resource is part of.
The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.
property defaultCorsPreflightOptions
readonly defaultCorsPreflightOptions?: CorsOptions;
Default options for CORS preflight OPTIONS method.
property defaultIntegration
readonly defaultIntegration?: Integration;
An integration to use as a default for all methods created within this API unless an integration is specified.
property defaultMethodOptions
readonly defaultMethodOptions?: MethodOptions;
Method options to use as a default for all methods created within this API unless custom options are specified.
property parentResource
readonly parentResource?: IResource;
The parent of this resource or undefined for the root resource.
property path
readonly path: string;
The full path of this resource.
property resourceId
readonly resourceId: string;
The ID of the resource.
property restApi
readonly restApi: RestApi;
The rest API that this resource is part of.
Deprecated
- Throws an error if this Resource is not associated with an instance of
RestApi
. Useapi
instead.
method addCorsPreflight
addCorsPreflight: (options: CorsOptions) => Method;
Adds an OPTIONS method to this resource which responds to Cross-Origin Resource Sharing (CORS) preflight requests.
Cross-Origin Resource Sharing (CORS) is a mechanism that uses additional HTTP headers to tell browsers to give a web application running at one origin, access to selected resources from a different origin. A web application executes a cross-origin HTTP request when it requests a resource that has a different origin (domain, protocol, or port) from its own.
Parameter options
CORS options
Returns
a
Method
objectSee Also
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
method addMethod
addMethod: ( httpMethod: string, target?: Integration, options?: MethodOptions) => Method;
Defines a new method for this resource.
Parameter httpMethod
The HTTP method
Parameter target
The target backend integration for this method
Parameter options
Method options, such as authentication.
Returns
The newly created
Method
object.
method addProxy
addProxy: (options?: ProxyResourceOptions) => ProxyResource;
Adds a greedy proxy resource ("{proxy+}") and an ANY method to this route.
Parameter options
Default integration and method options.
method addResource
addResource: (pathPart: string, options?: ResourceOptions) => Resource;
Defines a new child resource where this resource is the parent.
Parameter pathPart
The path part for the child resource
Parameter options
Resource options
Returns
A Resource object
method getResource
getResource: (pathPart: string) => IResource | undefined;
Retrieves a child resource by path part.
Parameter pathPart
The path part of the child resource
Returns
the child resource or undefined if not found
method resourceForPath
resourceForPath: (path: string) => Resource;
Gets or create all resources leading up to the specified path.
- Path may only start with "/" if this method is called on the root resource. - All resources are created using default options.
Parameter path
The relative path
Returns
a new or existing resource.
interface IRestApi
interface IRestApi extends IResourceBase {}
property deploymentStage
deploymentStage: Stage;
API Gateway stage that points to the latest deployment (if defined).
property latestDeployment
readonly latestDeployment?: Deployment;
API Gateway deployment that represents the latest changes of the API. This resource will be automatically updated every time the REST API model changes.
undefined
when no deployment is configured.
property restApiId
readonly restApiId: string;
The ID of this API Gateway RestApi.
property restApiRootResourceId
readonly restApiRootResourceId: string;
The resource ID of the root resource.
property root
readonly root: IResource;
Represents the root resource ("/") of this API. Use it to define the API model:
api.root.addMethod('ANY', redirectToHomePage); // "ANY /" api.root.addResource('friends').addMethod('GET', getFriendsHandler); // "GET /friends"
method arnForExecuteApi
arnForExecuteApi: (method?: string, path?: string, stage?: string) => string;
Gets the "execute-api" ARN
Parameter method
The method (default
*
)Parameter path
The resource path. Must start with '/' (default
*
)Parameter stage
The stage (default
*
)Returns
The "execute-api" ARN. "*" returns the execute API ARN for all methods/resources in this API.
interface IStage
interface IStage extends IResource {}
Represents an APIGateway Stage.
interface IUsagePlan
interface IUsagePlan extends IResource {}
A UsagePlan, either managed by this CDK app, or imported.
property usagePlanId
readonly usagePlanId: string;
Id of the usage plan
method addApiKey
addApiKey: (apiKey: IApiKey, options?: AddApiKeyOptions) => void;
Adds an ApiKey.
Parameter apiKey
the api key to associate with this usage plan
Parameter options
options that control the behaviour of this method
interface IVpcLink
interface IVpcLink extends IResource {}
Represents an API Gateway VpcLink
property vpcLinkId
readonly vpcLinkId: string;
Physical ID of the VpcLink resource
interface JsonSchema
interface JsonSchema {}
Represents a JSON schema definition of the structure of a REST API model. Copied from npm module jsonschema.
See Also
http://json-schema.org/
https://github.com/tdegrunt/jsonschema
property 'enum'
readonly enum?: any[];
property additionalItems
readonly additionalItems?: JsonSchema[];
property additionalProperties
readonly additionalProperties?: JsonSchema | boolean;
property allOf
readonly allOf?: JsonSchema[];
property anyOf
readonly anyOf?: JsonSchema[];
property contains
readonly contains?: JsonSchema | JsonSchema[];
property default
readonly default?: any;
The default value if you use an enum.
- not set
property definitions
readonly definitions?: { [name: string]: JsonSchema;};
property dependencies
readonly dependencies?: { [name: string]: JsonSchema | string[];};
property description
readonly description?: string;
property exclusiveMaximum
readonly exclusiveMaximum?: boolean;
property exclusiveMinimum
readonly exclusiveMinimum?: boolean;
property format
readonly format?: string;
property id
readonly id?: string;
property items
readonly items?: JsonSchema | JsonSchema[];
property maximum
readonly maximum?: number;
property maxItems
readonly maxItems?: number;
property maxLength
readonly maxLength?: number;
property maxProperties
readonly maxProperties?: number;
property minimum
readonly minimum?: number;
property minItems
readonly minItems?: number;
property minLength
readonly minLength?: number;
property minProperties
readonly minProperties?: number;
property multipleOf
readonly multipleOf?: number;
property not
readonly not?: JsonSchema;
property oneOf
readonly oneOf?: JsonSchema[];
property pattern
readonly pattern?: string;
property patternProperties
readonly patternProperties?: { [name: string]: JsonSchema;};
property properties
readonly properties?: { [name: string]: JsonSchema;};
property propertyNames
readonly propertyNames?: JsonSchema;
property ref
readonly ref?: string;
property required
readonly required?: string[];
property schema
readonly schema?: JsonSchemaVersion;
property title
readonly title?: string;
property type
readonly type?: JsonSchemaType | JsonSchemaType[];
property uniqueItems
readonly uniqueItems?: boolean;
interface JsonWithStandardFieldProps
interface JsonWithStandardFieldProps {}
Properties for controlling items output in JSON standard format
property caller
readonly caller: boolean;
If this flag is enabled, the principal identifier of the caller will be output to the log
property httpMethod
readonly httpMethod: boolean;
If this flag is enabled, the http method will be output to the log
property ip
readonly ip: boolean;
If this flag is enabled, the source IP of request will be output to the log
property protocol
readonly protocol: boolean;
If this flag is enabled, the request protocol will be output to the log
property requestTime
readonly requestTime: boolean;
If this flag is enabled, the CLF-formatted request time((dd/MMM/yyyy:HH:mm:ss +-hhmm) will be output to the log
property resourcePath
readonly resourcePath: boolean;
If this flag is enabled, the path to your resource will be output to the log
property responseLength
readonly responseLength: boolean;
If this flag is enabled, the response payload length will be output to the log
property status
readonly status: boolean;
If this flag is enabled, the method response status will be output to the log
property user
readonly user: boolean;
If this flag is enabled, the principal identifier of the user will be output to the log
interface LambdaAuthorizerProps
interface LambdaAuthorizerProps {}
Base properties for all lambda authorizers
property assumeRole
readonly assumeRole?: iam.IRole;
An optional IAM role for APIGateway to assume before calling the Lambda-based authorizer. The IAM role must be assumable by 'apigateway.amazonaws.com'.
- A resource policy is added to the Lambda function allowing apigateway.amazonaws.com to invoke the function.
property authorizerName
readonly authorizerName?: string;
An optional human friendly name for the authorizer. Note that, this is not the primary identifier of the authorizer.
- the unique construcrt ID
property handler
readonly handler: lambda.IFunction;
property resultsCacheTtl
readonly resultsCacheTtl?: Duration;
How long APIGateway should cache the results. Max 1 hour. Disable caching by setting this to 0.
Duration.minutes(5)
interface LambdaIntegrationOptions
interface LambdaIntegrationOptions extends IntegrationOptions {}
property allowTestInvoke
readonly allowTestInvoke?: boolean;
Allow invoking method from AWS Console UI (for testing purposes).
This will add another permission to the AWS Lambda resource policy which will allow the
test-invoke-stage
stage to invoke this handler. If this is set tofalse
, the function will only be usable from the deployment endpoint.true
property proxy
readonly proxy?: boolean;
Use proxy integration or normal (request/response mapping) integration.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format
true
interface LambdaRestApiProps
interface LambdaRestApiProps extends RestApiProps {}
property handler
readonly handler: lambda.IFunction;
The default Lambda function that handles all requests from this API.
This handler will be used as a the default integration for all methods in this API, unless specified otherwise in
addMethod
.
property options
readonly options?: RestApiProps;
Deprecated
the
LambdaRestApiProps
now extendsRestApiProps
, so all options are just available here. Note that the options specified inoptions
will be overridden by any props specified at the root level.- no options.
property proxy
readonly proxy?: boolean;
If true, route all requests to the Lambda Function
If set to false, you will need to explicitly define the API model using
addResource
andaddMethod
(oraddProxy
).true
interface MethodDeploymentOptions
interface MethodDeploymentOptions {}
property cacheDataEncrypted
readonly cacheDataEncrypted?: boolean;
Indicates whether the cached responses are encrypted.
false
property cacheTtl
readonly cacheTtl?: Duration;
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html
Duration.minutes(5)
property cachingEnabled
readonly cachingEnabled?: boolean;
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
- Caching is Disabled.
property dataTraceEnabled
readonly dataTraceEnabled?: boolean;
Specifies whether data trace logging is enabled for this method. When enabled, API gateway will log the full API requests and responses. This can be useful to troubleshoot APIs, but can result in logging sensitive data. We recommend that you don't enable this feature for production APIs.
false
property loggingLevel
readonly loggingLevel?: MethodLoggingLevel;
Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs.
- Off
property metricsEnabled
readonly metricsEnabled?: boolean;
Specifies whether Amazon CloudWatch metrics are enabled for this method.
false
property throttlingBurstLimit
readonly throttlingBurstLimit?: number;
Specifies the throttling burst limit. The total rate of all requests in your AWS account is limited to 5,000 requests.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
- No additional restriction.
property throttlingRateLimit
readonly throttlingRateLimit?: number;
Specifies the throttling rate limit. The total rate of all requests in your AWS account is limited to 10,000 requests per second (rps).
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
- No additional restriction.
interface MethodOptions
interface MethodOptions {}
property apiKeyRequired
readonly apiKeyRequired?: boolean;
Indicates whether the method requires clients to submit a valid API key. false
property authorizationScopes
readonly authorizationScopes?: string[];
A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.
See Also
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-authorizationscopes - no authorization scopes
property authorizationType
readonly authorizationType?: AuthorizationType;
Method authorization. If the value is set of
Custom
, anauthorizer
must also be specified.If you're using one of the authorizers that are available via the Authorizer class, such as , it is recommended that this option not be specified. The authorizer will take care of setting the correct authorization type. However, specifying an authorization type using this property that conflicts with what is expected by the Authorizer will result in an error.
- open access unless
authorizer
is specified
property authorizer
readonly authorizer?: IAuthorizer;
If
authorizationType
isCustom
, this specifies the ID of the method authorizer resource. If specified, the value ofauthorizationType
must be set toCustom
property methodResponses
readonly methodResponses?: MethodResponse[];
The responses that can be sent to the client who calls the method. None
This property is not required, but if these are not supplied for a Lambda proxy integration, the Lambda function must return a value of the correct format, for the integration response to be correctly mapped to a response to the client.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-response.html
property operationName
readonly operationName?: string;
A friendly operation name for the method. For example, you can assign the OperationName of ListPets for the GET /pets method.
property requestModels
readonly requestModels?: { [param: string]: IModel;};
The models which describe data structure of request payload. When combined with
requestValidator
orrequestValidatorOptions
, the service will validate the API request payload before it reaches the API's Integration (including proxies). SpecifyrequestModels
as key-value pairs, with a content type (e.g.'application/json'
) as the key and an API Gateway Model as the value.Example 1
declare const api: apigateway.RestApi; declare const userLambda: lambda.Function;
const userModel: apigateway.Model = api.addModel('UserModel', { schema: { type: apigateway.JsonSchemaType.OBJECT, properties: { userId: { type: apigateway.JsonSchemaType.STRING }, name: { type: apigateway.JsonSchemaType.STRING } }, required: ['userId'] } }); api.root.addResource('user').addMethod('POST', new apigateway.LambdaIntegration(userLambda), { requestModels: { 'application/json': userModel } } );
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-method-settings-method-request.html#setup-method-request-model
property requestParameters
readonly requestParameters?: { [param: string]: boolean;};
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. The Boolean specifies whether a parameter is required. A source must match the format method.request.location.name, where the location is querystring, path, or header, and name is a valid, unique parameter name. None
property requestValidator
readonly requestValidator?: IRequestValidator;
The ID of the associated request validator. Only one of
requestValidator
orrequestValidatorOptions
must be specified. Works together withrequestModels
orrequestParameters
to validate the request before it reaches integration like Lambda Proxy Integration. - No default validator
property requestValidatorOptions
readonly requestValidatorOptions?: RequestValidatorOptions;
Request validator options to create new validator Only one of
requestValidator
orrequestValidatorOptions
must be specified. Works together withrequestModels
orrequestParameters
to validate the request before it reaches integration like Lambda Proxy Integration. - No default validator
interface MethodProps
interface MethodProps {}
property httpMethod
readonly httpMethod: string;
The HTTP method ("GET", "POST", "PUT", ...) that clients use to call this method.
property integration
readonly integration?: Integration;
The backend system that the method calls when it receives a request.
- a new
MockIntegration
.
property options
readonly options?: MethodOptions;
Method options.
- No options.
property resource
readonly resource: IResource;
The resource this method is associated with. For root resource methods, specify the
RestApi
object.
interface MethodResponse
interface MethodResponse {}
property responseModels
readonly responseModels?: { [contentType: string]: IModel;};
The resources used for the response's content type. Specify response models as key-value pairs (string-to-string maps), with a content type as the key and a Model resource name as the value. None
property responseParameters
readonly responseParameters?: { [destination: string]: boolean;};
Response parameters that API Gateway sends to the client that called a method. Specify response parameters as key-value pairs (string-to-Boolean maps), with a destination as the key and a Boolean as the value. Specify the destination using the following pattern: method.response.header.name, where the name is a valid, unique header name. The Boolean specifies whether a parameter is required. None
property statusCode
readonly statusCode: string;
The method response's status code, which you map to an IntegrationResponse. Required.
interface ModelOptions
interface ModelOptions {}
property contentType
readonly contentType?: string;
The content type for the model. You can also force a content type in the request or response model mapping.
'application/json'
property description
readonly description?: string;
A description that identifies this model. None
property modelName
readonly modelName?: string;
A name for the model.
Important 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.
If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the model name. For more information, see Name Type.
property schema
readonly schema: jsonSchema.JsonSchema;
The schema to use to transform data to one or more output formats. Specify null ({}) if you don't want to specify a schema.
interface ModelProps
interface ModelProps extends ModelOptions {}
property restApi
readonly restApi: IRestApi;
The rest API that this model is part of.
The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.
interface MTLSConfig
interface MTLSConfig {}
The mTLS authentication configuration for a custom domain name.
property bucket
readonly bucket: IBucket;
The bucket that the trust store is hosted in.
property key
readonly key: string;
The key in S3 to look at for the trust store.
property version
readonly version?: string;
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket. - latest version
interface ProxyResourceOptions
interface ProxyResourceOptions extends ResourceOptions {}
property anyMethod
readonly anyMethod?: boolean;
Adds an "ANY" method to this resource. If set to
false
, you will have to explicitly add methods to this resource after it's created.true
interface ProxyResourceProps
interface ProxyResourceProps extends ProxyResourceOptions {}
property parent
readonly parent: IResource;
The parent resource of this resource. You can either pass another
Resource
object or aRestApi
object here.
interface QuotaSettings
interface QuotaSettings {}
Specifies the maximum number of requests that clients can make to API Gateway APIs.
property limit
readonly limit?: number;
The maximum number of requests that users can make within the specified time period. none
property offset
readonly offset?: number;
For the initial time period, the number of requests to subtract from the specified limit. none
property period
readonly period?: Period;
The time period for which the maximum limit of requests applies. none
interface RateLimitedApiKeyProps
interface RateLimitedApiKeyProps extends ApiKeyProps {}
RateLimitedApiKey properties.
property apiStages
readonly apiStages?: UsagePlanPerApiStage[];
API Stages to be associated with the RateLimitedApiKey. none
property quota
readonly quota?: QuotaSettings;
Number of requests clients can make in a given time period. none
property throttle
readonly throttle?: ThrottleSettings;
Overall throttle settings for the API. none
interface RequestAuthorizerProps
interface RequestAuthorizerProps extends LambdaAuthorizerProps {}
Properties for RequestAuthorizer
property identitySources
readonly identitySources: string[];
An array of request header mapping expressions for identities. Supported parameter types are Header, Query String, Stage Variable, and Context. For instance, extracting an authorization token from a header would use the identity source
IdentitySource.header('Authorizer')
.Note: API Gateway uses the specified identity sources as the request authorizer caching key. When caching is enabled, API Gateway calls the authorizer's Lambda function only after successfully verifying that all the specified identity sources are present at runtime. If a specified identify source is missing, null, or empty, API Gateway returns a 401 Unauthorized response without calling the authorizer Lambda function.
See Also
https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
interface RequestContext
interface RequestContext {}
Configure what must be included in the
requestContext
More details can be found at mapping templates documentation.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html
property accountId
readonly accountId?: boolean;
Represents the information of $context.identity.accountId
Whether the AWS account of the API owner should be included in the request context false
property apiId
readonly apiId?: boolean;
Represents the information of $context.apiId
Whether the identifier API Gateway assigns to your API should be included in the request context. false
property apiKey
readonly apiKey?: boolean;
Represents the information of $context.identity.apiKey
Whether the API key associated with the request should be included in request context. false
property authorizerPrincipalId
readonly authorizerPrincipalId?: boolean;
Represents the information of $context.authorizer.principalId
Whether the principal user identifier associated with the token sent by the client and returned from an API Gateway Lambda authorizer should be included in the request context. false
property caller
readonly caller?: boolean;
Represents the information of $context.identity.caller
Whether the principal identifier of the caller that signed the request should be included in the request context. Supported for resources that use IAM authorization. false
property cognitoAuthenticationProvider
readonly cognitoAuthenticationProvider?: boolean;
Represents the information of $context.identity.cognitoAuthenticationProvider
Whether the list of the Amazon Cognito authentication providers used by the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials. false
property cognitoAuthenticationType
readonly cognitoAuthenticationType?: boolean;
Represents the information of $context.identity.cognitoAuthenticationType
Whether the Amazon Cognito authentication type of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials. Possible values include authenticated for authenticated identities and unauthenticated for unauthenticated identities. false
property cognitoIdentityId
readonly cognitoIdentityId?: boolean;
Represents the information of $context.identity.cognitoIdentityId
Whether the Amazon Cognito identity ID of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials. false
property cognitoIdentityPoolId
readonly cognitoIdentityPoolId?: boolean;
Represents the information of $context.identity.cognitoIdentityPoolId
Whether the Amazon Cognito identity pool ID of the caller making the request should be included in the request context. Available only if the request was signed with Amazon Cognito credentials. false
property httpMethod
readonly httpMethod?: boolean;
Represents the information of $context.httpMethod
Whether the HTTP method used should be included in the request context. Valid values include: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. false
property requestId
readonly requestId?: boolean;
Represents the information of $context.requestId
Whether the ID for the request should be included in the request context. false
property resourceId
readonly resourceId?: boolean;
Represents the information of $context.resourceId
Whether the identifier that API Gateway assigns to your resource should be included in the request context. false
property resourcePath
readonly resourcePath?: boolean;
Represents the information of $context.resourcePath
Whether the path to the resource should be included in the request context. false
property sourceIp
readonly sourceIp?: boolean;
Represents the information of $context.identity.sourceIp
Whether the source IP address of the immediate TCP connection making the request to API Gateway endpoint should be included in the request context. false
property stage
readonly stage?: boolean;
Represents the information of $context.stage
Whether the deployment stage of the API request should be included in the request context. false
property user
readonly user?: boolean;
Represents the information of $context.identity.user
Whether the principal identifier of the user that will be authorized should be included in the request context. Supported for resources that use IAM authorization. false
property userAgent
readonly userAgent?: boolean;
Represents the information of $context.identity.userAgent
Whether the User-Agent header of the API caller should be included in the request context. false
property userArn
readonly userArn?: boolean;
Represents the information of $context.identity.userArn
Whether the Amazon Resource Name (ARN) of the effective user identified after authentication should be included in the request context. false
interface RequestValidatorOptions
interface RequestValidatorOptions {}
property requestValidatorName
readonly requestValidatorName?: string;
The name of this request validator.
None
property validateRequestBody
readonly validateRequestBody?: boolean;
Indicates whether to validate the request body according to the configured schema for the targeted API and method.
false
property validateRequestParameters
readonly validateRequestParameters?: boolean;
Indicates whether to validate request parameters.
false
interface RequestValidatorProps
interface RequestValidatorProps extends RequestValidatorOptions {}
property restApi
readonly restApi: IRestApi;
The rest API that this model is part of.
The reason we need the RestApi object itself and not just the ID is because the model is being tracked by the top-level RestApi object for the purpose of calculating it's hash to determine the ID of the deployment. This allows us to automatically update the deployment when the model of the REST API changes.
interface ResourceAttributes
interface ResourceAttributes {}
Attributes that can be specified when importing a Resource
property path
readonly path: string;
The full path of this resource.
property resourceId
readonly resourceId: string;
The ID of the resource.
property restApi
readonly restApi: IRestApi;
The rest API that this resource is part of.
interface ResourceOptions
interface ResourceOptions {}
property defaultCorsPreflightOptions
readonly defaultCorsPreflightOptions?: CorsOptions;
Adds a CORS preflight OPTIONS method to this resource and all child resources.
You can add CORS at the resource-level using
addCorsPreflight
.- CORS is disabled
property defaultIntegration
readonly defaultIntegration?: Integration;
An integration to use as a default for all methods created within this API unless an integration is specified.
- Inherited from parent.
property defaultMethodOptions
readonly defaultMethodOptions?: MethodOptions;
Method options to use as a default for all methods created within this API unless custom options are specified.
- Inherited from parent.
interface ResourceProps
interface ResourceProps extends ResourceOptions {}
interface RestApiAttributes
interface RestApiAttributes {}
Attributes that can be specified when importing a RestApi
property restApiId
readonly restApiId: string;
The ID of the API Gateway RestApi.
property rootResourceId
readonly rootResourceId: string;
The resource ID of the root resource.
interface RestApiBaseProps
interface RestApiBaseProps {}
Represents the props that all Rest APIs share
property cloudWatchRole
readonly cloudWatchRole?: boolean;
Automatically configure an AWS CloudWatch role for API Gateway.
true
property deploy
readonly deploy?: boolean;
Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.
If this is set,
latestDeployment
will refer to theDeployment
object anddeploymentStage
will refer to aStage
that points to this deployment. To customize the stage options, use thedeployOptions
property.A CloudFormation Output will also be defined with the root URL endpoint of this REST API.
true
property deployOptions
readonly deployOptions?: StageOptions;
Options for the API Gateway stage that will always point to the latest deployment when
deploy
is enabled. Ifdeploy
is disabled, this value cannot be set.- Based on defaults of
StageOptions
.
property disableExecuteApiEndpoint
readonly disableExecuteApiEndpoint?: boolean;
Specifies whether clients can invoke the API using the default execute-api endpoint. To require that clients use a custom domain name to invoke the API, disable the default endpoint.
See Also
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
false
property domainName
readonly domainName?: DomainNameOptions;
Configure a custom domain name and map it to this API.
- no domain name is defined, use
addDomainName
or directly define aDomainName
.
property endpointExportName
readonly endpointExportName?: string;
Export name for the CfnOutput containing the API endpoint
- when no export name is given, output will be created without export
property endpointTypes
readonly endpointTypes?: EndpointType[];
A list of the endpoint types of the API. Use this property when creating an API.
EndpointType.EDGE
property failOnWarnings
readonly failOnWarnings?: boolean;
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
false
property parameters
readonly parameters?: { [key: string]: string;};
Custom header parameters for the request.
See Also
https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html
- No parameters.
property policy
readonly policy?: iam.PolicyDocument;
A policy document that contains the permissions for this RestApi
- No policy.
property restApiName
readonly restApiName?: string;
A name for the API Gateway RestApi resource.
- ID of the RestApi construct.
property retainDeployments
readonly retainDeployments?: boolean;
Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.
false
interface RestApiOptions
interface RestApiOptions extends RestApiBaseProps, ResourceOptions {}
Represents the props that all Rest APIs share.
Deprecated
- superseded by
RestApiBaseProps
interface RestApiProps
interface RestApiProps extends RestApiOptions {}
Props to create a new instance of RestApi
property apiKeySourceType
readonly apiKeySourceType?: ApiKeySourceType;
The source of the API key for metering requests according to a usage plan.
- Metering is disabled.
property binaryMediaTypes
readonly binaryMediaTypes?: string[];
The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream"
- RestApi supports only UTF-8-encoded text payloads.
property cloneFrom
readonly cloneFrom?: IRestApi;
The ID of the API Gateway RestApi resource that you want to clone.
- None.
property description
readonly description?: string;
A description of the purpose of this API Gateway RestApi resource.
- No description.
property endpointConfiguration
readonly endpointConfiguration?: EndpointConfiguration;
The EndpointConfiguration property type specifies the endpoint types of a REST API
See Also
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
EndpointType.EDGE
property minimumCompressionSize
readonly minimumCompressionSize?: number;
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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.
- Compression is disabled.
interface SpecRestApiProps
interface SpecRestApiProps extends RestApiBaseProps {}
Props to instantiate a new SpecRestApi
property apiDefinition
readonly apiDefinition: ApiDefinition;
An OpenAPI definition compatible with API Gateway.
See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
interface StageOptions
interface StageOptions extends MethodDeploymentOptions {}
property accessLogDestination
readonly accessLogDestination?: IAccessLogDestination;
The CloudWatch Logs log group.
- No destination
property accessLogFormat
readonly accessLogFormat?: AccessLogFormat;
A single line format of access logs of data, as specified by selected $content variables. The format must include at least
AccessLogFormat.contextRequestId()
.See Also
https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference
- Common Log Format
property cacheClusterEnabled
readonly cacheClusterEnabled?: boolean;
Indicates whether cache clustering is enabled for the stage.
- Disabled for the stage.
property cacheClusterSize
readonly cacheClusterSize?: string;
The stage's cache cluster size. 0.5
property clientCertificateId
readonly clientCertificateId?: string;
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
- None.
property description
readonly description?: string;
A description of the purpose of the stage.
- No description.
property documentationVersion
readonly documentationVersion?: string;
The version identifier of the API documentation snapshot.
- No documentation version.
property methodOptions
readonly methodOptions?: { [path: string]: MethodDeploymentOptions;};
Method deployment options for specific resources/methods. These will override common options defined in
StageOptions#methodOptions
.Parameter path
is {resource_path}/{http_method} (i.e. /api/toys/GET) for an individual method override. You can use
*
for both {resource_path} and {http_method} to define options for all methods/resources.- Common options will be used.
property stageName
readonly stageName?: string;
The name of the stage, which API Gateway uses as the first path segment in the invoked Uniform Resource Identifier (URI).
- "prod"
property tracingEnabled
readonly tracingEnabled?: boolean;
Specifies whether Amazon X-Ray tracing is enabled for this method.
false
property variables
readonly variables?: { [key: string]: string;};
A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression: [A-Za-z0-9-._~:/?#&=,]+.
- No stage variables.
interface StageProps
interface StageProps extends StageOptions {}
property deployment
readonly deployment: Deployment;
The deployment that this stage points to [disable-awslint:ref-via-interface].
interface StepFunctionsExecutionIntegrationOptions
interface StepFunctionsExecutionIntegrationOptions extends IntegrationOptions {}
Options when configuring Step Functions synchronous integration with Rest API
property authorizer
readonly authorizer?: boolean;
If the whole authorizer object, including custom context values should be in the execution input. The execution input will include a new key
authorizer
:{ "body": {}, "authorizer": { "key": "value" } }
false
property headers
readonly headers?: boolean;
Check if header is to be included inside the execution input. The execution input will include a new key
headers
:{ "body": {}, "headers": { "header1": "value", "header2": "value" } } false
property path
readonly path?: boolean;
Check if path is to be included inside the execution input. The execution input will include a new key
path
:{ "body": {}, "path": { "resourceName": "resourceValue" } }
true
property querystring
readonly querystring?: boolean;
Check if querystring is to be included inside the execution input. The execution input will include a new key
queryString
:{ "body": {}, "querystring": { "key": "value" } }
true
property requestContext
readonly requestContext?: RequestContext;
Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc. The execution input will include a new key
requestContext
:{ "body": {}, "requestContext": { "key": "value" } }
- all parameters within request context will be set as false
interface StepFunctionsRestApiProps
interface StepFunctionsRestApiProps extends RestApiProps {}
Properties for StepFunctionsRestApi
property authorizer
readonly authorizer?: boolean;
If the whole authorizer object, including custom context values should be in the execution input. The execution input will include a new key
authorizer
:{ "body": {}, "authorizer": { "key": "value" } }
false
property headers
readonly headers?: boolean;
Check if header is to be included inside the execution input. The execution input will include a new key
headers
:{ "body": {}, "headers": { "header1": "value", "header2": "value" } } false
property path
readonly path?: boolean;
Check if path is to be included inside the execution input. The execution input will include a new key
path
:{ "body": {}, "path": { "resourceName": "resourceValue" } }
true
property querystring
readonly querystring?: boolean;
Check if querystring is to be included inside the execution input. The execution input will include a new key
queryString
:{ "body": {}, "querystring": { "key": "value" } }
true
property requestContext
readonly requestContext?: RequestContext;
Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc. The execution input will include a new key
requestContext
:{ "body": {}, "requestContext": { "key": "value" } }
- all parameters within request context will be set as false
property role
readonly role?: iam.IRole;
An IAM role that API Gateway will assume to start the execution of the state machine.
- a new role is created
property stateMachine
readonly stateMachine: sfn.IStateMachine;
The default State Machine that handles all requests from this API.
This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in
addMethod
.
interface ThrottleSettings
interface ThrottleSettings {}
Container for defining throttling parameters to API stages or methods. https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html
property burstLimit
readonly burstLimit?: number;
The maximum API request rate limit over a time ranging from one to a few seconds. none
property rateLimit
readonly rateLimit?: number;
The API request steady-state rate limit (average requests per second over an extended period of time) none
interface ThrottlingPerMethod
interface ThrottlingPerMethod {}
Represents per-method throttling for a resource.
interface TokenAuthorizerProps
interface TokenAuthorizerProps extends LambdaAuthorizerProps {}
Properties for TokenAuthorizer
property identitySource
readonly identitySource?: string;
The request header mapping expression for the bearer token. This is typically passed as part of the header, in which case this should be
method.request.header.Authorizer
where Authorizer is the header containing the bearer token.See Also
https://docs.aws.amazon.com/apigateway/api-reference/link-relation/authorizer-create/#identitySource
IdentitySource.header('Authorization')
property validationRegex
readonly validationRegex?: string;
An optional regex to be matched against the authorization token. When matched the authorizer lambda is invoked, otherwise a 401 Unauthorized is returned to the client.
- no regex filter will be applied.
interface UsagePlanPerApiStage
interface UsagePlanPerApiStage {}
Represents the API stages that a usage plan applies to.
interface UsagePlanProps
interface UsagePlanProps {}
property apiKey
readonly apiKey?: IApiKey;
ApiKey to be associated with the usage plan. none
Deprecated
use
addApiKey()
property apiStages
readonly apiStages?: UsagePlanPerApiStage[];
API Stages to be associated with the usage plan. none
property description
readonly description?: string;
Represents usage plan purpose. none
property name
readonly name?: string;
Name for this usage plan. none
property quota
readonly quota?: QuotaSettings;
Number of requests clients can make in a given time period. none
property throttle
readonly throttle?: ThrottleSettings;
Overall throttle settings for the API. none
interface VpcLinkProps
interface VpcLinkProps {}
Properties for a VpcLink
property description
readonly description?: string;
The description of the VPC link. no description
property targets
readonly targets?: elbv2.INetworkLoadBalancer[];
The network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.
- no targets. Use
addTargets
to add targets
property vpcLinkName
readonly vpcLinkName?: string;
The name used to label and identify the VPC link. - automatically generated name
Enums
enum ApiKeySourceType
enum ApiKeySourceType { HEADER = 'HEADER', AUTHORIZER = 'AUTHORIZER',}
member AUTHORIZER
AUTHORIZER = 'AUTHORIZER'
To read the API key from the
UsageIdentifierKey
from a custom authorizer.
member HEADER
HEADER = 'HEADER'
To read the API key from the
X-API-Key
header of a request.
enum AuthorizationType
enum AuthorizationType { NONE = 'NONE', IAM = 'AWS_IAM', CUSTOM = 'CUSTOM', COGNITO = 'COGNITO_USER_POOLS',}
enum ConnectionType
enum ConnectionType { INTERNET = 'INTERNET', VPC_LINK = 'VPC_LINK',}
enum ContentHandling
enum ContentHandling { CONVERT_TO_BINARY = 'CONVERT_TO_BINARY', CONVERT_TO_TEXT = 'CONVERT_TO_TEXT',}
member CONVERT_TO_BINARY
CONVERT_TO_BINARY = 'CONVERT_TO_BINARY'
Converts a request payload from a base64-encoded string to a binary blob.
member CONVERT_TO_TEXT
CONVERT_TO_TEXT = 'CONVERT_TO_TEXT'
Converts a request payload from a binary blob to a base64-encoded string.
enum EndpointType
enum EndpointType { EDGE = 'EDGE', REGIONAL = 'REGIONAL', PRIVATE = 'PRIVATE',}
enum IntegrationType
enum IntegrationType { AWS = 'AWS', AWS_PROXY = 'AWS_PROXY', HTTP = 'HTTP', HTTP_PROXY = 'HTTP_PROXY', MOCK = 'MOCK',}
member AWS
AWS = 'AWS'
For integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.
member AWS_PROXY
AWS_PROXY = 'AWS_PROXY'
For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration
member HTTP
HTTP = 'HTTP'
For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration.
member HTTP_PROXY
HTTP_PROXY = 'HTTP_PROXY'
For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration
member MOCK
MOCK = 'MOCK'
For integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.
enum JsonSchemaType
enum JsonSchemaType { NULL = 'null', BOOLEAN = 'boolean', OBJECT = 'object', ARRAY = 'array', NUMBER = 'number', INTEGER = 'integer', STRING = 'string',}
enum JsonSchemaVersion
enum JsonSchemaVersion { DRAFT4 = 'http://json-schema.org/draft-04/schema#', DRAFT7 = 'http://json-schema.org/draft-07/schema#',}
enum MethodLoggingLevel
enum MethodLoggingLevel { OFF = 'OFF', ERROR = 'ERROR', INFO = 'INFO',}
enum PassthroughBehavior
enum PassthroughBehavior { WHEN_NO_MATCH = 'WHEN_NO_MATCH', NEVER = 'NEVER', WHEN_NO_TEMPLATES = 'WHEN_NO_TEMPLATES',}
member NEVER
NEVER = 'NEVER'
Rejects unmapped content types with an HTTP 415 'Unsupported Media Type' response
member WHEN_NO_MATCH
WHEN_NO_MATCH = 'WHEN_NO_MATCH'
Passes the request body for unmapped content types through to the integration back end without transformation.
member WHEN_NO_TEMPLATES
WHEN_NO_TEMPLATES = 'WHEN_NO_TEMPLATES'
Allows pass-through when the integration has NO content types mapped to templates. However if there is at least one content type defined, unmapped content types will be rejected with the same 415 response.
enum Period
enum Period { DAY = 'DAY', WEEK = 'WEEK', MONTH = 'MONTH',}
Time period for which quota settings apply.
enum SecurityPolicy
enum SecurityPolicy { TLS_1_0 = 'TLS_1_0', TLS_1_2 = 'TLS_1_2',}
The minimum version of the SSL protocol that you want API Gateway to use for HTTPS connections.
Namespaces
namespace CfnApiKey
namespace CfnApiKey {}
interface StageKeyProperty
interface StageKeyProperty {}
StageKey
is a property of the [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource that specifies the stage to associate with the API key. This association allows only clients with the key to make requests to methods in that stage.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html
property restApiId
readonly restApiId?: string;
The string identifier of the associated RestApi.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-restapiid
property stageName
readonly stageName?: string;
The stage name associated with the stage key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-apikey-stagekey.html#cfn-apigateway-apikey-stagekey-stagename
namespace CfnApiV2
namespace CfnApiV2 {}
Deprecated
moved to package aws-apigatewayv2
interface BodyS3LocationProperty
interface BodyS3LocationProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html
Deprecated
moved to package aws-apigatewayv2
property bucket
readonly bucket?: string;
CfnApiV2.BodyS3LocationProperty.Bucket
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-bucket
property etag
readonly etag?: string;
CfnApiV2.BodyS3LocationProperty.Etag
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-etag
property key
readonly key?: string;
CfnApiV2.BodyS3LocationProperty.Key
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-key
property version
readonly version?: string;
CfnApiV2.BodyS3LocationProperty.Version
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-bodys3location.html#cfn-apigatewayv2-api-bodys3location-version
interface CorsProperty
interface CorsProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html
Deprecated
moved to package aws-apigatewayv2
property allowCredentials
readonly allowCredentials?: boolean | cdk.IResolvable;
CfnApiV2.CorsProperty.AllowCredentials
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowcredentials
property allowHeaders
readonly allowHeaders?: string[];
CfnApiV2.CorsProperty.AllowHeaders
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowheaders
property allowMethods
readonly allowMethods?: string[];
CfnApiV2.CorsProperty.AllowMethods
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-allowmethods
property allowOrigins
readonly allowOrigins?: string[];
CfnApiV2.CorsProperty.AllowOrigins
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-alloworigins
property exposeHeaders
readonly exposeHeaders?: string[];
CfnApiV2.CorsProperty.ExposeHeaders
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-exposeheaders
property maxAge
readonly maxAge?: number;
CfnApiV2.CorsProperty.MaxAge
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-api-cors.html#cfn-apigatewayv2-api-cors-maxage
namespace CfnAuthorizerV2
namespace CfnAuthorizerV2 {}
Deprecated
moved to package aws-apigatewayv2
interface JWTConfigurationProperty
interface JWTConfigurationProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html
Deprecated
moved to package aws-apigatewayv2
property audience
readonly audience?: string[];
CfnAuthorizerV2.JWTConfigurationProperty.Audience
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-audience
property issuer
readonly issuer?: string;
CfnAuthorizerV2.JWTConfigurationProperty.Issuer
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-authorizer-jwtconfiguration.html#cfn-apigatewayv2-authorizer-jwtconfiguration-issuer
namespace CfnDeployment
namespace CfnDeployment {}
interface AccessLogSettingProperty
interface AccessLogSettingProperty {}
The
AccessLogSetting
property type specifies settings for logging access in this stage.AccessLogSetting
is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html
property destinationArn
readonly destinationArn?: string;
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-
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-destinationarn
property format
readonly format?: 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
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-accesslogsetting.html#cfn-apigateway-deployment-accesslogsetting-format
interface CanarySettingProperty
interface CanarySettingProperty {}
The
CanarySetting
property type specifies settings for the canary deployment in this stage.CanarySetting
is a property of the [StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html
property percentTraffic
readonly percentTraffic?: number;
The percent (0-100) of traffic diverted to a canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-percenttraffic
property stageVariableOverrides
readonly stageVariableOverrides?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-stagevariableoverrides
property useStageCache
readonly useStageCache?: boolean | cdk.IResolvable;
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-canarysetting.html#cfn-apigateway-deployment-canarysetting-usestagecache
interface DeploymentCanarySettingsProperty
interface DeploymentCanarySettingsProperty {}
The
DeploymentCanarySettings
property type specifies settings for the canary deployment.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html
property percentTraffic
readonly percentTraffic?: number;
The percentage (0.0-100.0) of traffic routed to the canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-percenttraffic
property stageVariableOverrides
readonly stageVariableOverrides?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-stagevariableoverrides
property useStageCache
readonly useStageCache?: boolean | cdk.IResolvable;
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-deploymentcanarysettings.html#cfn-apigateway-deployment-deploymentcanarysettings-usestagecache
interface MethodSettingProperty
interface MethodSettingProperty {}
The
MethodSetting
property type configures settings for all methods in a stage.The
MethodSettings
property of the [Amazon API Gateway Deployment StageDescription](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html) property type contains a list ofMethodSetting
property types.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html
property cacheDataEncrypted
readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
Specifies whether the cached responses are encrypted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachedataencrypted
property cacheTtlInSeconds
readonly cacheTtlInSeconds?: number;
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachettlinseconds
property cachingEnabled
readonly cachingEnabled?: boolean | cdk.IResolvable;
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-cachingenabled
property dataTraceEnabled
readonly dataTraceEnabled?: boolean | cdk.IResolvable;
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-datatraceenabled
property httpMethod
readonly httpMethod?: string;
The HTTP method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-httpmethod
property loggingLevel
readonly loggingLevel?: string;
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are
OFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-logginglevel
property metricsEnabled
readonly metricsEnabled?: boolean | cdk.IResolvable;
Specifies whether Amazon CloudWatch metrics are enabled for this method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-metricsenabled
property resourcePath
readonly resourcePath?: string;
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 (/
).http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-resourcepath
property throttlingBurstLimit
readonly throttlingBurstLimit?: number;
Specifies the throttling burst limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingburstlimit
property throttlingRateLimit
readonly throttlingRateLimit?: number;
Specifies the throttling rate limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-methodsetting.html#cfn-apigateway-deployment-methodsetting-throttlingratelimit
interface StageDescriptionProperty
interface StageDescriptionProperty {}
StageDescription
is a property of the [AWS::ApiGateway::Deployment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html) resource that configures a deployment stage.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html
property accessLogSetting
readonly accessLogSetting?: | CfnDeployment.AccessLogSettingProperty | cdk.IResolvable;
Specifies settings for logging access in this stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-accesslogsetting
property cacheClusterEnabled
readonly cacheClusterEnabled?: boolean | cdk.IResolvable;
Specifies whether a cache cluster is enabled for the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclusterenabled
property cacheClusterSize
readonly cacheClusterSize?: string;
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* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cacheclustersize
property cacheDataEncrypted
readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
Indicates whether the cached responses are encrypted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachedataencrypted
property cacheTtlInSeconds
readonly cacheTtlInSeconds?: number;
The time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches responses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachettlinseconds
property cachingEnabled
readonly cachingEnabled?: boolean | cdk.IResolvable;
Indicates whether responses are cached and returned for requests. You must enable a cache cluster on the stage to cache responses. For more information, see [Enable API Gateway Caching in a Stage to Enhance API Performance](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html) in the *API Gateway Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-cachingenabled
property canarySetting
readonly canarySetting?: CfnDeployment.CanarySettingProperty | cdk.IResolvable;
Specifies settings for the canary deployment in this stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-canarysetting
property clientCertificateId
readonly clientCertificateId?: string;
The identifier of the client certificate that API Gateway uses to call your integration endpoints in the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-clientcertificateid
property dataTraceEnabled
readonly dataTraceEnabled?: boolean | cdk.IResolvable;
Indicates whether data trace logging is enabled for methods in the stage. API Gateway pushes these logs to Amazon CloudWatch Logs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-datatraceenabled
property description
readonly description?: string;
A description of the purpose of the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-description
property documentationVersion
readonly documentationVersion?: string;
The version identifier of the API documentation snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-documentationversion
property loggingLevel
readonly loggingLevel?: string;
The logging level for this method. For valid values, see the
loggingLevel
property of the [MethodSetting](https://docs.aws.amazon.com/apigateway/latest/api/API_MethodSetting.html) resource in the *Amazon API Gateway API Reference* .http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-logginglevel
property methodSettings
readonly methodSettings?: | Array<CfnDeployment.MethodSettingProperty | cdk.IResolvable> | cdk.IResolvable;
Configures settings for all of the stage's methods.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-methodsettings
property metricsEnabled
readonly metricsEnabled?: boolean | cdk.IResolvable;
Indicates whether Amazon CloudWatch metrics are enabled for methods in the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-metricsenabled
property tags
readonly tags?: cdk.CfnTag[];
An array of arbitrary tags (key-value pairs) to associate with the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tags
property throttlingBurstLimit
readonly throttlingBurstLimit?: number;
The target request burst rate limit. This allows more requests through for a period of time than the target rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingburstlimit
property throttlingRateLimit
readonly throttlingRateLimit?: number;
The target request steady-state rate limit. For more information, see [Manage API Request Throttling](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-request-throttling.html) in the *API Gateway Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-throttlingratelimit
property tracingEnabled
readonly tracingEnabled?: boolean | cdk.IResolvable;
Specifies whether active tracing with X-ray is enabled for this stage.
For more information, see [Trace API Gateway API Execution with AWS X-Ray](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-xray.html) in the *API Gateway Developer Guide* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-tracingenabled
property variables
readonly variables?: | { [key: string]: string; } | cdk.IResolvable;
A map that defines the stage variables. Variable names must consist of alphanumeric characters, and the values must match the following regular expression:
[A-Za-z0-9-._~:/?#&=,]+
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-deployment-stagedescription.html#cfn-apigateway-deployment-stagedescription-variables
namespace CfnDocumentationPart
namespace CfnDocumentationPart {}
interface LocationProperty
interface LocationProperty {}
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* .
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html
property method
readonly method?: string;
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
, andRESPONSE_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 otherlocation
attributes, the child entity'smethod
attribute must match that of the parent entity exactly.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-method
property name
readonly name?: 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
andRESPONSE_HEADER
. It is an invalid field for any other entity type.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-name
property path
readonly path?: 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
, andRESPONSE_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 otherlocation
attributes, the child entity'spath
attribute must match that of the parent entity as a prefix.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-path
property statusCode
readonly statusCode?: string;
The HTTP status code of a response. It is a valid field for the API entity types of
RESPONSE
,RESPONSE_HEADER
, andRESPONSE_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 otherlocation
attributes, the child entity'sstatusCode
attribute must match that of the parent entity exactly.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-statuscode
property type
readonly type?: 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
, andRESPONSE_BODY
. Content inheritance does not apply to any entity of theAPI
,AUTHORIZER
,METHOD
,MODEL
,REQUEST_BODY
, orRESOURCE
type.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-documentationpart-location.html#cfn-apigateway-documentationpart-location-type
namespace CfnDomainName
namespace CfnDomainName {}
interface EndpointConfigurationProperty
interface EndpointConfigurationProperty {}
The
EndpointConfiguration
property type specifies the endpoint types of an Amazon API Gateway domain name.EndpointConfiguration
is a property of the [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html
property types
readonly types?: string[];
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 isREGIONAL
. For a private API, the endpoint type isPRIVATE
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-endpointconfiguration.html#cfn-apigateway-domainname-endpointconfiguration-types
interface MutualTlsAuthenticationProperty
interface MutualTlsAuthenticationProperty {}
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html
property truststoreUri
readonly truststoreUri?: string;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreuri
property truststoreVersion
readonly truststoreVersion?: string;
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-domainname-mutualtlsauthentication.html#cfn-apigateway-domainname-mutualtlsauthentication-truststoreversion
namespace CfnDomainNameV2
namespace CfnDomainNameV2 {}
Deprecated
moved to package aws-apigatewayv2
interface DomainNameConfigurationProperty
interface DomainNameConfigurationProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html
Deprecated
moved to package aws-apigatewayv2
property certificateArn
readonly certificateArn?: string;
CfnDomainNameV2.DomainNameConfigurationProperty.CertificateArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatearn
property certificateName
readonly certificateName?: string;
CfnDomainNameV2.DomainNameConfigurationProperty.CertificateName
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-certificatename
property endpointType
readonly endpointType?: string;
CfnDomainNameV2.DomainNameConfigurationProperty.EndpointType
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-domainname-domainnameconfiguration.html#cfn-apigatewayv2-domainname-domainnameconfiguration-endpointtype
namespace CfnMethod
namespace CfnMethod {}
interface IntegrationProperty
interface IntegrationProperty {}
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.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html
property cacheKeyParameters
readonly cacheKeyParameters?: string[];
A list of request parameters whose values API Gateway caches. To be valid values for
cacheKeyParameters
, these parameters must also be specified for MethodrequestParameters
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachekeyparameters
property cacheNamespace
readonly cacheNamespace?: string;
Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the
cacheNamespace
. You can specify the samecacheNamespace
across resources to return the same cached data for requests to different resources.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-cachenamespace
property connectionId
readonly connectionId?: string;
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK
and undefined, otherwise.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectionid
property connectionType
readonly connectionType?: string;
The type of the network connection to the integration endpoint. The valid value is
INTERNET
for connections through the public routable internet orVPC_LINK
for private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-connectiontype
property contentHandling
readonly contentHandling?: string;
Specifies how to handle request payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-contenthandling
property credentials
readonly credentials?: string;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-credentials
property integrationHttpMethod
readonly integrationHttpMethod?: 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 toPOST
. For all other types, you must specify this property.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationhttpmethod
property integrationResponses
readonly integrationResponses?: | Array<CfnMethod.IntegrationResponseProperty | cdk.IResolvable> | cdk.IResolvable;
Specifies the integration's responses.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-integrationresponses
property passthroughBehavior
readonly passthroughBehavior?: string;
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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-passthroughbehavior
property requestParameters
readonly requestParameters?: | { [key: string]: string; } | cdk.IResolvable;
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}
, wherelocation
isquerystring
,path
, orheader
andname
must be a valid and unique method request parameter name.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requestparameters
property requestTemplates
readonly requestTemplates?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-requesttemplates
property timeoutInMillis
readonly timeoutInMillis?: number;
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-timeoutinmillis
property type
readonly type?: string;
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 aconnectionType
ofVPC_LINK
is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-type
property uri
readonly uri?: string;
Specifies Uniform Resource Identifier (URI) of the integration endpoint.
For
HTTP
orHTTP_PROXY
integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification for standard integrations. IfconnectionType
isVPC_LINK
specify the Network Load Balancer DNS name. ForAWS
orAWS_PROXY
integrations, the URI is of the formarn: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 eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}
orarn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html#cfn-apigateway-method-integration-uri
interface IntegrationResponseProperty
interface IntegrationResponseProperty {}
IntegrationResponse
is a property of the [Amazon API Gateway Method Integration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration.html) property type that specifies the response that API Gateway sends after a method's backend finishes processing a request.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html
property contentHandling
readonly contentHandling?: string;
Specifies how to handle response payload content type conversions. Supported values are
CONVERT_TO_BINARY
andCONVERT_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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integrationresponse-contenthandling
property responseParameters
readonly responseParameters?: | { [key: string]: string; } | cdk.IResolvable;
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}
, wherename
is a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}
orintegration.response.body.{JSON-expression}
, wherename
is a valid and unique response header name andJSON-expression
is a valid JSON expression without the$
prefix.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responseparameters
property responseTemplates
readonly responseTemplates?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-responsetemplates
property selectionPattern
readonly selectionPattern?: 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 AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-selectionpattern
property statusCode
readonly statusCode: string;
Specifies the status code that is used to map the integration response to an existing MethodResponse.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-integration-integrationresponse.html#cfn-apigateway-method-integration-integrationresponse-statuscode
interface MethodResponseProperty
interface MethodResponseProperty {}
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.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html
property responseModels
readonly responseModels?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responsemodels
property responseParameters
readonly responseParameters?: | { [key: string]: boolean | cdk.IResolvable; } | cdk.IResolvable;
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}
, wherename
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 inintegration.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 ofintegration.response.body.{JSON-expression}
, whereJSON-expression
is a valid JSON expression without the$
prefix.)http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-responseparameters
property statusCode
readonly statusCode: string;
The method response's status code.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apitgateway-method-methodresponse.html#cfn-apigateway-method-methodresponse-statuscode
namespace CfnRestApi
namespace CfnRestApi {}
interface EndpointConfigurationProperty
interface EndpointConfigurationProperty {}
The
EndpointConfiguration
property type specifies the endpoint types of a REST API.EndpointConfiguration
is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html
property types
readonly types?: string[];
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 isREGIONAL
. For a private API, the endpoint type isPRIVATE
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-types
property vpcEndpointIds
readonly vpcEndpointIds?: string[];
A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for
PRIVATE
endpoint type.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html#cfn-apigateway-restapi-endpointconfiguration-vpcendpointids
interface S3LocationProperty
interface S3LocationProperty {}
S3Location
is a property of the [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource that specifies the Amazon S3 location of a OpenAPI (formerly Swagger) file that defines a set of RESTful APIs in JSON or YAML.> 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.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html
property bucket
readonly bucket?: string;
The name of the S3 bucket where the OpenAPI file is stored.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-bucket
property eTag
readonly eTag?: string;
The Amazon S3 ETag (a file checksum) of the OpenAPI file. If you don't specify a value, API Gateway skips ETag validation of your OpenAPI file.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-etag
property key
readonly key?: string;
The file name of the OpenAPI file (Amazon S3 object name).
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-key
property version
readonly version?: string;
For versioning-enabled buckets, a specific version of the OpenAPI file.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-s3location.html#cfn-apigateway-restapi-s3location-version
namespace CfnRouteResponseV2
namespace CfnRouteResponseV2 {}
Deprecated
moved to package aws-apigatewayv2
interface ParameterConstraintsProperty
interface ParameterConstraintsProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html
Deprecated
moved to package aws-apigatewayv2
property required
readonly required: boolean | cdk.IResolvable;
CfnRouteResponseV2.ParameterConstraintsProperty.Required
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-routeresponse-parameterconstraints.html#cfn-apigatewayv2-routeresponse-parameterconstraints-required
namespace CfnRouteV2
namespace CfnRouteV2 {}
Deprecated
moved to package aws-apigatewayv2
interface ParameterConstraintsProperty
interface ParameterConstraintsProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html
Deprecated
moved to package aws-apigatewayv2
property required
readonly required: boolean | cdk.IResolvable;
CfnRouteV2.ParameterConstraintsProperty.Required
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-route-parameterconstraints.html#cfn-apigatewayv2-route-parameterconstraints-required
namespace CfnStage
namespace CfnStage {}
interface AccessLogSettingProperty
interface AccessLogSettingProperty {}
The
AccessLogSetting
property type specifies settings for logging access in this stage.AccessLogSetting
is a property of the [AWS::ApiGateway::Stage](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html) resource.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html
property destinationArn
readonly destinationArn?: string;
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-
. This parameter is required to enable access logging.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-destinationarn
property format
readonly format?: string;
A single line format of the access logs of data, as specified by selected [$context variables](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference) . The format must include at least
$context.requestId
. This parameter is required to enable access logging.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-accesslogsetting.html#cfn-apigateway-stage-accesslogsetting-format
interface CanarySettingProperty
interface CanarySettingProperty {}
Configuration settings of a canary deployment.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html
property deploymentId
readonly deploymentId?: string;
The ID of the canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-deploymentid
property percentTraffic
readonly percentTraffic?: number;
The percent (0-100) of traffic diverted to a canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-percenttraffic
property stageVariableOverrides
readonly stageVariableOverrides?: | { [key: string]: string; } | cdk.IResolvable;
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.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-stagevariableoverrides
property useStageCache
readonly useStageCache?: boolean | cdk.IResolvable;
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-canarysetting.html#cfn-apigateway-stage-canarysetting-usestagecache
interface MethodSettingProperty
interface MethodSettingProperty {}
The
MethodSetting
property type configures settings for all methods in a stage.The
MethodSettings
property of theAWS::ApiGateway::Stage
resource contains a list ofMethodSetting
property types.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html
property cacheDataEncrypted
readonly cacheDataEncrypted?: boolean | cdk.IResolvable;
Specifies whether the cached responses are encrypted.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachedataencrypted
property cacheTtlInSeconds
readonly cacheTtlInSeconds?: number;
Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachettlinseconds
property cachingEnabled
readonly cachingEnabled?: boolean | cdk.IResolvable;
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-cachingenabled
property dataTraceEnabled
readonly dataTraceEnabled?: boolean | cdk.IResolvable;
Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-datatraceenabled
property httpMethod
readonly httpMethod?: string;
The HTTP method. To apply settings to multiple resources and methods, specify an asterisk (
*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-httpmethod
property loggingLevel
readonly loggingLevel?: string;
Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. Valid values are
OFF
,ERROR
, andINFO
. ChooseERROR
to write only error-level entries to CloudWatch Logs, or chooseINFO
to include allERROR
events as well as extra informational events.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-logginglevel
property metricsEnabled
readonly metricsEnabled?: boolean | cdk.IResolvable;
Specifies whether Amazon CloudWatch metrics are enabled for this method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-metricsenabled
property resourcePath
readonly resourcePath?: string;
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 (/
). To apply settings to multiple resources and methods, specify an asterisk (*
) for theHttpMethod
and/*
for theResourcePath
. This parameter is required when you specify aMethodSetting
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-resourcepath
property throttlingBurstLimit
readonly throttlingBurstLimit?: number;
Specifies the throttling burst limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingburstlimit
property throttlingRateLimit
readonly throttlingRateLimit?: number;
Specifies the throttling rate limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-stage-methodsetting.html#cfn-apigateway-stage-methodsetting-throttlingratelimit
namespace CfnStageV2
namespace CfnStageV2 {}
Deprecated
moved to package aws-apigatewayv2
interface AccessLogSettingsProperty
interface AccessLogSettingsProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html
Deprecated
moved to package aws-apigatewayv2
property destinationArn
readonly destinationArn?: string;
CfnStageV2.AccessLogSettingsProperty.DestinationArn
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-destinationarn
property format
readonly format?: string;
CfnStageV2.AccessLogSettingsProperty.Format
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-accesslogsettings.html#cfn-apigatewayv2-stage-accesslogsettings-format
interface RouteSettingsProperty
interface RouteSettingsProperty {}
deprecated
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html
Deprecated
moved to package aws-apigatewayv2
property dataTraceEnabled
readonly dataTraceEnabled?: boolean | cdk.IResolvable;
CfnStageV2.RouteSettingsProperty.DataTraceEnabled
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-datatraceenabled
property detailedMetricsEnabled
readonly detailedMetricsEnabled?: boolean | cdk.IResolvable;
CfnStageV2.RouteSettingsProperty.DetailedMetricsEnabled
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-detailedmetricsenabled
property loggingLevel
readonly loggingLevel?: string;
CfnStageV2.RouteSettingsProperty.LoggingLevel
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-logginglevel
property throttlingBurstLimit
readonly throttlingBurstLimit?: number;
CfnStageV2.RouteSettingsProperty.ThrottlingBurstLimit
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingburstlimit
property throttlingRateLimit
readonly throttlingRateLimit?: number;
CfnStageV2.RouteSettingsProperty.ThrottlingRateLimit
See Also
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-stage-routesettings.html#cfn-apigatewayv2-stage-routesettings-throttlingratelimit
namespace CfnUsagePlan
namespace CfnUsagePlan {}
interface ApiStageProperty
interface ApiStageProperty {}
API stage name of the associated API stage in a usage plan.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html
property apiId
readonly apiId?: string;
API Id of the associated API stage in a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-apiid
property stage
readonly stage?: string;
API stage name of the associated API stage in a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-stage
property throttle
readonly throttle?: | { [key: string]: CfnUsagePlan.ThrottleSettingsProperty | cdk.IResolvable; } | cdk.IResolvable;
Map containing method level throttling information for API stage in a usage plan.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-apistage.html#cfn-apigateway-usageplan-apistage-throttle
interface QuotaSettingsProperty
interface QuotaSettingsProperty {}
QuotaSettings
is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies a target for the maximum number of requests users can make to your REST APIs.In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using [AWS Budgets](https://docs.aws.amazon.com/cost-management/latest/userguide/budgets-managing-costs.html) to monitor costs and [AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) to manage API requests.
external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html
property limit
readonly limit?: number;
The target maximum number of requests that can be made in a given time period.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-limit
property offset
readonly offset?: number;
The number of requests subtracted from the given limit in the initial time period.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-offset
property period
readonly period?: string;
The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-quotasettings.html#cfn-apigateway-usageplan-quotasettings-period
interface ThrottleSettingsProperty
interface ThrottleSettingsProperty {}
ThrottleSettings
is a property of the [AWS::ApiGateway::UsagePlan](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-usageplan.html) resource that specifies the overall request rate (average requests per second) and burst capacity when users call your REST APIs.external
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html
property burstLimit
readonly burstLimit?: number;
The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-burstlimit
property rateLimit
readonly rateLimit?: number;
The API target request rate limit.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-usageplan-throttlesettings.html#cfn-apigateway-usageplan-throttlesettings-ratelimit
Package Files (34)
- lib/access-log.d.ts
- lib/api-definition.d.ts
- lib/api-key.d.ts
- lib/apigateway.generated.d.ts
- lib/apigatewayv2.d.ts
- lib/authorizer.d.ts
- lib/authorizers/cognito.d.ts
- lib/authorizers/identity-source.d.ts
- lib/authorizers/lambda.d.ts
- lib/base-path-mapping.d.ts
- lib/cors.d.ts
- lib/deployment.d.ts
- lib/domain-name.d.ts
- lib/gateway-response.d.ts
- lib/index.d.ts
- lib/integration.d.ts
- lib/integrations/aws.d.ts
- lib/integrations/http.d.ts
- lib/integrations/lambda.d.ts
- lib/integrations/mock.d.ts
- lib/integrations/request-context.d.ts
- lib/integrations/stepfunctions.d.ts
- lib/json-schema.d.ts
- lib/lambda-api.d.ts
- lib/method.d.ts
- lib/methodresponse.d.ts
- lib/model.d.ts
- lib/requestvalidator.d.ts
- lib/resource.d.ts
- lib/restapi.d.ts
- lib/stage.d.ts
- lib/stepfunctions-api.d.ts
- lib/usage-plan.d.ts
- lib/vpc-link.d.ts
Dependencies (14)
Dev Dependencies (6)
Peer Dependencies (14)
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@aws-cdk/aws-apigateway
.
- Markdown[](https://www.jsdocs.io/package/@aws-cdk/aws-apigateway)
- HTML<a href="https://www.jsdocs.io/package/@aws-cdk/aws-apigateway"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 9415 ms. - Missing or incorrect documentation? Open an issue for this package.