public static interface CreateApiResponse.Builder extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>
Modifier and Type | Method and Description |
---|---|
CreateApiResponse.Builder |
apiEndpoint(String apiEndpoint)
The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
|
CreateApiResponse.Builder |
apiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether an API is managed by API Gateway.
|
CreateApiResponse.Builder |
apiId(String apiId)
The API ID.
|
CreateApiResponse.Builder |
apiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression.
|
default CreateApiResponse.Builder |
corsConfiguration(Consumer<Cors.Builder> corsConfiguration)
A CORS configuration.
|
CreateApiResponse.Builder |
corsConfiguration(Cors corsConfiguration)
A CORS configuration.
|
CreateApiResponse.Builder |
createdDate(Instant createdDate)
The timestamp when the API was created.
|
CreateApiResponse.Builder |
description(String description)
The description of the API.
|
CreateApiResponse.Builder |
disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)
Specifies whether clients can invoke your API by using the default execute-api endpoint.
|
CreateApiResponse.Builder |
disableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment.
|
CreateApiResponse.Builder |
importInfo(Collection<String> importInfo)
The validation information during API import.
|
CreateApiResponse.Builder |
importInfo(String... importInfo)
The validation information during API import.
|
CreateApiResponse.Builder |
name(String name)
The name of the API.
|
CreateApiResponse.Builder |
protocolType(ProtocolType protocolType)
The API protocol.
|
CreateApiResponse.Builder |
protocolType(String protocolType)
The API protocol.
|
CreateApiResponse.Builder |
routeSelectionExpression(String routeSelectionExpression)
The route selection expression for the API.
|
CreateApiResponse.Builder |
tags(Map<String,String> tags)
A collection of tags associated with the API.
|
CreateApiResponse.Builder |
version(String version)
A version identifier for the API.
|
CreateApiResponse.Builder |
warnings(Collection<String> warnings)
The warning messages reported when failonwarnings is turned on during API import.
|
CreateApiResponse.Builder |
warnings(String... warnings)
The warning messages reported when failonwarnings is turned on during API import.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateApiResponse.Builder apiEndpoint(String 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.
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.CreateApiResponse.Builder apiGatewayManaged(Boolean 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.
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.CreateApiResponse.Builder apiId(String apiId)
The API ID.
apiId
- The API ID.CreateApiResponse.Builder apiKeySelectionExpression(String apiKeySelectionExpression)
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.CreateApiResponse.Builder corsConfiguration(Cors corsConfiguration)
A CORS configuration. Supported only for HTTP APIs.
corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.default CreateApiResponse.Builder corsConfiguration(Consumer<Cors.Builder> corsConfiguration)
A CORS configuration. Supported only for HTTP APIs.
This is a convenience that creates an instance of theCors.Builder
avoiding the need to create one
manually via Cors.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result is
passed to corsConfiguration(Cors)
.corsConfiguration
- a consumer that will call methods on Cors.Builder
corsConfiguration(Cors)
CreateApiResponse.Builder createdDate(Instant createdDate)
The timestamp when the API was created.
createdDate
- The timestamp when the API was created.CreateApiResponse.Builder description(String description)
The description of the API.
description
- The description of the API.CreateApiResponse.Builder disableSchemaValidation(Boolean disableSchemaValidation)
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for WebSocket APIs.CreateApiResponse.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.
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.CreateApiResponse.Builder importInfo(Collection<String> 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.
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.CreateApiResponse.Builder importInfo(String... 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.
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.CreateApiResponse.Builder name(String name)
The name of the API.
name
- The name of the API.CreateApiResponse.Builder protocolType(String protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
,
ProtocolType
CreateApiResponse.Builder protocolType(ProtocolType protocolType)
The API protocol.
protocolType
- The API protocol.ProtocolType
,
ProtocolType
CreateApiResponse.Builder routeSelectionExpression(String 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.
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.CreateApiResponse.Builder tags(Map<String,String> tags)
A collection of tags associated with the API.
tags
- A collection of tags associated with the API.CreateApiResponse.Builder version(String version)
A version identifier for the API.
version
- A version identifier for the API.CreateApiResponse.Builder warnings(Collection<String> warnings)
The warning messages reported when failonwarnings is turned on during API import.
warnings
- The warning messages reported when failonwarnings is turned on during API import.CreateApiResponse.Builder warnings(String... warnings)
The warning messages reported when failonwarnings is turned on during API import.
warnings
- The warning messages reported when failonwarnings is turned on during API import.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.