Package software.amazon.awscdk.services.apigateway

Class CfnRestApi.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnRestApi.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnRestApi.Builder.

    • apiKeySourceType

      @Stability(Stable) public CfnRestApi.Builder apiKeySourceType(String apiKeySourceType)
      The source of the API key for metering requests according to a usage plan.

      Valid values are: HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

      Parameters:
      apiKeySourceType - The source of the API key for metering requests according to a usage plan. This parameter is required.
      Returns:
      this

    • binaryMediaTypes

      @Stability(Stable) public CfnRestApi.Builder binaryMediaTypes(List<String> binaryMediaTypes)
      The list of binary media types supported by the RestApi.

      By default, the RestApi supports only UTF-8-encoded text payloads.

      Parameters:
      binaryMediaTypes - The list of binary media types supported by the RestApi. This parameter is required.
      Returns:
      this

    • body

      @Stability(Stable) public CfnRestApi.Builder body(Object body)
      An OpenAPI specification that defines a set of RESTful APIs in JSON format.

      For YAML templates, you can also provide the specification in YAML format.

      Parameters:
      body - An OpenAPI specification that defines a set of RESTful APIs in JSON format. This parameter is required.
      Returns:
      this

    • bodyS3Location

      @Stability(Stable) public CfnRestApi.Builder bodyS3Location(IResolvable bodyS3Location)
      The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.

      Parameters:
      bodyS3Location - The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. This parameter is required.
      Returns:
      this

    • bodyS3Location

      @Stability(Stable) public CfnRestApi.Builder bodyS3Location(CfnRestApi.S3LocationProperty bodyS3Location)
      The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format.

      Parameters:
      bodyS3Location - The Amazon Simple Storage Service (Amazon S3) location that points to an OpenAPI file, which defines a set of RESTful APIs in JSON or YAML format. This parameter is required.
      Returns:
      this

    • cloneFrom

      @Stability(Stable) public CfnRestApi.Builder cloneFrom(String cloneFrom)
      The ID of the RestApi that you want to clone from.

      Parameters:
      cloneFrom - The ID of the RestApi that you want to clone from. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnRestApi.Builder description(String description)
      The description of the RestApi.

      Parameters:
      description - The description of the RestApi. This parameter is required.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnRestApi.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
      Specifies whether clients can invoke your API by using the default execute-api endpoint.

      By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

      Parameters:
      disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. This parameter is required.
      Returns:
      this

    • disableExecuteApiEndpoint

      @Stability(Stable) public CfnRestApi.Builder disableExecuteApiEndpoint(IResolvable disableExecuteApiEndpoint)
      Specifies whether clients can invoke your API by using the default execute-api endpoint.

      By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

      Parameters:
      disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. This parameter is required.
      Returns:
      this

    • endpointConfiguration

      @Stability(Stable) public CfnRestApi.Builder endpointConfiguration(IResolvable endpointConfiguration)
      A list of the endpoint types of the API.

      Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.

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

    • endpointConfiguration

      @Stability(Stable) public CfnRestApi.Builder endpointConfiguration(CfnRestApi.EndpointConfigurationProperty endpointConfiguration)
      A list of the endpoint types of the API.

      Use this property when creating an API. When importing an existing API, specify the endpoint configuration types using the Parameters property.

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

    • failOnWarnings

      @Stability(Stable) public CfnRestApi.Builder failOnWarnings(Boolean failOnWarnings)
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

      The default value is false .

      Parameters:
      failOnWarnings - A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered. This parameter is required.
      Returns:
      this

    • failOnWarnings

      @Stability(Stable) public CfnRestApi.Builder failOnWarnings(IResolvable failOnWarnings)
      A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered.

      The default value is false .

      Parameters:
      failOnWarnings - A query parameter to indicate whether to rollback the API update ( true ) or not ( false ) when a warning is encountered. This parameter is required.
      Returns:
      this

    • minimumCompressionSize

      @Stability(Stable) public CfnRestApi.Builder minimumCompressionSize(Number minimumCompressionSize)
      A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) 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.

      Parameters:
      minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. This parameter is required.
      Returns:
      this

    • mode

      @Stability(Stable) public CfnRestApi.Builder mode(String mode)
      This property applies only when you use OpenAPI to define your REST API.

      The Mode determines how API Gateway handles resource updates.

      Valid values are overwrite or merge .

      For overwrite , the new API definition replaces the existing one. The existing API identifier remains unchanged.

      For merge , the new API definition is merged with the existing API.

      If you don't specify this property, a default value is chosen. For REST APIs created before March 29, 2021, the default is overwrite . For REST APIs created after March 29, 2021, the new API definition takes precedence, but any container types such as endpoint configurations and binary media types are merged with the existing API.

      Use the default mode to define top-level RestApi properties in addition to using OpenAPI. Generally, it's preferred to use API Gateway's OpenAPI extensions to model these properties.

      Parameters:
      mode - This property applies only when you use OpenAPI to define your REST API. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnRestApi.Builder name(String name)
      The name of the RestApi.

      A name is required if the REST API is not based on an OpenAPI specification.

      Parameters:
      name - The name of the RestApi. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnRestApi.Builder parameters(IResolvable parameters)
      Custom header parameters as part of the request.

      For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

      Parameters:
      parameters - Custom header parameters as part of the request. This parameter is required.
      Returns:
      this

    • parameters

      @Stability(Stable) public CfnRestApi.Builder parameters(Map<String,String> parameters)
      Custom header parameters as part of the request.

      For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json' .

      Parameters:
      parameters - Custom header parameters as part of the request. This parameter is required.
      Returns:
      this

    • policy

      @Stability(Stable) public CfnRestApi.Builder policy(Object policy)
      A policy document that contains the permissions for the RestApi resource.

      To set the ARN for the policy, use the !Join intrinsic function with "" as delimiter and values of "execute-api:/" and "*" .

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

    • tags

      @Stability(Stable) public CfnRestApi.Builder tags(List<? extends CfnTag> tags)
      The key-value map of strings.

      The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws: . The tag value can be up to 256 characters.

      Parameters:
      tags - The key-value map of strings. This parameter is required.
      Returns:
      this

    • build

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