Class SpecRestApiProps.Builder

java.lang.Object
software.amazon.awscdk.services.apigateway.SpecRestApiProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SpecRestApiProps>
Enclosing interface:
SpecRestApiProps

@Stability(Stable) public static final class SpecRestApiProps.Builder extends Object implements software.amazon.jsii.Builder<SpecRestApiProps>
A builder for SpecRestApiProps
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • apiDefinition

      @Stability(Stable) public SpecRestApiProps.Builder apiDefinition(ApiDefinition apiDefinition)
      Parameters:
      apiDefinition - An OpenAPI definition compatible with API Gateway. This parameter is required.
      Returns:
      this
    • minCompressionSize

      @Stability(Stable) public SpecRestApiProps.Builder minCompressionSize(Size minCompressionSize)
      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
    • cloudWatchRole

      @Stability(Stable) public SpecRestApiProps.Builder cloudWatchRole(Boolean cloudWatchRole)
      Parameters:
      cloudWatchRole - Automatically configure an AWS CloudWatch role for API Gateway.
      Returns:
      this
    • cloudWatchRoleRemovalPolicy

      @Stability(Stable) public SpecRestApiProps.Builder cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy)
      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 SpecRestApiProps.Builder deploy(Boolean deploy)
      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 SpecRestApiProps.Builder deployOptions(StageOptions deployOptions)
      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 SpecRestApiProps.Builder description(String description)
      Parameters:
      description - A description of the RestApi construct.
      Returns:
      this
    • disableExecuteApiEndpoint

      @Stability(Stable) public SpecRestApiProps.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
      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 SpecRestApiProps.Builder domainName(DomainNameOptions domainName)
      Parameters:
      domainName - Configure a custom domain name and map it to this API.
      Returns:
      this
    • endpointExportName

      @Stability(Stable) public SpecRestApiProps.Builder endpointExportName(String endpointExportName)
      Parameters:
      endpointExportName - Export name for the CfnOutput containing the API endpoint.
      Returns:
      this
    • endpointTypes

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

      @Stability(Stable) public SpecRestApiProps.Builder failOnWarnings(Boolean failOnWarnings)
      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 SpecRestApiProps.Builder parameters(Map<String,String> parameters)
      Parameters:
      parameters - Custom header parameters for the request.
      Returns:
      this
    • policy

      @Stability(Stable) public SpecRestApiProps.Builder policy(PolicyDocument policy)
      Parameters:
      policy - A policy document that contains the permissions for this RestApi.
      Returns:
      this
    • restApiName

      @Stability(Stable) public SpecRestApiProps.Builder restApiName(String restApiName)
      Parameters:
      restApiName - A name for the API Gateway RestApi resource.
      Returns:
      this
    • retainDeployments

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