Package software.amazon.awscdk.services.apigatewayv2

Class CfnApiProps.Jsii$Proxy

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

  • 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(CfnApiProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnApiProps.Builder.

  • Method Details

    • getApiKeySelectionExpression

      public final String getApiKeySelectionExpression()
      Description copied from interface: CfnApiProps
      An API key selection expression.

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

      Specified by:
      getApiKeySelectionExpression in interface CfnApiProps

    • getBasePath

      public final String getBasePath()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getBasePath in interface CfnApiProps

    • getBody

      public final Object getBody()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getBody in interface CfnApiProps

    • getBodyS3Location

      public final Object getBodyS3Location()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getBodyS3Location in interface CfnApiProps

    • getCorsConfiguration

      public final Object getCorsConfiguration()
      Description copied from interface: CfnApiProps
      A CORS configuration.

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

      Specified by:
      getCorsConfiguration in interface CfnApiProps

    • getCredentialsArn

      public final String getCredentialsArn()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getCredentialsArn in interface CfnApiProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnApiProps
      The description of the API.
      Specified by:
      getDescription in interface CfnApiProps

    • getDisableExecuteApiEndpoint

      public final Object getDisableExecuteApiEndpoint()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getDisableExecuteApiEndpoint in interface CfnApiProps

    • getDisableSchemaValidation

      public final Object getDisableSchemaValidation()
      Description copied from interface: CfnApiProps
      Avoid validating models when creating a deployment.

      Supported only for WebSocket APIs.

      Specified by:
      getDisableSchemaValidation in interface CfnApiProps

    • getFailOnWarnings

      public final Object getFailOnWarnings()
      Description copied from interface: CfnApiProps
      Specifies whether to rollback the API creation when a warning is encountered.

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

      Specified by:
      getFailOnWarnings in interface CfnApiProps

    • getName

      public final String getName()
      Description copied from interface: CfnApiProps
      The name of the API.

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

      Specified by:
      getName in interface CfnApiProps

    • getProtocolType

      public final String getProtocolType()
      Description copied from interface: CfnApiProps
      The API protocol.

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

      Specified by:
      getProtocolType in interface CfnApiProps

    • getRouteKey

      public final String getRouteKey()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getRouteKey in interface CfnApiProps

    • getRouteSelectionExpression

      public final String getRouteSelectionExpression()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getRouteSelectionExpression in interface CfnApiProps

    • getTags

      public final Map<String,String> getTags()
      Description copied from interface: CfnApiProps
      The collection of tags.

      Each tag element is associated with a given resource.

      Specified by:
      getTags in interface CfnApiProps

    • getTarget

      public final String getTarget()
      Description copied from interface: CfnApiProps
      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.

      Specified by:
      getTarget in interface CfnApiProps

    • getVersion

      public final String getVersion()
      Description copied from interface: CfnApiProps
      A version identifier for the API.
      Specified by:
      getVersion in interface CfnApiProps

    • $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