Package software.amazon.awscdk.services.apigatewayv2

Class HttpApiProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigatewayv2.HttpApiProps.Jsii$Proxy
All Implemented Interfaces:
HttpApiProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
HttpApiProps
@Stability(Stable) @Internal public static final class HttpApiProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements HttpApiProps
An implementation for HttpApiProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(HttpApiProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the HttpApiProps.Builder.

  • Method Details

    • getApiName

      public final String getApiName()
      Description copied from interface: HttpApiProps
      Name for the HTTP API resource.

      Default: - id of the HttpApi construct.

      Specified by:
      getApiName in interface HttpApiProps

    • getCorsPreflight

      public final CorsPreflightOptions getCorsPreflight()
      Description copied from interface: HttpApiProps
      Specifies a CORS configuration for an API.

      Default: - CORS disabled.

      Specified by:
      getCorsPreflight in interface HttpApiProps
      See Also:

    • getCreateDefaultStage

      public final Boolean getCreateDefaultStage()
      Description copied from interface: HttpApiProps
      Whether a default stage and deployment should be automatically created.

      Default: true

      Specified by:
      getCreateDefaultStage in interface HttpApiProps

    • getDefaultAuthorizationScopes

      public final List<String> getDefaultAuthorizationScopes()
      Description copied from interface: HttpApiProps
      Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.

      The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation.

      Default: - no default authorization scopes

      Specified by:
      getDefaultAuthorizationScopes in interface HttpApiProps

    • getDefaultAuthorizer

      public final IHttpRouteAuthorizer getDefaultAuthorizer()
      Description copied from interface: HttpApiProps
      Default Authorizer applied to all routes in the gateway.

      Default: - no default authorizer

      Specified by:
      getDefaultAuthorizer in interface HttpApiProps

    • getDefaultDomainMapping

      public final DomainMappingOptions getDefaultDomainMapping()
      Description copied from interface: HttpApiProps
      Configure a custom domain with the API mapping resource to the HTTP API.

      Default: - no default domain mapping configured. meaningless if `createDefaultStage` is `false`.

      Specified by:
      getDefaultDomainMapping in interface HttpApiProps

    • getDefaultIntegration

      public final HttpRouteIntegration getDefaultIntegration()
      Description copied from interface: HttpApiProps
      An integration that will be configured on the catch-all route ($default).

      Default: - none

      Specified by:
      getDefaultIntegration in interface HttpApiProps

    • getDescription

      public final String getDescription()
      Description copied from interface: HttpApiProps
      The description of the API.

      Default: - none

      Specified by:
      getDescription in interface HttpApiProps

    • getDisableExecuteApiEndpoint

      public final Boolean getDisableExecuteApiEndpoint()
      Description copied from interface: HttpApiProps
      Specifies whether clients can invoke your API using the default endpoint.

      By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. Set this to true if you would like clients to use your custom domain name.

      Default: false execute-api endpoint enabled.

      Specified by:
      getDisableExecuteApiEndpoint in interface HttpApiProps

    • getRouteSelectionExpression

      public final Boolean getRouteSelectionExpression()
      Description copied from interface: HttpApiProps
      Whether to set the default route selection expression for the API.

      When enabled, "${request.method} ${request.path}" is set as the default route selection expression.

      Default: false

      Specified by:
      getRouteSelectionExpression in interface HttpApiProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object