Class SpecRestApi.Builder

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

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

    • create

      @Stability(Stable) public static SpecRestApi.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of SpecRestApi.Builder.
    • cloudWatchRole

      @Stability(Stable) public SpecRestApi.Builder cloudWatchRole(Boolean cloudWatchRole)
      Automatically configure an AWS CloudWatch role for API Gateway.

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

      Parameters:
      cloudWatchRole - Automatically configure an AWS CloudWatch role for API Gateway. This parameter is required.
      Returns:
      this
    • cloudWatchRoleRemovalPolicy

      @Stability(Stable) public SpecRestApi.Builder cloudWatchRoleRemovalPolicy(RemovalPolicy cloudWatchRoleRemovalPolicy)
      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

      Parameters:
      cloudWatchRoleRemovalPolicy - The removal policy applied to the AWS CloudWatch role when this resource is removed from the application. This parameter is required.
      Returns:
      this
    • deploy

      @Stability(Stable) public SpecRestApi.Builder deploy(Boolean 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.

      Default: true

      Parameters:
      deploy - Indicates if a Deployment should be automatically created for this API, and recreated when the API model (resources, methods) changes. This parameter is required.
      Returns:
      this
    • deployOptions

      @Stability(Stable) public SpecRestApi.Builder deployOptions(StageOptions 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.

      Default: - Based on defaults of `StageOptions`.

      Parameters:
      deployOptions - Options for the API Gateway stage that will always point to the latest deployment when deploy is enabled. This parameter is required.
      Returns:
      this
    • description

      @Stability(Stable) public SpecRestApi.Builder description(String description)
      A description of the RestApi construct.

      Default: - 'Automatically created by the RestApi construct'

      Parameters:
      description - A description of the RestApi construct. This parameter is required.
      Returns:
      this
    • disableExecuteApiEndpoint

      @Stability(Stable) public SpecRestApi.Builder disableExecuteApiEndpoint(Boolean 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.

      Default: false

      Parameters:
      disableExecuteApiEndpoint - Specifies whether clients can invoke the API using the default execute-api endpoint. This parameter is required.
      Returns:
      this
      See Also:
    • domainName

      @Stability(Stable) public SpecRestApi.Builder domainName(DomainNameOptions domainName)
      Configure a custom domain name and map it to this API.

      Default: - no domain name is defined, use `addDomainName` or directly define a `DomainName`.

      Parameters:
      domainName - Configure a custom domain name and map it to this API. This parameter is required.
      Returns:
      this
    • endpointExportName

      @Stability(Stable) public SpecRestApi.Builder endpointExportName(String endpointExportName)
      Export name for the CfnOutput containing the API endpoint.

      Default: - when no export name is given, output will be created without export

      Parameters:
      endpointExportName - Export name for the CfnOutput containing the API endpoint. This parameter is required.
      Returns:
      this
    • endpointTypes

      @Stability(Stable) public SpecRestApi.Builder endpointTypes(List<? extends EndpointType> endpointTypes)
      A list of the endpoint types of the API.

      Use this property when creating an API.

      Default: EndpointType.EDGE

      Parameters:
      endpointTypes - A list of the endpoint types of the API. This parameter is required.
      Returns:
      this
    • failOnWarnings

      @Stability(Stable) public SpecRestApi.Builder failOnWarnings(Boolean failOnWarnings)
      Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource.

      Default: false

      Parameters:
      failOnWarnings - Indicates whether to roll back the resource if a warning occurs while API Gateway is creating the RestApi resource. This parameter is required.
      Returns:
      this
    • parameters

      @Stability(Stable) public SpecRestApi.Builder parameters(Map<String,String> parameters)
      Custom header parameters for the request.

      Default: - No parameters.

      Parameters:
      parameters - Custom header parameters for the request. This parameter is required.
      Returns:
      this
      See Also:
    • policy

      @Stability(Stable) public SpecRestApi.Builder policy(PolicyDocument policy)
      A policy document that contains the permissions for this RestApi.

      Default: - No policy.

      Parameters:
      policy - A policy document that contains the permissions for this RestApi. This parameter is required.
      Returns:
      this
    • restApiName

      @Stability(Stable) public SpecRestApi.Builder restApiName(String restApiName)
      A name for the API Gateway RestApi resource.

      Default: - ID of the RestApi construct.

      Parameters:
      restApiName - A name for the API Gateway RestApi resource. This parameter is required.
      Returns:
      this
    • retainDeployments

      @Stability(Stable) public SpecRestApi.Builder retainDeployments(Boolean retainDeployments)
      Retains old deployment resources when the API changes.

      This allows manually reverting stages to point to old deployments via the AWS Console.

      Default: false

      Parameters:
      retainDeployments - Retains old deployment resources when the API changes. This parameter is required.
      Returns:
      this
    • apiDefinition

      @Stability(Stable) public SpecRestApi.Builder apiDefinition(ApiDefinition apiDefinition)
      An OpenAPI definition compatible with API Gateway.

      Parameters:
      apiDefinition - An OpenAPI definition compatible with API Gateway. This parameter is required.
      Returns:
      this
      See Also:
    • minCompressionSize

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

      Default: - Compression is disabled.

      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. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public SpecRestApi build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SpecRestApi>
      Returns:
      a newly built instance of SpecRestApi.