public static final class LambdaRestApiProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements LambdaRestApiProps
LambdaRestApiProps
LambdaRestApiProps.Builder, LambdaRestApiProps.Jsii$Proxy
Modifier | Constructor and Description |
---|---|
protected |
Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
Constructor that initializes the object based on values retrieved from the JsiiObject.
|
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() |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
builder
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
objRef
- Reference to the JSII managed object.public final IFunction getHandler()
LambdaRestApiProps
This handler will be used as a the default integration for all methods in
this API, unless specified otherwise in addMethod
.
getHandler
in interface LambdaRestApiProps
public final RestApiProps getOptions()
LambdaRestApiProps
getOptions
in interface LambdaRestApiProps
public final java.lang.Boolean getProxy()
LambdaRestApiProps
If set to false, you will need to explicitly define the API model using
addResource
and addMethod
(or addProxy
).
Default: true
getProxy
in interface LambdaRestApiProps
public final ApiKeySourceType getApiKeySourceType()
RestApiProps
Default: - Metering is disabled.
getApiKeySourceType
in interface RestApiProps
public final java.util.List<java.lang.String> getBinaryMediaTypes()
RestApiProps
Default: - RestApi supports only UTF-8-encoded text payloads.
getBinaryMediaTypes
in interface RestApiProps
public final IRestApi getCloneFrom()
RestApiProps
Default: - None.
getCloneFrom
in interface RestApiProps
public final java.lang.String getDescription()
RestApiProps
Default: - No description.
getDescription
in interface RestApiProps
public final EndpointConfiguration getEndpointConfiguration()
RestApiProps
Default: EndpointType.EDGE
public final java.lang.Number getMinimumCompressionSize()
RestApiProps
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.
getMinimumCompressionSize
in interface RestApiProps
public final java.lang.Boolean getCloudWatchRole()
RestApiBaseProps
Default: true
getCloudWatchRole
in interface RestApiBaseProps
public final java.lang.Boolean getDeploy()
RestApiBaseProps
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
getDeploy
in interface RestApiBaseProps
public final StageOptions getDeployOptions()
RestApiBaseProps
If deploy
is disabled,
this value cannot be set.
Default: - Based on defaults of `StageOptions`.
getDeployOptions
in interface RestApiBaseProps
public final java.lang.Boolean getDisableExecuteApiEndpoint()
RestApiBaseProps
To require that clients use a custom domain name to invoke the API, disable the default endpoint.
Default: false
getDisableExecuteApiEndpoint
in interface RestApiBaseProps
public final DomainNameOptions getDomainName()
RestApiBaseProps
Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.
getDomainName
in interface RestApiBaseProps
public final java.lang.String getEndpointExportName()
RestApiBaseProps
Default: - when no export name is given, output will be created without export
getEndpointExportName
in interface RestApiBaseProps
public final java.util.List<EndpointType> getEndpointTypes()
RestApiBaseProps
Use this property when creating an API.
Default: EndpointType.EDGE
getEndpointTypes
in interface RestApiBaseProps
public final java.lang.Boolean getFailOnWarnings()
RestApiBaseProps
Default: false
getFailOnWarnings
in interface RestApiBaseProps
public final java.util.Map<java.lang.String,java.lang.String> getParameters()
RestApiBaseProps
Default: - No parameters.
getParameters
in interface RestApiBaseProps
public final PolicyDocument getPolicy()
RestApiBaseProps
Default: - No policy.
getPolicy
in interface RestApiBaseProps
public final java.lang.String getRestApiName()
RestApiBaseProps
Default: - ID of the RestApi construct.
getRestApiName
in interface RestApiBaseProps
public final java.lang.Boolean getRetainDeployments()
RestApiBaseProps
This allows manually reverting stages to point to old deployments via the AWS Console.
Default: false
getRetainDeployments
in interface RestApiBaseProps
public final CorsOptions getDefaultCorsPreflightOptions()
ResourceOptions
You can add CORS at the resource-level using addCorsPreflight
.
Default: - CORS is disabled
getDefaultCorsPreflightOptions
in interface ResourceOptions
public final Integration getDefaultIntegration()
ResourceOptions
Default: - Inherited from parent.
getDefaultIntegration
in interface ResourceOptions
public final MethodOptions getDefaultMethodOptions()
ResourceOptions
Default: - Inherited from parent.
getDefaultMethodOptions
in interface ResourceOptions
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
public final boolean equals(java.lang.Object o)
public final int hashCode()