software.amazon.awscdk.services.apigateway

Class LambdaRestApiProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.LambdaRestApiProps.Jsii$Proxy

All Implemented Interfaces:

LambdaRestApiProps, ResourceOptions, RestApiBaseProps, RestApiProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

LambdaRestApiProps

@Stability(value=Experimental)
 @Internal
public static final class LambdaRestApiProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements LambdaRestApiProps

An implementation for LambdaRestApiProps

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.apigateway.LambdaRestApiProps

LambdaRestApiProps.Builder, LambdaRestApiProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(IFunction handler, Boolean proxy, ApiKeySourceType apiKeySourceType, List<String> binaryMediaTypes, IRestApi cloneFrom, String description, EndpointConfiguration endpointConfiguration, Number minimumCompressionSize, CorsOptions defaultCorsPreflightOptions, Integration defaultIntegration, MethodOptions defaultMethodOptions, Boolean cloudWatchRole, Boolean deploy, StageOptions deployOptions, DomainNameOptions domainName, String endpointExportName, List<? extends EndpointType> endpointTypes, Boolean failOnWarnings, Map<String,String> parameters, PolicyDocument policy, String restApiName, Boolean retainDeployments) Constructor that initializes the object based on literal property values passed by the LambdaRestApiProps.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 and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
ApiKeySourceType	getApiKeySourceType() (experimental) The source of the API key for metering requests according to a usage plan.
List<String>	getBinaryMediaTypes() (experimental) The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
IRestApi	getCloneFrom() (experimental) The ID of the API Gateway RestApi resource that you want to clone.
Boolean	getCloudWatchRole() (experimental) Automatically configure an AWS CloudWatch role for API Gateway.
CorsOptions	getDefaultCorsPreflightOptions() (experimental) Adds a CORS preflight OPTIONS method to this resource and all child resources.
Integration	getDefaultIntegration() (experimental) An integration to use as a default for all methods created within this API unless an integration is specified.
MethodOptions	getDefaultMethodOptions() (experimental) Method options to use as a default for all methods created within this API unless custom options are specified.
Boolean	getDeploy() (experimental) Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
StageOptions	getDeployOptions() (experimental) Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
String	getDescription() (experimental) A description of the purpose of this API Gateway RestApi resource.
DomainNameOptions	getDomainName() (experimental) Configure a custom domain name and map it to this API.
EndpointConfiguration	getEndpointConfiguration() (experimental) The EndpointConfiguration property type specifies the endpoint types of a REST API.
String	getEndpointExportName() (experimental) Export name for the CfnOutput containing the API endpoint.
List<EndpointType>	getEndpointTypes() (experimental) A list of the endpoint types of the API.
Boolean	getFailOnWarnings() (experimental) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
IFunction	getHandler() (experimental) The default Lambda function that handles all requests from this API.
Number	getMinimumCompressionSize() (experimental) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.
Map<String,String>	getParameters() (experimental) Custom header parameters for the request.
PolicyDocument	getPolicy() (experimental) A policy document that contains the permissions for this RestApi.
Boolean	getProxy() (experimental) If true, route all requests to the Lambda Function.
String	getRestApiName() (experimental) A name for the API Gateway RestApi resource.
Boolean	getRetainDeployments() (experimental) Retains old deployment resources when the API changes.
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

Methods inherited from interface software.amazon.awscdk.services.apigateway.LambdaRestApiProps

builder

Constructor Detail

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(IFunction handler,
                     Boolean proxy,
                     ApiKeySourceType apiKeySourceType,
                     List<String> binaryMediaTypes,
                     IRestApi cloneFrom,
                     String description,
                     EndpointConfiguration endpointConfiguration,
                     Number minimumCompressionSize,
                     CorsOptions defaultCorsPreflightOptions,
                     Integration defaultIntegration,
                     MethodOptions defaultMethodOptions,
                     Boolean cloudWatchRole,
                     Boolean deploy,
                     StageOptions deployOptions,
                     DomainNameOptions domainName,
                     String endpointExportName,
                     List<? extends EndpointType> endpointTypes,
                     Boolean failOnWarnings,
                     Map<String,String> parameters,
                     PolicyDocument policy,
                     String restApiName,
                     Boolean retainDeployments)

Constructor that initializes the object based on literal property values passed by the LambdaRestApiProps.Builder.

Method Detail

getHandler

public final IFunction getHandler()

Description copied from interface: LambdaRestApiProps

(experimental) The default Lambda function that handles all requests from this API.

This handler will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

Specified by:

getHandler in interface LambdaRestApiProps

getProxy

public final Boolean getProxy()

Description copied from interface: LambdaRestApiProps

(experimental) If true, route all requests to the Lambda Function.

If set to false, you will need to explicitly define the API model using addResource and addMethod (or addProxy).

Default: true

Specified by:

getProxy in interface LambdaRestApiProps

getApiKeySourceType

public final ApiKeySourceType getApiKeySourceType()

Description copied from interface: RestApiProps

(experimental) The source of the API key for metering requests according to a usage plan.

Default: - Metering is disabled.

Specified by:

getApiKeySourceType in interface RestApiProps

getBinaryMediaTypes

public final List<String> getBinaryMediaTypes()

Description copied from interface: RestApiProps

(experimental) The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".

Default: - RestApi supports only UTF-8-encoded text payloads.

Specified by:

getBinaryMediaTypes in interface RestApiProps

getCloneFrom

