Package software.amazon.awscdk.services.apigateway

Class StepFunctionsRestApiProps.Jsii$Proxy

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

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

  • Method Details

    • getStateMachine

      public final IStateMachine getStateMachine()
      Description copied from interface: StepFunctionsRestApiProps
      The default State Machine that handles all requests from this API.

      This stateMachine will be used as a the default integration for all methods in this API, unless specified otherwise in addMethod.

      Specified by:
      getStateMachine in interface StepFunctionsRestApiProps

    • getAuthorizer

      public final Boolean getAuthorizer()
      Description copied from interface: StepFunctionsRestApiProps
      If the whole authorizer object, including custom context values should be in the execution input.

      The execution input will include a new key authorizer:

      { "body": {}, "authorizer": { "key": "value" } }

      Default: false

      Specified by:
      getAuthorizer in interface StepFunctionsRestApiProps

    • getHeaders

      public final Boolean getHeaders()
      Description copied from interface: StepFunctionsRestApiProps
      Check if header is to be included inside the execution input.

      The execution input will include a new key headers:

      { "body": {}, "headers": { "header1": "value", "header2": "value" } }

      Default: false

      Specified by:
      getHeaders in interface StepFunctionsRestApiProps

    • getPath

      public final Boolean getPath()
      Description copied from interface: StepFunctionsRestApiProps
      Check if path is to be included inside the execution input.

      The execution input will include a new key path:

      { "body": {}, "path": { "resourceName": "resourceValue" } }

      Default: true

      Specified by:
      getPath in interface StepFunctionsRestApiProps

    • getQuerystring

      public final Boolean getQuerystring()
      Description copied from interface: StepFunctionsRestApiProps
      Check if querystring is to be included inside the execution input.

      The execution input will include a new key queryString:

      { "body": {}, "querystring": { "key": "value" } }

      Default: true

      Specified by:
      getQuerystring in interface StepFunctionsRestApiProps

    • getRequestContext

      public final RequestContext getRequestContext()
      Description copied from interface: StepFunctionsRestApiProps
      Which details of the incoming request must be passed onto the underlying state machine, such as, account id, user identity, request id, etc.

      The execution input will include a new key requestContext:

      { "body": {}, "requestContext": { "key": "value" } }

      Default: - all parameters within request context will be set as false

      Specified by:
      getRequestContext in interface StepFunctionsRestApiProps

    • getRole

      public final IRole getRole()
      Description copied from interface: StepFunctionsRestApiProps
      An IAM role that API Gateway will assume to start the execution of the state machine.

      Default: - a new role is created

      Specified by:
      getRole in interface StepFunctionsRestApiProps

    • getUseDefaultMethodResponses

      public final Boolean getUseDefaultMethodResponses()
      Description copied from interface: StepFunctionsRestApiProps
      Whether to add default response models with 200, 400, and 500 status codes to the method.

      Default: true

      Specified by:
      getUseDefaultMethodResponses in interface StepFunctionsRestApiProps

    • getApiKeySourceType

      public final ApiKeySourceType getApiKeySourceType()
      Description copied from interface: RestApiProps
      The source of the API key for metering requests according to a usage plan.

      Default: - Metering is disabled.

      Specified by:
      getApiKeySourceType in interface RestApiProps

    • getBinaryMediaTypes

      public final List<String> getBinaryMediaTypes()
      Description copied from interface: RestApiProps
      The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".

      Default: - RestApi supports only UTF-8-encoded text payloads.

      Specified by:
      getBinaryMediaTypes in interface RestApiProps

    • getCloneFrom

      public final IRestApi getCloneFrom()
      Description copied from interface: RestApiProps
      The ID of the API Gateway RestApi resource that you want to clone.

      Default: - None.

      Specified by:
      getCloneFrom in interface RestApiProps

    • getEndpointConfiguration

      public final EndpointConfiguration getEndpointConfiguration()
      Description copied from interface: RestApiProps
      The EndpointConfiguration property type specifies the endpoint types of a REST API.

      Default: EndpointType.EDGE

      Specified by:
      getEndpointConfiguration in interface RestApiProps
      See Also:

    • getMinCompressionSize

      public final Size getMinCompressionSize()
      Description copied from interface: RestApiProps
      A Size(in bytes, kibibytes, mebibytes etc) that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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.

      Default: - Compression is disabled.

      Specified by:
      getMinCompressionSize in interface RestApiProps

    • getMinimumCompressionSize

      public final Number getMinimumCompressionSize()
      Description copied from interface: RestApiProps
      (deprecated) A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (when undefined) 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.

      Default: - Compression is disabled.

      Specified by:
      getMinimumCompressionSize in interface RestApiProps

    • getDefaultCorsPreflightOptions

      public final CorsOptions getDefaultCorsPreflightOptions()
      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()
      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()
      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

    • getCloudWatchRole

      public final Boolean getCloudWatchRole()
      Description copied from interface: RestApiBaseProps
      Automatically configure an AWS CloudWatch role for API Gateway.

      Default: - false if `@aws-cdk/aws-apigateway:disableCloudWatchRole` is enabled, true otherwise

      Specified by:
      getCloudWatchRole in interface RestApiBaseProps

    • getCloudWatchRoleRemovalPolicy

      public final RemovalPolicy getCloudWatchRoleRemovalPolicy()
      Description copied from interface: RestApiBaseProps
      The removal policy applied to the AWS CloudWatch role when this resource is removed from the application.

      Requires cloudWatchRole to be enabled.

      Default: - RemovalPolicy.RETAIN

      Specified by:
      getCloudWatchRoleRemovalPolicy in interface RestApiBaseProps

    • getDeploy

      public final 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

    • getDescription

      public final String getDescription()
      Description copied from interface: RestApiBaseProps
      A description of the RestApi construct.

      Default: - 'Automatically created by the RestApi construct'

      Specified by:
      getDescription in interface RestApiBaseProps

    • getDisableExecuteApiEndpoint

      public final 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:

    • 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 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 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 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 Map<String,String> getParameters()
      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()
      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()
      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()
      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

      @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