Interface CreateRestApiRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateRestApiRequest.Builder,CreateRestApiRequest>, SdkBuilder<CreateRestApiRequest.Builder,CreateRestApiRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateRestApiRequest

public static interface CreateRestApiRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateRestApiRequest.Builder,CreateRestApiRequest>
  • Method Details

    • name

      The name of the RestApi.

      Parameters:
      name - The name of the RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • description

      CreateRestApiRequest.Builder description(String description)

      The description of the RestApi.

      Parameters:
      description - The description of the RestApi.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • version

      A version identifier for the API.

      Parameters:
      version - A version identifier for the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • cloneFrom

      CreateRestApiRequest.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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • binaryMediaTypes

      CreateRestApiRequest.Builder binaryMediaTypes(Collection<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. By default, the RestApi supports only UTF-8-encoded text payloads.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • binaryMediaTypes

      CreateRestApiRequest.Builder binaryMediaTypes(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. By default, the RestApi supports only UTF-8-encoded text payloads.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • minimumCompressionSize

      CreateRestApiRequest.Builder minimumCompressionSize(Integer 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. 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:
      Returns a reference to this object so that method calls can be chained together.
    • apiKeySource

      CreateRestApiRequest.Builder apiKeySource(String apiKeySource)

      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:
      apiKeySource - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • apiKeySource

      CreateRestApiRequest.Builder apiKeySource(ApiKeySourceType apiKeySource)

      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:
      apiKeySource - 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • endpointConfiguration

      CreateRestApiRequest.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)

      The endpoint configuration of this RestApi showing the endpoint types of the API.

      Parameters:
      endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpointConfiguration

      default CreateRestApiRequest.Builder endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)

      The endpoint configuration of this RestApi showing the endpoint types of the API.

      This is a convenience method that creates an instance of the EndpointConfiguration.Builder avoiding the need to create one manually via EndpointConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(EndpointConfiguration).

      Parameters:
      endpointConfiguration - a consumer that will call methods on EndpointConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • policy

      A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

      Parameters:
      policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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. 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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • disableExecuteApiEndpoint

      CreateRestApiRequest.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. 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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      CreateRestApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.