SpecRestApiProps.Jsii$Proxy

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

All Implemented Interfaces:

RestApiBaseProps, SpecRestApiProps

Enclosing interface:

SpecRestApiProps
```
public static final class SpecRestApiProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SpecRestApiProps
```
An implementation for SpecRestApiProps

Nested Class Summary
- Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.SpecRestApiProps
  SpecRestApiProps.Builder, SpecRestApiProps.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)`
`ApiDefinition`	`getApiDefinition()` An OpenAPI definition compatible with API Gateway.
`java.lang.Boolean`	`getCloudWatchRole()` Automatically configure an AWS CloudWatch role for API Gateway.
`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.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.
`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.
`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.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.SpecRestApiProps
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
  - getApiDefinition
```
public final ApiDefinition getApiDefinition()
```
    Description copied from interface: SpecRestApiProps
    
    An OpenAPI definition compatible with API Gateway.
    
    Specified by:
    
    getApiDefinition in interface SpecRestApiProps
    
    See Also:
    
    https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-import-api.html
  - 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
  - $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 SpecRestApiProps.Jsii$Proxy

Nested Class Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Method Detail

getApiDefinition

getCloudWatchRole

getDeploy

getDeployOptions

getDisableExecuteApiEndpoint

getDomainName

getEndpointExportName

getEndpointTypes

getFailOnWarnings

getParameters

getPolicy

getRestApiName

getRetainDeployments

$jsii$toJson

equals

hashCode