Interface Api.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<Api.Builder,
,Api> SdkBuilder<Api.Builder,
,Api> SdkPojo
- Enclosing class:
Api
-
Method Summary
Modifier and TypeMethodDescriptionapiEndpoint
(String apiEndpoint) The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.apiGatewayManaged
(Boolean apiGatewayManaged) Specifies whether an API is managed by API Gateway.The API ID.apiKeySelectionExpression
(String apiKeySelectionExpression) An API key selection expression.default Api.Builder
corsConfiguration
(Consumer<Cors.Builder> corsConfiguration) A CORS configuration.corsConfiguration
(Cors corsConfiguration) A CORS configuration.createdDate
(Instant createdDate) The timestamp when the API was created.description
(String description) The description of the API.disableExecuteApiEndpoint
(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the default execute-api endpoint.disableSchemaValidation
(Boolean disableSchemaValidation) Avoid validating models when creating a deployment.importInfo
(String... importInfo) The validation information during API import.importInfo
(Collection<String> importInfo) The validation information during API import.The name of the API.protocolType
(String protocolType) The API protocol.protocolType
(ProtocolType protocolType) The API protocol.routeSelectionExpression
(String routeSelectionExpression) The route selection expression for the API.A collection of tags associated with the API.A version identifier for the API.The warning messages reported when failonwarnings is turned on during API import.warnings
(Collection<String> warnings) The warning messages reported when failonwarnings is turned on during API import.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
-
apiEndpoint
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.
- Parameters:
apiEndpoint
- The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiGatewayManaged
Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.
- Parameters:
apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiId
The API ID.
- Parameters:
apiId
- The API ID.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
apiKeySelectionExpression
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
- Parameters:
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
- Parameters:
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
corsConfiguration
A CORS configuration. Supported only for HTTP APIs.
This is a convenience method that creates an instance of theCors.Builder
avoiding the need to create one manually viaCors.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocorsConfiguration(Cors)
.- Parameters:
corsConfiguration
- a consumer that will call methods onCors.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
createdDate
The timestamp when the API was created.
- Parameters:
createdDate
- The timestamp when the API was created.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description of the API.
- Parameters:
description
- The description of the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
disableSchemaValidation
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
- Parameters:
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.- 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 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.
-
importInfo
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
- Parameters:
importInfo
- The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
importInfo
The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.
- Parameters:
importInfo
- The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
name
The name of the API.
- Parameters:
name
- The name of the API.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
protocolType
The API protocol.
- Parameters:
protocolType
- The API protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
protocolType
The API protocol.
- Parameters:
protocolType
- The API protocol.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
routeSelectionExpression
The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.
- Parameters:
routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
A collection of tags associated with the API.
- Parameters:
tags
- A collection of tags associated with the API.- 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.
-
warnings
The warning messages reported when failonwarnings is turned on during API import.
- Parameters:
warnings
- The warning messages reported when failonwarnings is turned on during API import.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
warnings
The warning messages reported when failonwarnings is turned on during API import.
- Parameters:
warnings
- The warning messages reported when failonwarnings is turned on during API import.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-