CfnRestApiProps.Jsii$Proxy (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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

All Implemented Interfaces:: CfnRestApiProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:: CfnRestApiProps

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

An implementation for CfnRestApiProps

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.CfnRestApiProps
  CfnRestApiProps.Builder, CfnRestApiProps.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(CfnRestApiProps.Builder builder)` Constructor that initializes the object based on literal property values passed by the `CfnRestApiProps.Builder`.
`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(Object o)`
`String`	`getApiKeySourceType()` The source of the API key for metering requests according to a usage plan.
`List<String>`	`getBinaryMediaTypes()` The list of binary media types that are supported by the `RestApi` resource.
`Object`	`getBody()` An OpenAPI specification that defines a set of RESTful APIs in JSON format.
`Object`	`getBodyS3Location()` The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
`String`	`getCloneFrom()` The ID of the `RestApi` resource that you want to clone.
`String`	`getDescription()` A description of the `RestApi` resource.
`Object`	`getDisableExecuteApiEndpoint()` Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
`Object`	`getEndpointConfiguration()` A list of the endpoint types of the API.
`Object`	`getFailOnWarnings()` Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource.
`Number`	`getMinimumCompressionSize()` A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API.
`String`	`getMode()` This property applies only when you use OpenAPI to define your REST API.
`String`	`getName()` A name for the `RestApi` resource.
`Object`	`getParameters()` Custom header parameters for the request.
`Object`	`getPolicy()` A policy document that contains the permissions for the `RestApi` resource.
`List<CfnTag>`	`getTags()` An array of arbitrary tags (key-value pairs) to associate with the API.
`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.CfnRestApiProps
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(CfnRestApiProps.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the CfnRestApiProps.Builder.
- Method Detail
  - getApiKeySourceType
```
public final String getApiKeySourceType()
```
    Description copied from interface: CfnRestApiProps
    The source of the API key for metering requests according to a usage plan. Valid values are:.
    - HEADER to read the API key from the X-API-Key header of a request.
    - AUTHORIZER to read the API key from the UsageIdentifierKey from a Lambda authorizer.
    Specified by:
    
    getApiKeySourceType in interface CfnRestApiProps
  - getBinaryMediaTypes
```
public final List<String> getBinaryMediaTypes()
```
    Description copied from interface: CfnRestApiProps
    
    The list of binary media types that are supported by the `RestApi` resource.
    Use ~1 instead of / in the media types, for example image~1png or application~1octet-stream . By default, RestApi supports only UTF-8-encoded text payloads. Duplicates are not allowed. For more information, see Enable Support for Binary Payloads in API Gateway in the API Gateway Developer Guide .
    
    Specified by:
    
    getBinaryMediaTypes in interface CfnRestApiProps
  - getBody
```
public final Object getBody()
```
    Description copied from interface: CfnRestApiProps
    
    An OpenAPI specification that defines a set of RESTful APIs in JSON format.
    For YAML templates, you can also provide the specification in YAML format.
    
    Specified by:
    
    getBody in interface CfnRestApiProps
  - getBodyS3Location
```
public final Object getBodyS3Location()
```
    Description copied from interface: CfnRestApiProps
    
    The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.
    
    Specified by:
    
    getBodyS3Location in interface CfnRestApiProps
  - getCloneFrom
```
public final String getCloneFrom()
```
    Description copied from interface: CfnRestApiProps
    
    The ID of the `RestApi` resource that you want to clone.
    
    Specified by:
    
    getCloneFrom in interface CfnRestApiProps
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: CfnRestApiProps
    
    A description of the `RestApi` resource.
    
    Specified by:
    
    getDescription in interface CfnRestApiProps
  - getDisableExecuteApiEndpoint
```
public final Object getDisableExecuteApiEndpoint()
```
    Description copied from interface: CfnRestApiProps
    
    Specifies whether clients can invoke your API by using the default `execute-api` endpoint.
    By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
    
    Specified by:
    
    getDisableExecuteApiEndpoint in interface CfnRestApiProps
  - getEndpointConfiguration
```
public final Object getEndpointConfiguration()
```
    Description copied from interface: CfnRestApiProps
    
    A list of the endpoint types of the API.
    Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.
    
    Specified by:
    
    getEndpointConfiguration in interface CfnRestApiProps
  - getFailOnWarnings
```
public final Object getFailOnWarnings()
```
    Description copied from interface: CfnRestApiProps
    
    Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the `RestApi` resource.
    
    Specified by:
    
    getFailOnWarnings in interface CfnRestApiProps
  - getMinimumCompressionSize
```
public final Number getMinimumCompressionSize()
```
    Description copied from interface: CfnRestApiProps
    
    A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) 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.
    
    Specified by:
    
    getMinimumCompressionSize in interface CfnRestApiProps
  - getMode
```
public final String getMode()
```
    Description copied from interface: CfnRestApiProps
    
    This property applies only when you use OpenAPI to define your REST API.
    The Mode determines how API Gateway handles resource updates.
    Valid values are overwrite or merge .
    For overwrite , the new API definition replaces the existing one. The existing API identifier remains unchanged.
    For merge , the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API. Use merge to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.
    If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite . Otherwise, the default value is merge .
    
    Specified by:
    
    getMode in interface CfnRestApiProps
  - getName
```
public final String getName()
```
    Description copied from interface: CfnRestApiProps
    
    A name for the `RestApi` resource.
    
    Specified by:
    
    getName in interface CfnRestApiProps
  - getParameters
```
public final Object getParameters()
```
    Description copied from interface: CfnRestApiProps
    
    Custom header parameters for the request.
    
    Specified by:
    
    getParameters in interface CfnRestApiProps
  - getPolicy
```
public final Object getPolicy()
```
    Description copied from interface: CfnRestApiProps
    
    A policy document that contains the permissions for the `RestApi` resource.
    To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*" .
    
    Specified by:
    
    getPolicy in interface CfnRestApiProps
  - getTags
```
public final List<CfnTag> getTags()
```
    Description copied from interface: CfnRestApiProps
    
    An array of arbitrary tags (key-value pairs) to associate with the API.
    
    Specified by:
    
    getTags in interface CfnRestApiProps
  - $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

Class CfnRestApiProps.Jsii$Proxy

Nested Class Summary

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

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

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getApiKeySourceType

getBinaryMediaTypes

getBody

getBodyS3Location

getCloneFrom

getDescription

getDisableExecuteApiEndpoint

getEndpointConfiguration

getFailOnWarnings

getMinimumCompressionSize

getMode

getName

getParameters

getPolicy

getTags

$jsii$toJson

equals

hashCode