software.amazon.awssdk.services.apigatewayv2.model

Interface CreateApiRequest.Builder

All Superinterfaces:

ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateApiRequest.Builder,CreateApiRequest>, SdkBuilder<CreateApiRequest.Builder,CreateApiRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateApiRequest

public static interface CreateApiRequest.Builder
extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateApiRequest.Builder,CreateApiRequest>

Method Summary

Modifier and Type	Method and Description
CreateApiRequest.Builder	apiKeySelectionExpression(String apiKeySelectionExpression) An API key selection expression.
default CreateApiRequest.Builder	corsConfiguration(Consumer<Cors.Builder> corsConfiguration) A CORS configuration.
CreateApiRequest.Builder	corsConfiguration(Cors corsConfiguration) A CORS configuration.
CreateApiRequest.Builder	credentialsArn(String credentialsArn) This property is part of quick create.
CreateApiRequest.Builder	description(String description) The description of the API.
CreateApiRequest.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the default execute-api endpoint.
CreateApiRequest.Builder	disableSchemaValidation(Boolean disableSchemaValidation) Avoid validating models when creating a deployment.
CreateApiRequest.Builder	name(String name) The name of the API.
CreateApiRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateApiRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateApiRequest.Builder	protocolType(ProtocolType protocolType) The API protocol.
CreateApiRequest.Builder	protocolType(String protocolType) The API protocol.
CreateApiRequest.Builder	routeKey(String routeKey) This property is part of quick create.
CreateApiRequest.Builder	routeSelectionExpression(String routeSelectionExpression) The route selection expression for the API.
CreateApiRequest.Builder	tags(Map<String,String> tags) The collection of tags.
CreateApiRequest.Builder	target(String target) This property is part of quick create.
CreateApiRequest.Builder	version(String version) A version identifier for the API.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

apiKeySelectionExpression

CreateApiRequest.Builder apiKeySelectionExpression(String 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

CreateApiRequest.Builder corsConfiguration(Cors corsConfiguration)

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Parameters:

corsConfiguration - A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Returns:

Returns a reference to this object so that method calls can be chained together.

corsConfiguration

default CreateApiRequest.Builder corsConfiguration(Consumer<Cors.Builder> corsConfiguration)

A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

This is a convenience method that creates an instance of the Cors.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).

Parameters:

corsConfiguration - a consumer that will call methods on Cors.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

corsConfiguration(Cors)

credentialsArn

CreateApiRequest.Builder credentialsArn(String credentialsArn)

This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

Parameters:

credentialsArn - This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

CreateApiRequest.Builder description(String 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

CreateApiRequest.Builder disableSchemaValidation(Boolean 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

CreateApiRequest.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.

name

CreateApiRequest.Builder name(String 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

CreateApiRequest.Builder protocolType(String 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, ProtocolType

protocolType

CreateApiRequest.Builder protocolType(ProtocolType 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, ProtocolType

routeKey

CreateApiRequest.Builder routeKey(String routeKey)

This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Parameters:

routeKey - This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

routeSelectionExpression

CreateApiRequest.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.

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

CreateApiRequest.Builder tags(Map<String,String> tags)

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

Returns a reference to this object so that method calls can be chained together.

target

CreateApiRequest.Builder target(String target)

This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

Parameters:

target - This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. Supported only for HTTP APIs.

Returns:

Returns a reference to this object so that method calls can be chained together.

version

CreateApiRequest.Builder version(String 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.

overrideConfiguration

CreateApiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateApiRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder