Package software.amazon.awscdk.services.apigateway

Class RestApiProps.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.RestApiProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<RestApiProps>
Enclosing interface:
RestApiProps
@Stability(Stable) public static final class RestApiProps.Builder extends Object implements software.amazon.jsii.Builder<RestApiProps>
A builder for RestApiProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • apiKeySourceType

      @Stability(Stable) public RestApiProps.Builder apiKeySourceType(ApiKeySourceType apiKeySourceType)
      Sets the value of RestApiProps.getApiKeySourceType()
      Parameters:
      apiKeySourceType - The source of the API key for metering requests according to a usage plan.
      Returns:
      this

    • binaryMediaTypes

      @Stability(Stable) public RestApiProps.Builder binaryMediaTypes(List<String> binaryMediaTypes)
      Sets the value of RestApiProps.getBinaryMediaTypes()
      Parameters:
      binaryMediaTypes - The list of binary media mime-types that are supported by the RestApi resource, such as "image/png" or "application/octet-stream".
      Returns:
      this

    • cloneFrom

      @Stability(Stable) public RestApiProps.Builder cloneFrom(IRestApi cloneFrom)
      Sets the value of RestApiProps.getCloneFrom()
      Parameters:
      cloneFrom - The ID of the API Gateway RestApi resource that you want to clone.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public RestApiProps.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)
      Sets the value of RestApiProps.getEndpointConfiguration()
      Parameters:
      endpointConfiguration - The EndpointConfiguration property type specifies the endpoint types of a REST API.
      Returns:
      this

    • minCompressionSize

      @Stability(Stable) public RestApiProps.Builder minCompressionSize(Size minCompressionSize)
      Sets the value of RestApiProps.getMinCompressionSize()
      Parameters:
      minCompressionSize - 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.
      Returns:
      this

    • minimumCompressionSize

      @Stability(Deprecated) @Deprecated public RestApiProps.Builder minimumCompressionSize(Number minimumCompressionSize)
      Deprecated.
      - superseded by `minCompressionSize`
      Sets the value of RestApiProps.getMinimumCompressionSize()
      Parameters:
      minimumCompressionSize - 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.
      Returns:
      this

    • defaultCorsPreflightOptions

      @Stability(Stable) public RestApiProps.Builder defaultCorsPreflightOptions(CorsOptions defaultCorsPreflightOptions)
      Sets the value of ResourceOptions.getDefaultCorsPreflightOptions()
      Parameters:
      defaultCorsPreflightOptions - Adds a CORS preflight OPTIONS method to this resource and all child resources. You can add CORS at the resource-level using addCorsPreflight.
      Returns:
      this

    • defaultIntegration

      @Stability(Stable) public RestApiProps.Builder defaultIntegration(Integration defaultIntegration)
      Sets the value of ResourceOptions.getDefaultIntegration()
      Parameters:
      defaultIntegration - An integration to use as a default for all methods created within this API unless an integration is specified.
      Returns:
      this

    • defaultMethodOptions

      @Stability(Stable) public RestApiProps.Builder defaultMethodOptions(MethodOptions defaultMethodOptions)
      Sets the value of ResourceOptions.getDefaultMethodOptions()
      Parameters:
      defaultMethodOptions - Method options to use as a default for all methods created within this API unless custom options are specified.
      Returns:
      this

    • cloudWatchRole

      @Stability(Stable) public RestApiProps.Builder cloudWatchRole(Boolean cloudWatchRole)
      Sets the value of RestApiBaseProps.getCloudWatchRole()
      Parameters:
      cloudWatchRole - Automatically configure an AWS CloudWatch role for API Gateway.
      Returns:
      this

    • cloudWatchRoleRemovalPolicy

      @Stability(Stable) public RestApiProps.Builder cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy)
      Sets the value of RestApiBaseProps.getCloudWatchRoleRemovalPolicy()
      Parameters:
      cloudWatchRoleRemovalPolicy - The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. Requires cloudWatchRole to be enabled.
      Returns:
      this

    • deploy

      @Stability(Stable) public RestApiProps.Builder deploy(Boolean deploy)
      Sets the value of RestApiBaseProps.getDeploy()
      Parameters:
      deploy - 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.

      Returns:
      this

    • deployOptions

      @Stability(Stable) public RestApiProps.Builder deployOptions(StageOptions deployOptions)
      Sets the value of RestApiBaseProps.getDeployOptions()
      Parameters:
      deployOptions - 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.
      Returns:
      this

    • description

      @Stability(Stable) public RestApiProps.Builder description(String description)
      Sets the value of RestApiBaseProps.getDescription()
      Parameters:
      description - A description of the RestApi construct.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public RestApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
      Sets the value of RestApiBaseProps.getDisableExecuteApiEndpoint()
      Parameters:
      disableExecuteApiEndpoint - 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.
      Returns:
      this

    • domainName

      @Stability(Stable) public RestApiProps.Builder domainName(DomainNameOptions domainName)
      Sets the value of RestApiBaseProps.getDomainName()
      Parameters:
      domainName - Configure a custom domain name and map it to this API.
      Returns:
      this

    • endpointExportName

      @Stability(Stable) public RestApiProps.Builder endpointExportName(String endpointExportName)
      Sets the value of RestApiBaseProps.getEndpointExportName()
      Parameters:
      endpointExportName - Export name for the CfnOutput containing the API endpoint.
      Returns:
      this

    • endpointTypes

      @Stability(Stable) public RestApiProps.Builder endpointTypes(List<? extends EndpointType> endpointTypes)
      Sets the value of RestApiBaseProps.getEndpointTypes()
      Parameters:
      endpointTypes - A list of the endpoint types of the API. Use this property when creating an API.
      Returns:
      this

    • failOnWarnings

      @Stability(Stable) public RestApiProps.Builder failOnWarnings(Boolean failOnWarnings)
      Sets the value of RestApiBaseProps.getFailOnWarnings()
      Parameters:
      failOnWarnings - Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.
      Returns:
      this

    • parameters

      @Stability(Stable) public RestApiProps.Builder parameters(Map<String,String> parameters)
      Sets the value of RestApiBaseProps.getParameters()
      Parameters:
      parameters - Custom header parameters for the request.
      Returns:
      this

    • policy

      @Stability(Stable) public RestApiProps.Builder policy(PolicyDocument policy)
      Sets the value of RestApiBaseProps.getPolicy()
      Parameters:
      policy - A policy document that contains the permissions for this RestApi.
      Returns:
      this

    • restApiName

      @Stability(Stable) public RestApiProps.Builder restApiName(String restApiName)
      Sets the value of RestApiBaseProps.getRestApiName()
      Parameters:
      restApiName - A name for the API Gateway RestApi resource.
      Returns:
      this

    • retainDeployments

      @Stability(Stable) public RestApiProps.Builder retainDeployments(Boolean retainDeployments)
      Sets the value of RestApiBaseProps.getRetainDeployments()
      Parameters:
      retainDeployments - Retains old deployment resources when the API changes. This allows manually reverting stages to point to old deployments via the AWS Console.
      Returns:
      this

    • build

      @Stability(Stable) public RestApiProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<RestApiProps>
      Returns:
      a new instance of RestApiProps
      Throws:
      NullPointerException - if any required attribute was not provided