LambdaRestApiProps.Jsii$Proxy

java.lang.Object
- software.amazon.jsii.JsiiObject
- - software.amazon.awscdk.services.apigateway.LambdaRestApiProps.Jsii$Proxy

All Implemented Interfaces:

LambdaRestApiProps, ResourceOptions, RestApiBaseProps, RestApiOptions, RestApiProps

Enclosing interface:

LambdaRestApiProps
```
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 interface software.amazon.awscdk.services.apigateway.LambdaRestApiProps
  LambdaRestApiProps.Builder, LambdaRestApiProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(java.lang.Object o)`
`ApiKeySourceType`	`getApiKeySourceType()` The source of the API key for metering requests according to a usage plan.
`java.util.List<java.lang.String>`	`getBinaryMediaTypes()` The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
`IRestApi`	`getCloneFrom()` The ID of the API Gateway RestApi resource that you want to clone.
`java.lang.Boolean`	`getCloudWatchRole()` Automatically configure an AWS CloudWatch role for API Gateway.
`CorsOptions`	`getDefaultCorsPreflightOptions()` Adds a CORS preflight OPTIONS method to this resource and all child resources.
`Integration`	`getDefaultIntegration()` An integration to use as a default for all methods created within this API unless an integration is specified.
`MethodOptions`	`getDefaultMethodOptions()` Method options to use as a default for all methods created within this API unless custom options are specified.
`java.lang.Boolean`	`getDeploy()` Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
`StageOptions`	`getDeployOptions()` Options for the API Gateway stage that will always point to the latest deployment when `deploy` is enabled.
`java.lang.String`	`getDescription()` A description of the purpose of this API Gateway RestApi resource.
`java.lang.Boolean`	`getDisableExecuteApiEndpoint()` Specifies whether clients can invoke the API using the default execute-api endpoint.
`DomainNameOptions`	`getDomainName()` Configure a custom domain name and map it to this API.
`EndpointConfiguration`	`getEndpointConfiguration()` The EndpointConfiguration property type specifies the endpoint types of a REST API.
`java.lang.String`	`getEndpointExportName()` Export name for the CfnOutput containing the API endpoint.
`java.util.List<EndpointType>`	`getEndpointTypes()` A list of the endpoint types of the API.
`java.lang.Boolean`	`getFailOnWarnings()` Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
`IFunction`	`getHandler()` The default Lambda function that handles all requests from this API.
`java.lang.Number`	`getMinimumCompressionSize()` 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.
`RestApiProps`	`getOptions()` Default: - no options.
`java.util.Map<java.lang.String,java.lang.String>`	`getParameters()` Custom header parameters for the request.
`PolicyDocument`	`getPolicy()` A policy document that contains the permissions for this RestApi.
`java.lang.Boolean`	`getProxy()` If true, route all requests to the Lambda Function.
`java.lang.String`	`getRestApiName()` A name for the API Gateway RestApi resource.
`java.lang.Boolean`	`getRetainDeployments()` Retains old deployment resources when the API changes.
`int`	`hashCode()`

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.
- Method Detail
  - getHandler
```
public final IFunction getHandler()
```
    Description copied from interface: LambdaRestApiProps
    
    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
  - getOptions
```
public final RestApiProps getOptions()
```
    Description copied from interface: LambdaRestApiProps
    
    Default: - no options.
    
    Specified by:
    
    getOptions in interface LambdaRestApiProps
  - getProxy
```
public final java.lang.Boolean getProxy()
```
    Description copied from interface: LambdaRestApiProps
    
    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
    
    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 java.util.List<java.lang.String> getBinaryMediaTypes()
```
    Description copied from interface: RestApiProps
    
    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
    
    The ID of the API Gateway RestApi resource that you want to clone.
    Default: - None.
    
    Specified by:
    
    getCloneFrom in interface RestApiProps
  - getDescription
```
public final java.lang.String getDescription()
```
    Description copied from interface: RestApiProps
    
    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
    
    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 java.lang.Number getMinimumCompressionSize()
```
    Description copied from interface: RestApiProps
    
    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
  - getCloudWatchRole
```
public final java.lang.Boolean getCloudWatchRole()
```
    Description copied from interface: RestApiBaseProps
    
    Automatically configure an AWS CloudWatch role for API Gateway.
    Default: true
    
    Specified by:
    
    getCloudWatchRole in interface RestApiBaseProps
  - getDeploy
```
public final java.lang.Boolean getDeploy()
```
    Description copied from interface: RestApiBaseProps
    
    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
    
    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
  - getDisableExecuteApiEndpoint
```
public final java.lang.Boolean getDisableExecuteApiEndpoint()
```
    Description copied from interface: RestApiBaseProps
    
    Specifies whether clients can invoke the API using the default execute-api endpoint.
    To require that clients use a custom domain name to invoke the API, disable the default endpoint.
    Default: false
    
    Specified by:
    
    getDisableExecuteApiEndpoint in interface RestApiBaseProps
    
    See Also:
    
    https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apigateway-restapi.html
  - getDomainName
```
public final DomainNameOptions getDomainName()
```
    Description copied from interface: RestApiBaseProps
    
    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 java.lang.String getEndpointExportName()
```
    Description copied from interface: RestApiBaseProps
    
    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 java.util.List<EndpointType> getEndpointTypes()
```
    Description copied from interface: RestApiBaseProps
    
    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 java.lang.Boolean getFailOnWarnings()
```
    Description copied from interface: RestApiBaseProps
    
    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 java.util.Map<java.lang.String,java.lang.String> getParameters()
```
    Description copied from interface: RestApiBaseProps
    
    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
    
    A policy document that contains the permissions for this RestApi.
    Default: - No policy.
    
    Specified by:
    
    getPolicy in interface RestApiBaseProps
  - getRestApiName
```
public final java.lang.String getRestApiName()
```
    Description copied from interface: RestApiBaseProps
    
    A name for the API Gateway RestApi resource.
    Default: - ID of the RestApi construct.
    
    Specified by:
    
    getRestApiName in interface RestApiBaseProps
  - getRetainDeployments
```
public final java.lang.Boolean getRetainDeployments()
```
    Description copied from interface: RestApiBaseProps
    
    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
  - getDefaultCorsPreflightOptions
```
public final CorsOptions getDefaultCorsPreflightOptions()
```
    Description copied from interface: ResourceOptions
    
    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
    
    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
    
    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
  - $jsii$toJson
```
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
  - equals
```
public final boolean equals(java.lang.Object o)
```
  - hashCode
```
public final int hashCode()
```

Class LambdaRestApiProps.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.LambdaRestApiProps

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Method Detail

getHandler

getOptions

getProxy

getApiKeySourceType

getBinaryMediaTypes

getCloneFrom

getDescription

getEndpointConfiguration

getMinimumCompressionSize

getCloudWatchRole

getDeploy

getDeployOptions

getDisableExecuteApiEndpoint

getDomainName

getEndpointExportName

getEndpointTypes

getFailOnWarnings

getParameters

getPolicy

getRestApiName

getRetainDeployments

getDefaultCorsPreflightOptions

getDefaultIntegration

getDefaultMethodOptions

$jsii$toJson

equals

hashCode