Package software.amazon.awscdk.services.apigateway

Class RestApiOptions.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.apigateway.RestApiOptions.Jsii$Proxy
All Implemented Interfaces:
ResourceOptions, RestApiBaseProps, RestApiOptions, software.amazon.jsii.JsiiSerializable
Enclosing interface:
RestApiOptions
@Stability(Deprecated) @Deprecated @Internal public static final class RestApiOptions.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements RestApiOptions
Deprecated.
An implementation for RestApiOptions

  • 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.RestApiOptions

    RestApiOptions.Builder, RestApiOptions.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(RestApiOptions.Builder builder)
    Deprecated.
    Constructor that initializes the object based on literal property values passed by the RestApiOptions.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Deprecated.
    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()
    Deprecated.
     
    final boolean
    equals(Object o)
    Deprecated.
     
    final Boolean
    getCloudWatchRole()
    Deprecated.
    Automatically configure an AWS CloudWatch role for API Gateway.
    final CorsOptions
    getDefaultCorsPreflightOptions()
    Deprecated.
    Adds a CORS preflight OPTIONS method to this resource and all child resources.
    final Integration
    getDefaultIntegration()
    Deprecated.
    An integration to use as a default for all methods created within this API unless an integration is specified.
    final MethodOptions
    getDefaultMethodOptions()
    Deprecated.
    Method options to use as a default for all methods created within this API unless custom options are specified.
    final Boolean
    getDeploy()
    Deprecated.
    Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes.
    final StageOptions
    getDeployOptions()
    Deprecated.
    Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled.
    final Boolean
    getDisableExecuteApiEndpoint()
    Deprecated.
    Specifies whether clients can invoke the API using the default execute-api endpoint.
    final DomainNameOptions
    getDomainName()
    Deprecated.
    Configure a custom domain name and map it to this API.
    final String
    getEndpointExportName()
    Deprecated.
    Export name for the CfnOutput containing the API endpoint.
    final List<EndpointType>
    getEndpointTypes()
    Deprecated.
    A list of the endpoint types of the API.
    final Boolean
    getFailOnWarnings()
    Deprecated.
    Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
    final Map<String,String>
    getParameters()
    Deprecated.
    Custom header parameters for the request.
    final PolicyDocument
    getPolicy()
    Deprecated.
    A policy document that contains the permissions for this RestApi.
    final String
    getRestApiName()
    Deprecated.
    A name for the API Gateway RestApi resource.
    final Boolean
    getRetainDeployments()
    Deprecated.
    Retains old deployment resources when the API changes.
    final int
    hashCode()
    Deprecated.
     

    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)
      Deprecated.
      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(RestApiOptions.Builder builder)
      Deprecated.
      Constructor that initializes the object based on literal property values passed by the RestApiOptions.Builder.

  • Method Details

    • getCloudWatchRole

      public final Boolean getCloudWatchRole()
      Deprecated.
      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 Boolean getDeploy()
      Deprecated.
      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()
      Deprecated.
      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 Boolean getDisableExecuteApiEndpoint()
      Deprecated.
      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:

    • getDomainName

      public final DomainNameOptions getDomainName()
      Deprecated.
      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 String getEndpointExportName()
      Deprecated.
      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 List<EndpointType> getEndpointTypes()
      Deprecated.
      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 Boolean getFailOnWarnings()
      Deprecated.
      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 Map<String,String> getParameters()
      Deprecated.
      Description copied from interface: RestApiBaseProps
      Custom header parameters for the request.

      Default: - No parameters.

      Specified by:
      getParameters in interface RestApiBaseProps
      See Also:

    • getPolicy

      public final PolicyDocument getPolicy()
      Deprecated.
      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 String getRestApiName()
      Deprecated.
      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 Boolean getRetainDeployments()
      Deprecated.
      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

    • getDefaultCorsPreflightOptions

      public final CorsOptions getDefaultCorsPreflightOptions()
      Deprecated.
      Description copied from interface: ResourceOptions
      Adds a CORS preflight OPTIONS method to this resource and all child resources.

      You can add CORS at the resource-level using addCorsPreflight.

      Default: - CORS is disabled

      Specified by:
      getDefaultCorsPreflightOptions in interface ResourceOptions

    • getDefaultIntegration

      public final Integration getDefaultIntegration()
      Deprecated.
      Description copied from interface: ResourceOptions
      An integration to use as a default for all methods created within this API unless an integration is specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultIntegration in interface ResourceOptions

    • getDefaultMethodOptions

      public final MethodOptions getDefaultMethodOptions()
      Deprecated.
      Description copied from interface: ResourceOptions
      Method options to use as a default for all methods created within this API unless custom options are specified.

      Default: - Inherited from parent.

      Specified by:
      getDefaultMethodOptions in interface ResourceOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Deprecated.
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Deprecated.
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Deprecated.
      Overrides:
      hashCode in class Object