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

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigatewayv2.HttpApiProps

HttpApiProps.Builder, HttpApiProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(HttpApiProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the HttpApiProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getApiName()	Name for the HTTP API resource.
final CorsPreflightOptions	getCorsPreflight()	Specifies a CORS configuration for an API.
final Boolean	getCreateDefaultStage()	Whether a default stage and deployment should be automatically created.
final List<String>	getDefaultAuthorizationScopes()	Default OIDC scopes attached to all routes in the gateway, unless explicitly configured on the route.
final IHttpRouteAuthorizer	getDefaultAuthorizer()	Default Authorizer applied to all routes in the gateway.
final DomainMappingOptions	getDefaultDomainMapping()	Configure a custom domain with the API mapping resource to the HTTP API.
final HttpRouteIntegration	getDefaultIntegration()	An integration that will be configured on the catch-all route ($default).
final String	getDescription()	The description of the API.
final Boolean	getDisableExecuteApiEndpoint()	Specifies whether clients can invoke your API using the default endpoint.
final IpAddressType	getIpAddressType()	The IP address types that can invoke the API.
final Boolean	getRouteSelectionExpression()	Whether to set the default route selection expression for the API.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-cors.html

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

getIpAddressType

public final IpAddressType getIpAddressType()

Description copied from interface: HttpApiProps

The IP address types that can invoke the API.

Default: undefined - AWS default is IPV4

Specified by:

getIpAddressType in interface HttpApiProps

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-ip-address-type.html

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