@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)", date="2023-01-31T18:36:56.601Z") public class CfnApi extends CfnResource implements IInspectable
The AWS::ApiGatewayV2::Api
resource creates an API. WebSocket APIs and HTTP APIs are supported. For more information about WebSocket APIs, see About WebSocket APIs in API Gateway in the API Gateway Developer Guide . For more information about HTTP APIs, see HTTP APIs in the API Gateway Developer Guide.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.apigatewayv2.*; Object body; CfnApi cfnApi = CfnApi.Builder.create(this, "MyCfnApi") .apiKeySelectionExpression("apiKeySelectionExpression") .basePath("basePath") .body(body) .bodyS3Location(BodyS3LocationProperty.builder() .bucket("bucket") .etag("etag") .key("key") .version("version") .build()) .corsConfiguration(CorsProperty.builder() .allowCredentials(false) .allowHeaders(List.of("allowHeaders")) .allowMethods(List.of("allowMethods")) .allowOrigins(List.of("allowOrigins")) .exposeHeaders(List.of("exposeHeaders")) .maxAge(123) .build()) .credentialsArn("credentialsArn") .description("description") .disableExecuteApiEndpoint(false) .disableSchemaValidation(false) .failOnWarnings(false) .name("name") .protocolType("protocolType") .routeKey("routeKey") .routeSelectionExpression("routeSelectionExpression") .tags(Map.of( "tagsKey", "tags")) .target("target") .version("version") .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnApi.BodyS3LocationProperty
The `BodyS3Location` property specifies an S3 location from which to import an OpenAPI definition.
|
static class |
CfnApi.Builder
A fluent builder for
CfnApi . |
static interface |
CfnApi.CorsProperty
The `Cors` property specifies a CORS configuration for an API.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnApi(Construct scope,
java.lang.String id)
Create a new `AWS::ApiGatewayV2::Api`.
|
|
CfnApi(Construct scope,
java.lang.String id,
CfnApiProps props)
Create a new `AWS::ApiGatewayV2::Api`.
|
protected |
CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnApi(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApiKeySelectionExpression()
An API key selection expression.
|
java.lang.String |
getAttrApiEndpoint()
The default endpoint for an API.
|
java.lang.String |
getAttrApiId()
The API identifier.
|
java.lang.String |
getBasePath()
Specifies how to interpret the base path of the API during import.
|
java.lang.Object |
getBody()
The OpenAPI definition.
|
java.lang.Object |
getBodyS3Location()
The S3 location of an OpenAPI definition.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getCorsConfiguration()
A CORS configuration.
|
java.lang.String |
getCredentialsArn()
This property is part of quick create.
|
java.lang.String |
getDescription()
The description of the API.
|
java.lang.Object |
getDisableExecuteApiEndpoint()
Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
|
java.lang.Object |
getDisableSchemaValidation()
Avoid validating models when creating a deployment.
|
java.lang.Object |
getFailOnWarnings()
Specifies whether to rollback the API creation when a warning is encountered.
|
java.lang.String |
getName()
The name of the API.
|
java.lang.String |
getProtocolType()
The API protocol.
|
java.lang.String |
getRouteKey()
This property is part of quick create.
|
java.lang.String |
getRouteSelectionExpression()
The route selection expression for the API.
|
TagManager |
getTags()
The collection of tags.
|
java.lang.String |
getTarget()
This property is part of quick create.
|
java.lang.String |
getVersion()
A version identifier for the API.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setApiKeySelectionExpression(java.lang.String value)
An API key selection expression.
|
void |
setBasePath(java.lang.String value)
Specifies how to interpret the base path of the API during import.
|
void |
setBody(java.lang.Object value)
The OpenAPI definition.
|
void |
setBodyS3Location(CfnApi.BodyS3LocationProperty value)
The S3 location of an OpenAPI definition.
|
void |
setBodyS3Location(IResolvable value)
The S3 location of an OpenAPI definition.
|
void |
setCorsConfiguration(CfnApi.CorsProperty value)
A CORS configuration.
|
void |
setCorsConfiguration(IResolvable value)
A CORS configuration.
|
void |
setCredentialsArn(java.lang.String value)
This property is part of quick create.
|
void |
setDescription(java.lang.String value)
The description of the API.
|
void |
setDisableExecuteApiEndpoint(java.lang.Boolean value)
Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
|
void |
setDisableExecuteApiEndpoint(IResolvable value)
Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
|
void |
setDisableSchemaValidation(java.lang.Boolean value)
Avoid validating models when creating a deployment.
|
void |
setDisableSchemaValidation(IResolvable value)
Avoid validating models when creating a deployment.
|
void |
setFailOnWarnings(java.lang.Boolean value)
Specifies whether to rollback the API creation when a warning is encountered.
|
void |
setFailOnWarnings(IResolvable value)
Specifies whether to rollback the API creation when a warning is encountered.
|
void |
setName(java.lang.String value)
The name of the API.
|
void |
setProtocolType(java.lang.String value)
The API protocol.
|
void |
setRouteKey(java.lang.String value)
This property is part of quick create.
|
void |
setRouteSelectionExpression(java.lang.String value)
The route selection expression for the API.
|
void |
setTarget(java.lang.String value)
This property is part of quick create.
|
void |
setVersion(java.lang.String value)
A version identifier for the API.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnApi(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnApi(Construct scope, java.lang.String id, CfnApiProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties.public CfnApi(Construct scope, java.lang.String id)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrApiEndpoint()
For example: https://abcdef.execute-api.us-west-2.amazonaws.com
.
public java.lang.String getAttrApiId()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
Each tag element is associated with a given resource.
public java.lang.Object getBody()
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body
or BodyS3Location
. If you specify a Body
or BodyS3Location
, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer
or AWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
public void setBody(java.lang.Object value)
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body
or BodyS3Location
. If you specify a Body
or BodyS3Location
, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer
or AWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
public java.lang.String getApiKeySelectionExpression()
Supported only for WebSocket APIs. See API Key Selection Expressions .
public void setApiKeySelectionExpression(java.lang.String value)
Supported only for WebSocket APIs. See API Key Selection Expressions .
public java.lang.String getBasePath()
Valid values are ignore
, prepend
, and split
. The default value is ignore
. To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.
public void setBasePath(java.lang.String value)
Valid values are ignore
, prepend
, and split
. The default value is ignore
. To learn more, see Set the OpenAPI basePath Property . Supported only for HTTP APIs.
public java.lang.Object getBodyS3Location()
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body
or BodyS3Location
. If you specify a Body
or BodyS3Location
, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer
or AWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
public void setBodyS3Location(IResolvable value)
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body
or BodyS3Location
. If you specify a Body
or BodyS3Location
, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer
or AWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
public void setBodyS3Location(CfnApi.BodyS3LocationProperty value)
Supported only for HTTP APIs. To import an HTTP API, you must specify a Body
or BodyS3Location
. If you specify a Body
or BodyS3Location
, don't specify CloudFormation resources such as AWS::ApiGatewayV2::Authorizer
or AWS::ApiGatewayV2::Route
. API Gateway doesn't support the combination of OpenAPI and CloudFormation resources.
public java.lang.Object getCorsConfiguration()
Supported only for HTTP APIs. See Configuring CORS for more information.
public void setCorsConfiguration(IResolvable value)
Supported only for HTTP APIs. See Configuring CORS for more information.
public void setCorsConfiguration(CfnApi.CorsProperty value)
Supported only for HTTP APIs. See Configuring CORS for more information.
public java.lang.String getCredentialsArn()
It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*
. To use resource-based permissions on supported AWS services, specify null
. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
public void setCredentialsArn(java.lang.String value)
It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*
. To use resource-based permissions on supported AWS services, specify null
. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.
public java.lang.String getDescription()
public void setDescription(java.lang.String value)
public java.lang.Object getDisableExecuteApiEndpoint()
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.
public void setDisableExecuteApiEndpoint(java.lang.Boolean value)
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.
public void setDisableExecuteApiEndpoint(IResolvable value)
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.
public java.lang.Object getDisableSchemaValidation()
Supported only for WebSocket APIs.
public void setDisableSchemaValidation(java.lang.Boolean value)
Supported only for WebSocket APIs.
public void setDisableSchemaValidation(IResolvable value)
Supported only for WebSocket APIs.
public java.lang.Object getFailOnWarnings()
By default, API creation continues if a warning is encountered.
public void setFailOnWarnings(java.lang.Boolean value)
By default, API creation continues if a warning is encountered.
public void setFailOnWarnings(IResolvable value)
By default, API creation continues if a warning is encountered.
public java.lang.String getName()
Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
public void setName(java.lang.String value)
Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
public java.lang.String getProtocolType()
Valid values are WEBSOCKET
or HTTP
. Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
public void setProtocolType(java.lang.String value)
Valid values are WEBSOCKET
or HTTP
. Required unless you specify an OpenAPI definition for Body
or S3BodyLocation
.
public java.lang.String getRouteKey()
If you don't specify a routeKey
, a default route of $default
is created. The $default
route acts as a catch-all for any request made to your API, for a particular stage. The $default
route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
public void setRouteKey(java.lang.String value)
If you don't specify a routeKey
, a default route of $default
is created. The $default
route acts as a catch-all for any request made to your API, for a particular stage. The $default
route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.
public java.lang.String getRouteSelectionExpression()
For HTTP APIs, the routeSelectionExpression
must be ${request.method} ${request.path}
. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
public void setRouteSelectionExpression(java.lang.String value)
For HTTP APIs, the routeSelectionExpression
must be ${request.method} ${request.path}
. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
public java.lang.String getTarget()
Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
public void setTarget(java.lang.String value)
Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.
public java.lang.String getVersion()
public void setVersion(java.lang.String value)