Package software.amazon.awscdk.services.apigatewayv2

Class CfnApi

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.apigatewayv2.CfnApi
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:43.136Z") @Stability(Stable) public class CfnApi extends CfnResource implements IInspectable
A CloudFormation AWS::ApiGatewayV2::Api.

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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnApi

      protected CfnApi(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnApi

      protected CfnApi(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnApi

      @Stability(Stable) public CfnApi(@NotNull Construct scope, @NotNull String id, @Nullable CfnApiProps props)
      Create a new AWS::ApiGatewayV2::Api.

      Parameters:
      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.

    • CfnApi

      @Stability(Stable) public CfnApi(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::ApiGatewayV2::Api.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrApiEndpoint

      @Stability(Stable) @NotNull public String getAttrApiEndpoint()
      The default endpoint for an API.

      For example: https://abcdef.execute-api.us-west-2.amazonaws.com .

    • getAttrApiId

      @Stability(Stable) @NotNull public String getAttrApiId()
      The API identifier.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The collection of tags.

      Each tag element is associated with a given resource.

    • getBody

      @Stability(Stable) @NotNull public Object getBody()
      The OpenAPI definition.

      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.

    • setBody

      @Stability(Stable) public void setBody(@NotNull Object value)
      The OpenAPI definition.

      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.

    • getApiKeySelectionExpression

      @Stability(Stable) @Nullable public String getApiKeySelectionExpression()
      An API key selection expression.

      Supported only for WebSocket APIs. See API Key Selection Expressions .

    • setApiKeySelectionExpression

      @Stability(Stable) public void setApiKeySelectionExpression(@Nullable String value)
      An API key selection expression.

      Supported only for WebSocket APIs. See API Key Selection Expressions .

    • getBasePath

      @Stability(Stable) @Nullable public String getBasePath()
      Specifies how to interpret the base path of the API during import.

      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.

    • setBasePath

      @Stability(Stable) public void setBasePath(@Nullable String value)
      Specifies how to interpret the base path of the API during import.

      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.

    • getBodyS3Location

      @Stability(Stable) @Nullable public Object getBodyS3Location()
      The S3 location of an OpenAPI definition.

      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.

    • setBodyS3Location

      @Stability(Stable) public void setBodyS3Location(@Nullable IResolvable value)
      The S3 location of an OpenAPI definition.

      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.

    • setBodyS3Location

      @Stability(Stable) public void setBodyS3Location(@Nullable CfnApi.BodyS3LocationProperty value)
      The S3 location of an OpenAPI definition.

      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.

    • getCorsConfiguration

      @Stability(Stable) @Nullable public Object getCorsConfiguration()
      A CORS configuration.

      Supported only for HTTP APIs. See Configuring CORS for more information.

    • setCorsConfiguration

      @Stability(Stable) public void setCorsConfiguration(@Nullable IResolvable value)
      A CORS configuration.

      Supported only for HTTP APIs. See Configuring CORS for more information.

    • setCorsConfiguration

      @Stability(Stable) public void setCorsConfiguration(@Nullable CfnApi.CorsProperty value)
      A CORS configuration.

      Supported only for HTTP APIs. See Configuring CORS for more information.

    • getCredentialsArn

      @Stability(Stable) @Nullable public String getCredentialsArn()
      This property is part of quick create.

      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.

    • setCredentialsArn

      @Stability(Stable) public void setCredentialsArn(@Nullable String value)
      This property is part of quick create.

      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.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the API.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the API.

    • getDisableExecuteApiEndpoint

      @Stability(Stable) @Nullable public Object getDisableExecuteApiEndpoint()
      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.

    • setDisableExecuteApiEndpoint

      @Stability(Stable) public void setDisableExecuteApiEndpoint(@Nullable Boolean value)
      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.

    • setDisableExecuteApiEndpoint

      @Stability(Stable) public void setDisableExecuteApiEndpoint(@Nullable IResolvable value)
      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.

    • getDisableSchemaValidation

      @Stability(Stable) @Nullable public Object getDisableSchemaValidation()
      Avoid validating models when creating a deployment.

      Supported only for WebSocket APIs.

    • setDisableSchemaValidation

      @Stability(Stable) public void setDisableSchemaValidation(@Nullable Boolean value)
      Avoid validating models when creating a deployment.

      Supported only for WebSocket APIs.

    • setDisableSchemaValidation

      @Stability(Stable) public void setDisableSchemaValidation(@Nullable IResolvable value)
      Avoid validating models when creating a deployment.

      Supported only for WebSocket APIs.

    • getFailOnWarnings

      @Stability(Stable) @Nullable public Object getFailOnWarnings()
      Specifies whether to rollback the API creation when a warning is encountered.

      By default, API creation continues if a warning is encountered.

    • setFailOnWarnings

      @Stability(Stable) public void setFailOnWarnings(@Nullable Boolean value)
      Specifies whether to rollback the API creation when a warning is encountered.

      By default, API creation continues if a warning is encountered.

    • setFailOnWarnings

      @Stability(Stable) public void setFailOnWarnings(@Nullable IResolvable value)
      Specifies whether to rollback the API creation when a warning is encountered.

      By default, API creation continues if a warning is encountered.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the API.

      Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the API.

      Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

    • getProtocolType

      @Stability(Stable) @Nullable public String getProtocolType()
      The API protocol.

      Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

    • setProtocolType

      @Stability(Stable) public void setProtocolType(@Nullable String value)
      The API protocol.

      Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .

    • getRouteKey

      @Stability(Stable) @Nullable public String getRouteKey()
      This property is part of quick create.

      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.

    • setRouteKey

      @Stability(Stable) public void setRouteKey(@Nullable String value)
      This property is part of quick create.

      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.

    • getRouteSelectionExpression

      @Stability(Stable) @Nullable public String getRouteSelectionExpression()
      The route selection expression for the API.

      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.

    • setRouteSelectionExpression

      @Stability(Stable) public void setRouteSelectionExpression(@Nullable String value)
      The route selection expression for the API.

      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.

    • getTarget

      @Stability(Stable) @Nullable public String getTarget()
      This property is part of quick create.

      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.

    • setTarget

      @Stability(Stable) public void setTarget(@Nullable String value)
      This property is part of quick create.

      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.

    • getVersion

      @Stability(Stable) @Nullable public String getVersion()
      A version identifier for the API.

    • setVersion

      @Stability(Stable) public void setVersion(@Nullable String value)
      A version identifier for the API.