Class CfnRestApiProps.Jsii$Proxy
- All Implemented Interfaces:
CfnRestApiProps,software.amazon.jsii.JsiiSerializable
- Enclosing interface:
CfnRestApiProps
CfnRestApiProps-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationModeNested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.CfnRestApiProps
CfnRestApiProps.Builder, CfnRestApiProps.Jsii$Proxy -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedJsii$Proxy(CfnRestApiProps.Builder builder) Constructor that initializes the object based on literal property values passed by theCfnRestApiProps.Builder.protectedJsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject. -
Method Summary
Modifier and TypeMethodDescriptioncom.fasterxml.jackson.databind.JsonNodefinal booleanfinal StringThe source of the API key for metering requests according to a usage plan.The list of binary media types supported by the RestApi.final ObjectgetBody()An OpenAPI specification that defines a set of RESTful APIs in JSON format.final ObjectThe 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.final StringThe ID of the RestApi that you want to clone from.final StringThe description of the RestApi.final ObjectSpecifies whether clients can invoke your API by using the defaultexecute-apiendpoint.final ObjectA list of the endpoint types and IP address types of the API.final ObjectA query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered.final NumberA 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.final StringgetMode()This property applies only when you use OpenAPI to define your REST API.final StringgetName()The name of the RestApi.final ObjectCustom header parameters as part of the request.final ObjectA policy document that contains the permissions for theRestApiresource.final StringgetTags()The key-value map of strings.final inthashCode()Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
-
Constructor Details
-
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
Constructor that initializes the object based on literal property values passed by theCfnRestApiProps.Builder.
-
-
Method Details
-
getApiKeySourceType
Description copied from interface:CfnRestApiPropsThe source of the API key for metering requests according to a usage plan.Valid values are:
HEADERto read the API key from theX-API-Keyheader of a request.AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.- Specified by:
getApiKeySourceTypein interfaceCfnRestApiProps- See Also:
-
getBinaryMediaTypes
Description copied from interface:CfnRestApiPropsThe list of binary media types supported by the RestApi.By default, the RestApi supports only UTF-8-encoded text payloads.
- Specified by:
getBinaryMediaTypesin interfaceCfnRestApiProps- See Also:
-
getBody
Description copied from interface:CfnRestApiPropsAn 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:
getBodyin interfaceCfnRestApiProps- See Also:
-
getBodyS3Location
Description copied from interface:CfnRestApiPropsThe 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.Returns union: either
IResolvableorCfnRestApi.S3LocationProperty- Specified by:
getBodyS3Locationin interfaceCfnRestApiProps- See Also:
-
getCloneFrom
Description copied from interface:CfnRestApiPropsThe ID of the RestApi that you want to clone from.- Specified by:
getCloneFromin interfaceCfnRestApiProps- See Also:
-
getDescription
Description copied from interface:CfnRestApiPropsThe description of the RestApi.- Specified by:
getDescriptionin interfaceCfnRestApiProps- See Also:
-
getDisableExecuteApiEndpoint
Description copied from interface:CfnRestApiPropsSpecifies whether clients can invoke your API by using the defaultexecute-apiendpoint.By default, clients can invoke your API with the default
https://{api_id}.execute-api.{region}.amazonaws.com.rproxy.govskope.caendpoint. To require that clients use a custom domain name to invoke your API, disable the default endpointReturns union: either
BooleanorIResolvable- Specified by:
getDisableExecuteApiEndpointin interfaceCfnRestApiProps- See Also:
-
getEndpointConfiguration
Description copied from interface:CfnRestApiPropsA list of the endpoint types and IP address types of the API.Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the
Parametersproperty.Returns union: either
IResolvableorCfnRestApi.EndpointConfigurationProperty- Specified by:
getEndpointConfigurationin interfaceCfnRestApiProps- See Also:
-
getFailOnWarnings
Description copied from interface:CfnRestApiPropsA query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered.The default value is
false.Returns union: either
BooleanorIResolvable- Specified by:
getFailOnWarningsin interfaceCfnRestApiProps- See Also:
-
getMinimumCompressionSize
Description copied from interface:CfnRestApiPropsA 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:
getMinimumCompressionSizein interfaceCfnRestApiProps- See Also:
-
getMode
Description copied from interface:CfnRestApiPropsThis property applies only when you use OpenAPI to define your REST API.The
Modedetermines how API Gateway handles resource updates.Valid values are
overwriteormerge.For
overwrite, the new API definition replaces the existing one. The existing API identifier remains unchanged.For
merge, the new API definition is merged with the existing API.If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is
overwrite. For REST APIs created after March 29, 2021, 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 the default mode to define top-level
RestApiproperties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.- Specified by:
getModein interfaceCfnRestApiProps- See Also:
-
getName
Description copied from interface:CfnRestApiPropsThe name of the RestApi.A name is required if the REST API is not based on an OpenAPI specification.
- Specified by:
getNamein interfaceCfnRestApiProps- See Also:
-
getParameters
Description copied from interface:CfnRestApiPropsCustom header parameters as part of the request.For example, to exclude DocumentationParts from an imported API, set
ignore=documentationas aparametersvalue, as in the AWS CLI command ofaws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.Returns union: either Mapinvalid input: '<'String,
String> orIResolvable- Specified by:
getParametersin interfaceCfnRestApiProps- See Also:
-
getPolicy
Description copied from interface:CfnRestApiPropsA policy document that contains the permissions for theRestApiresource.To set the ARN for the policy, use the
!Joinintrinsic function with""as delimiter and values of"execute-api:/"and"*".- Specified by:
getPolicyin interfaceCfnRestApiProps- See Also:
-
getSecurityPolicy
- Specified by:
getSecurityPolicyin interfaceCfnRestApiProps- See Also:
-
getTags
Description copied from interface:CfnRestApiPropsThe key-value map of strings.The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with
aws:. The tag value can be up to 256 characters.- Specified by:
getTagsin interfaceCfnRestApiProps- See Also:
-
$jsii$toJson
@Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()- Specified by:
$jsii$toJsonin interfacesoftware.amazon.jsii.JsiiSerializable
-
equals
-
hashCode
public final int hashCode()
-