Interface CreateRestApiRequest.Builder
- All Superinterfaces:
ApiGatewayRequest.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateRestApiRequest.Builder,
,CreateRestApiRequest> SdkBuilder<CreateRestApiRequest.Builder,
,CreateRestApiRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateRestApiRequest
-
Method Summary
Modifier and TypeMethodDescriptionapiKeySource
(String apiKeySource) The source of the API key for metering requests according to a usage plan.apiKeySource
(ApiKeySourceType apiKeySource) The source of the API key for metering requests according to a usage plan.binaryMediaTypes
(String... binaryMediaTypes) The list of binary media types supported by the RestApi.binaryMediaTypes
(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.The ID of the RestApi that you want to clone from.description
(String description) The description of the RestApi.disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the defaultexecute-api
endpoint.default CreateRestApiRequest.Builder
endpointConfiguration
(Consumer<EndpointConfiguration.Builder> endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.endpointConfiguration
(EndpointConfiguration endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.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.The name of the RestApi.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.The key-value map of strings.A version identifier for the API.Methods inherited from interface software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
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
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
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
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
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
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
The source of the API key for metering requests according to a usage plan. Valid values are:
HEADER
to read the API key from theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
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 theX-API-Key
header of a request.AUTHORIZER
to read the API key from theUsageIdentifierKey
from a custom authorizer.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theEndpointConfiguration.Builder
avoiding the need to create one manually viaEndpointConfiguration.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toendpointConfiguration(EndpointConfiguration)
.- Parameters:
endpointConfiguration
- a consumer that will call methods onEndpointConfiguration.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 withaws:
. 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
Specifies whether clients can invoke your API by using the default
execute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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 defaultexecute-api
endpoint. By default, clients can invoke your API with the defaulthttps://{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 interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateRestApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-