Package software.amazon.awscdk.services.apigatewayv2

Class CfnApiProps.Builder

java.lang.Object
software.amazon.awscdk.services.apigatewayv2.CfnApiProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnApiProps>
Enclosing interface:
CfnApiProps
@Stability(Stable) public static final class CfnApiProps.Builder extends Object implements software.amazon.jsii.Builder<CfnApiProps>
A builder for CfnApiProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiKeySelectionExpression

      @Stability(Stable) public CfnApiProps.Builder apiKeySelectionExpression(String apiKeySelectionExpression)
      Sets the value of CfnApiProps.getApiKeySelectionExpression()
      Parameters:
      apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions .
      Returns:
      this

    • basePath

      @Stability(Stable) public CfnApiProps.Builder basePath(String basePath)
      Sets the value of CfnApiProps.getBasePath()
      Parameters:
      basePath - 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.
      Returns:
      this

    • body

      @Stability(Stable) public CfnApiProps.Builder body(Object body)
      Sets the value of CfnApiProps.getBody()
      Parameters:
      body - 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.
      Returns:
      this

    • bodyS3Location

      @Stability(Stable) public CfnApiProps.Builder bodyS3Location(IResolvable bodyS3Location)
      Sets the value of CfnApiProps.getBodyS3Location()
      Parameters:
      bodyS3Location - 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.
      Returns:
      this

    • bodyS3Location

      @Stability(Stable) public CfnApiProps.Builder bodyS3Location(CfnApi.BodyS3LocationProperty bodyS3Location)
      Sets the value of CfnApiProps.getBodyS3Location()
      Parameters:
      bodyS3Location - 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.
      Returns:
      this

    • corsConfiguration

      @Stability(Stable) public CfnApiProps.Builder corsConfiguration(IResolvable corsConfiguration)
      Sets the value of CfnApiProps.getCorsConfiguration()
      Parameters:
      corsConfiguration - A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
      Returns:
      this

    • corsConfiguration

      @Stability(Stable) public CfnApiProps.Builder corsConfiguration(CfnApi.CorsProperty corsConfiguration)
      Sets the value of CfnApiProps.getCorsConfiguration()
      Parameters:
      corsConfiguration - A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
      Returns:
      this

    • credentialsArn

      @Stability(Stable) public CfnApiProps.Builder credentialsArn(String credentialsArn)
      Sets the value of CfnApiProps.getCredentialsArn()
      Parameters:
      credentialsArn - 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.
      Returns:
      this

    • description

      @Stability(Stable) public CfnApiProps.Builder description(String description)
      Sets the value of CfnApiProps.getDescription()
      Parameters:
      description - The description of the API.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
      Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
      Parameters:
      disableExecuteApiEndpoint - 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.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnApiProps.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
      Sets the value of CfnApiProps.getDisableExecuteApiEndpoint()
      Parameters:
      disableExecuteApiEndpoint - 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.
      Returns:
      this

    • disableSchemaValidation

      @Stability(Stable) public CfnApiProps.Builder disableSchemaValidation(Boolean disableSchemaValidation)
      Sets the value of CfnApiProps.getDisableSchemaValidation()
      Parameters:
      disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      Returns:
      this

    • disableSchemaValidation

      @Stability(Stable) public CfnApiProps.Builder disableSchemaValidation(IResolvable disableSchemaValidation)
      Sets the value of CfnApiProps.getDisableSchemaValidation()
      Parameters:
      disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
      Returns:
      this

    • failOnWarnings

      @Stability(Stable) public CfnApiProps.Builder failOnWarnings(Boolean failOnWarnings)
      Sets the value of CfnApiProps.getFailOnWarnings()
      Parameters:
      failOnWarnings - Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
      Returns:
      this

    • failOnWarnings

      @Stability(Stable) public CfnApiProps.Builder failOnWarnings(IResolvable failOnWarnings)
      Sets the value of CfnApiProps.getFailOnWarnings()
      Parameters:
      failOnWarnings - Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
      Returns:
      this

    • name

      @Stability(Stable) public CfnApiProps.Builder name(String name)
      Sets the value of CfnApiProps.getName()
      Parameters:
      name - The name of the API. Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
      Returns:
      this

    • protocolType

      @Stability(Stable) public CfnApiProps.Builder protocolType(String protocolType)
      Sets the value of CfnApiProps.getProtocolType()
      Parameters:
      protocolType - The API protocol. Valid values are WEBSOCKET or HTTP . Required unless you specify an OpenAPI definition for Body or S3BodyLocation .
      Returns:
      this

    • routeKey

      @Stability(Stable) public CfnApiProps.Builder routeKey(String routeKey)
      Sets the value of CfnApiProps.getRouteKey()
      Parameters:
      routeKey - 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.
      Returns:
      this

    • routeSelectionExpression

      @Stability(Stable) public CfnApiProps.Builder routeSelectionExpression(String routeSelectionExpression)
      Sets the value of CfnApiProps.getRouteSelectionExpression()
      Parameters:
      routeSelectionExpression - 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.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnApiProps.Builder tags(Map<String,String> tags)
      Sets the value of CfnApiProps.getTags()
      Parameters:
      tags - The collection of tags. Each tag element is associated with a given resource.
      Returns:
      this

    • target

      @Stability(Stable) public CfnApiProps.Builder target(String target)
      Sets the value of CfnApiProps.getTarget()
      Parameters:
      target - 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.
      Returns:
      this

    • version

      @Stability(Stable) public CfnApiProps.Builder version(String version)
      Sets the value of CfnApiProps.getVersion()
      Parameters:
      version - A version identifier for the API.
      Returns:
      this

    • build

      @Stability(Stable) public CfnApiProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnApiProps>
      Returns:
      a new instance of CfnApiProps
      Throws:
      NullPointerException - if any required attribute was not provided