public final IRestApi getCloneFrom()

Description copied from interface: RestApiProps

(experimental) The ID of the API Gateway RestApi resource that you want to clone.

Default: - None.

Specified by:

getCloneFrom in interface RestApiProps

getDescription

public final String getDescription()

Description copied from interface: RestApiProps

(experimental) A description of the purpose of this API Gateway RestApi resource.

Default: - No description.

Specified by:

getDescription in interface RestApiProps

getEndpointConfiguration

public final EndpointConfiguration getEndpointConfiguration()

Description copied from interface: RestApiProps

(experimental) The EndpointConfiguration property type specifies the endpoint types of a REST API.

Default: EndpointType.EDGE

Specified by:

getEndpointConfiguration in interface RestApiProps

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigateway-restapi-endpointconfiguration.html

getMinimumCompressionSize

public final Number getMinimumCompressionSize()

Description copied from interface: RestApiProps

(experimental) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) on an API.

When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Default: - Compression is disabled.

Specified by:

getMinimumCompressionSize in interface RestApiProps

getDefaultCorsPreflightOptions

public final CorsOptions getDefaultCorsPreflightOptions()

Description copied from interface: ResourceOptions

(experimental) Adds a CORS preflight OPTIONS method to this resource and all child resources.

You can add CORS at the resource-level using addCorsPreflight.

Default: - CORS is disabled

Specified by:

getDefaultCorsPreflightOptions in interface ResourceOptions

getDefaultIntegration

public final Integration getDefaultIntegration()

Description copied from interface: ResourceOptions

(experimental) An integration to use as a default for all methods created within this API unless an integration is specified.

Default: - Inherited from parent.

Specified by:

getDefaultIntegration in interface ResourceOptions

getDefaultMethodOptions

public final MethodOptions getDefaultMethodOptions()

Description copied from interface: ResourceOptions

(experimental) Method options to use as a default for all methods created within this API unless custom options are specified.

Default: - Inherited from parent.

Specified by:

getDefaultMethodOptions in interface ResourceOptions

getCloudWatchRole

public final Boolean getCloudWatchRole()

Description copied from interface: RestApiBaseProps

(experimental) Automatically configure an AWS CloudWatch role for API Gateway.

Default: true

Specified by:

getCloudWatchRole in interface RestApiBaseProps

getDeploy

public final Boolean getDeploy()

Description copied from interface: RestApiBaseProps

(experimental) Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.

Since API Gateway deployments are immutable, When this option is enabled (by default), an AWS::ApiGateway::Deployment resource will automatically created with a logical ID that hashes the API model (methods, resources and options). This means that when the model changes, the logical ID of this CloudFormation resource will change, and a new deployment will be created.

If this is set, latestDeployment will refer to the Deployment object and deploymentStage will refer to a Stage that points to this deployment. To customize the stage options, use the deployOptions property.

A CloudFormation Output will also be defined with the root URL endpoint of this REST API.

Default: true

Specified by:

getDeploy in interface RestApiBaseProps

getDeployOptions

public final StageOptions getDeployOptions()

Description copied from interface: RestApiBaseProps

(experimental) Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.

If deploy is disabled, this value cannot be set.

Default: - Based on defaults of `StageOptions`.

Specified by:

getDeployOptions in interface RestApiBaseProps

getDomainName

public final DomainNameOptions getDomainName()

Description copied from interface: RestApiBaseProps

(experimental) Configure a custom domain name and map it to this API.

Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.

Specified by:

getDomainName in interface RestApiBaseProps

getEndpointExportName

public final String getEndpointExportName()

Description copied from interface: RestApiBaseProps

(experimental) Export name for the CfnOutput containing the API endpoint.

Default: - when no export name is given, output will be created without export

Specified by:

getEndpointExportName in interface RestApiBaseProps

getEndpointTypes

public final List<EndpointType> getEndpointTypes()

Description copied from interface: RestApiBaseProps

(experimental) A list of the endpoint types of the API.

Use this property when creating an API.

Default: EndpointType.EDGE

Specified by:

getEndpointTypes in interface RestApiBaseProps

getFailOnWarnings

public final Boolean getFailOnWarnings()

Description copied from interface: RestApiBaseProps

(experimental) Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

Default: false

Specified by:

getFailOnWarnings in interface RestApiBaseProps

getParameters

public final Map<String,String> getParameters()

Description copied from interface: RestApiBaseProps

(experimental) Custom header parameters for the request.

Default: - No parameters.

Specified by:

getParameters in interface RestApiBaseProps

See Also:

https://docs.aws.amazon.com/cli/latest/reference/apigateway/import-rest-api.html

getPolicy

public final PolicyDocument getPolicy()

Description copied from interface: RestApiBaseProps

(experimental) A policy document that contains the permissions for this RestApi.

Default: - No policy.

Specified by:

getPolicy in interface RestApiBaseProps

getRestApiName

public final String getRestApiName()

Description copied from interface: RestApiBaseProps

(experimental) A name for the API Gateway RestApi resource.

Default: - ID of the RestApi construct.

Specified by:

getRestApiName in interface RestApiBaseProps

getRetainDeployments

public final Boolean getRetainDeployments()

Description copied from interface: RestApiBaseProps

(experimental) Retains old deployment resources when the API changes.

This allows manually reverting stages to point to old deployments via the AWS Console.

Default: false

Specified by:

getRetainDeployments in interface RestApiBaseProps

$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