@aws-cdk/aws-apigateway
- Version 1.156.0
- Published
- 5.36 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.> If an API Gateway resource has never been created in your AWS account , you must add a dependency on another API Gateway resource, such as an [AWS::ApiGateway::RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) or [AWS::ApiGateway::ApiKey](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html) resource. > > If an API Gateway resource has been created in your AWS account , no dependency is required (even if the resource was deleted).
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 Amazon Resource Name (ARN) of an IAM role that has write access to CloudWatch Logs in your 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 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
property description
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
property enabled
enabled: any;
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
property generateDistinctId
generateDistinctId: any;
Specifies whether 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;
A list of stages to associate with this 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;
An array of arbitrary tags (key-value pairs) to associate with the API key.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-apikey.html#cfn-apigateway-apikey-tags
property value
value: string;
The value of the API key. Must be at least 20 characters long.
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;
The credentials that are required for the authorizer. To specify an IAM role that API Gateway assumes, specify 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 time-to-live (TTL) period, in seconds, that specifies how long API Gateway caches authorizer results. If you specify a value greater than 0, API Gateway caches the authorizer responses. By default, API Gateway sets this property to 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;
The authorizer's Uniform Resource Identifier (URI). If you specify
TOKEN
for the authorizer'sType
property, specify a Lambda function URI that has the formarn:aws:apigateway: *region* :lambda:path/ *path*
. The path usually has the form /2015-03-31/functions/ *LambdaFunctionARN* /invocations.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-authorizeruri
property authType
authType: string;
An optional customer-defined field that's 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 source of the identity in an incoming request.
If you specify
TOKEN
orCOGNITO_USER_POOLS
for theType
property, this property is required. Specify a header mapping expression using the formmethod.request.header. *name*
, where *name* is the name of a custom authorization header that clients submit as part of their requests.If you specify
REQUEST
for theType
property, this property is required when authorization caching is enabled. Specify a comma-separated string of one or more mapping expressions of the specified request parameter using the formmethod.request.parameter. *name*
. For supported parameter types, see [Configure Lambda Authorizer Using the API Gateway Console](https://docs.aws.amazon.com/apigateway/latest/developerguide/configure-api-gateway-lambda-authorization-with-console.html) in the *API Gateway Developer Guide* .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. If you specify
TOKEN
for the authorizer'sType
property, specify a regular expression. API Gateway uses the expression to attempt to match the incoming client token, and proceeds if the token matches. If the token doesn't match, API Gateway responds with a 401 (unauthorized request) error code.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 Amazon Resource Names (ARNs) to associate with this authorizer. Required if you specify
COGNITO_USER_POOLS
as the authorizerType
. For more information, see [Use Amazon Cognito User Pools](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-integrate-with-cognito.html#apigateway-enable-cognito-user-pool) in the *API Gateway Developer Guide* .http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-providerarns
property restApiId
restApiId: string;
The ID of the
RestApi
resource that API Gateway creates the authorizer in.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html#cfn-apigateway-authorizer-restapiid
property type
type: string;
The type of authorizer. Valid values include:
-
TOKEN
: A custom authorizer that uses a Lambda function. -COGNITO_USER_POOLS
: An authorizer that uses Amazon Cognito user pools. -REQUEST
: An authorizer that uses a Lambda function using incoming request parameters.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 in 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
DomainName
of an [AWS::ApiGateway::DomainName](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html) resource.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 ID of the API.
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 API's 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;
A 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;
An array of arbitrary tags (key-value pairs) to associate with the client certificate.
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;
Specifies settings for the canary deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-deploymentcanarysettings
property description
description: string;
A description of the purpose of the API Gateway deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-description
property restApiId
restApiId: string;
The ID of the
RestApi
resource to deploy.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-restapiid
property stageDescription
stageDescription: any;
Configures the stage that API Gateway creates with this deployment.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-deployment.html#cfn-apigateway-deployment-stagedescription
property stageName
stageName: string;
A name for the stage that API Gateway creates with this deployment. Use only alphanumeric characters.
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 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 API entity that the documentation applies to.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-location
property properties
properties: string;
The documentation content map of the targeted API entity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationpart.html#cfn-apigateway-documentationpart-properties
property restApiId
restApiId: string;
The identifier of the targeted API entity.
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;
The description of the API 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 API documentation snapshot.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-documentationversion.html#cfn-apigateway-documentationversion-documentationversion
property restApiId
restApiId: string;
The identifier of the API.
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 for use by the edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source. For requirements and additional information about setting up certificates, see [Get Certificates Ready in AWS Certificate Manager](https://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html#how-to-custom-domains-prerequisites) in the *API Gateway Developer Guide* .
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 for your API. Uppercase letters are not supported.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-domainname.html#cfn-apigateway-domainname-domainname
property endpointConfiguration
endpointConfiguration: any;
A list of 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.
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 for use by the regional endpoint for the 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 domain name.
Valid values include
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;
An array of arbitrary tags (key-value pairs) to associate with the domain name.
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;
The response parameters (paths, query strings, and headers) for the response. Duplicates not allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responseparameters
property responseTemplates
responseTemplates: any;
The response templates for the response. Duplicates not allowed.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetemplates
property responseType
responseType: string;
The response type. For valid values, see [GatewayResponse](https://docs.aws.amazon.com/apigateway/api-reference/resource/gateway-response/) in the *API Gateway API Reference* .
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-gatewayresponse.html#cfn-apigateway-gatewayresponse-responsetype
property restApiId
restApiId: string;
The identifier of the API.
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 the response.
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;
Indicates whether the method requires clients to submit a valid API key.
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 match 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/api-reference/resource/method/) 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 the [authorizer](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-authorizer.html) to use on this method. If you specify this property, specify
CUSTOM
orCOGNITO_USER_POOLS
for theAuthorizationType
property.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 HTTP method that clients use to call this method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-httpmethod
property integration
integration: any;
The backend system that the method calls when it receives a request.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-integration
property methodResponses
methodResponses: any;
The responses that can be sent to the client who calls the method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-methodresponses
property operationName
operationName: string;
A friendly operation name for the method. For example, you can assign the
OperationName
ofListPets
for theGET /pets
method.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-operationname
property requestModels
requestModels: any;
The resources that are used for the request's content type. Specify request models as key-value pairs (string-to-string mapping), with a content type as the key and a
Model
resource name as the value. To use the same model regardless of the content type, specify$default
as the key.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestmodels
property requestParameters
requestParameters: any;
The request parameters that API Gateway accepts. Specify request parameters as key-value pairs (string-to-Boolean mapping), with a source as the key and a Boolean as the value. 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.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestparameters
property requestValidatorId
requestValidatorId: string;
The ID of the associated request validator.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-requestvalidatorid
property resourceId
resourceId: string;
The ID of an API Gateway [resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html) . For root resource methods, specify the
RestApi
root resource ID, such as{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-method.html#cfn-apigateway-method-resourceid
property restApiId
restApiId: string;
The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which API Gateway creates the method.
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;
A description that identifies this 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 ID of a REST API with which to associate this model.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-model.html#cfn-apigateway-model-restapiid
property schema
schema: any;
The schema to use to transform data to one or more output formats. Specify null (
{}
) if you don't want to specify a schema.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 request validator.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-name
property restApiId
restApiId: string;
The identifier of the targeted API entity.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-restapiid
property validateRequestBody
validateRequestBody: any;
Indicates whether to validate the request body according to the configured schema for the targeted API and method.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-requestvalidator.html#cfn-apigateway-requestvalidator-validaterequestbody
property validateRequestParameters
validateRequestParameters: any;
Indicates whether to validate request parameters.
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;
If you want to create a child resource, the ID of the parent resource. For resources without a parent, specify the
RestApi
root resource ID, such as{ "Fn::GetAtt": ["MyRestApi", "RootResourceId"] }
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-parentid
property pathPart
pathPart: string;
A path name for the resource.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-resource.html#cfn-apigateway-resource-pathpart
property restApiId
restApiId: string;
The ID of the [RestApi](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html) resource in which you want to create this resource.
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/api-reference/link-relation/restapi-create/) 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 Lambda authorizer.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-apikeysourcetype
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 that are supported by the
RestApi
resource. Use~1
instead of/
in the media types, for exampleimage~1png
orapplication~1octet-stream
. By default,RestApi
supports only UTF-8-encoded text payloads. Duplicates are not allowed. For more information, see [Enable Support for Binary Payloads in API Gateway](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-payload-encodings.html) in the *API Gateway Developer Guide* .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
resource that you want to clone.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-clonefrom
property description
description: string;
A description of the
RestApi
resource.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 default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.http://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;
Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the
RestApi
resource.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 takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Usemerge
to define top-levelRestApi
properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is
overwrite
. Otherwise, the default value ismerge
.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-mode
property name
name: string;
A name for the
RestApi
resource.http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html#cfn-apigateway-restapi-name
property parameters
parameters: any;
Custom header parameters for the request.
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;
An array of arbitrary tags (key-value pairs) to associate with the API.
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;
Specifies settings for logging access in this stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-accesslogsetting
property cacheClusterEnabled
cacheClusterEnabled: any;
Indicates whether cache clustering is enabled for the stage.
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-stage.html#cfn-apigateway-stage-cacheclustere