Package software.amazon.awscdk.services.apigateway

Class CfnRestApiProps.Jsii$Proxy

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(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
    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

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getApiKeySourceType()
    The source of the API key for metering requests according to a usage plan.
    final List<String>
    getBinaryMediaTypes()
    The list of binary media types supported by the RestApi.
    final Object
    getBody()
    An OpenAPI specification that defines a set of RESTful APIs in JSON format.
    final 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.
    final String
    getCloneFrom()
    The ID of the RestApi that you want to clone from.
    final String
    getDescription()
    The description of the RestApi.
    final Object
    getDisableExecuteApiEndpoint()
    Specifies whether clients can invoke your API by using the default execute-api endpoint.
    final Object
    getEndpointConfiguration()
    A list of the endpoint types of the API.
    final Object
    getFailOnWarnings()
    A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.
    final 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.
    final String
    getMode()
    This property applies only when you use OpenAPI to define your REST API.
    final String
    getName()
    The name of the RestApi.
    final Object
    getParameters()
    Custom header parameters as part of the request.
    final Object
    getPolicy()
    A policy document that contains the permissions for the RestApi resource.
    final List<CfnTag>
    getTags()
    The key-value map of strings.
    final 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

  • 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

      protected Jsii$Proxy(CfnRestApiProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the CfnRestApiProps.Builder.

  • Method Details

    • 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 custom authorizer.

      Specified by:
      getApiKeySourceType in interface CfnRestApiProps

    • getBinaryMediaTypes

      public final List<String> getBinaryMediaTypes()
      Description copied from interface: CfnRestApiProps
      The list of binary media types supported by the RestApi.

      By default, the RestApi supports only UTF-8-encoded text payloads.

      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 that you want to clone from.
      Specified by:
      getCloneFrom in interface CfnRestApiProps

    • getDescription

      public final String getDescription()
      Description copied from interface: CfnRestApiProps
      The description of the RestApi.
      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
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

      The default value is false .

      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 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 RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.

      Specified by:
      getMode in interface CfnRestApiProps

    • getName

      public final String getName()
      Description copied from interface: CfnRestApiProps
      The name of the RestApi.

      A name is required if the REST API is not based on an OpenAPI specification.

      Specified by:
      getName in interface CfnRestApiProps

    • getParameters

      public final Object getParameters()
      Description copied from interface: CfnRestApiProps
      Custom header parameters as part of the request.

      For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

      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
      The 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:
      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