Interface CreateStageRequest.Builder
- All Superinterfaces:
ApiGatewayV2Request.Builder
,AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateStageRequest.Builder,
,CreateStageRequest> SdkBuilder<CreateStageRequest.Builder,
,CreateStageRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateStageRequest
-
Method Summary
Modifier and TypeMethodDescriptiondefault CreateStageRequest.Builder
accessLogSettings
(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.accessLogSettings
(AccessLogSettings accessLogSettings) Settings for logging access in this stage.The API identifier.autoDeploy
(Boolean autoDeploy) Specifies whether updates to an API automatically trigger a new deployment.clientCertificateId
(String clientCertificateId) The identifier of a client certificate for a Stage.default CreateStageRequest.Builder
defaultRouteSettings
(Consumer<RouteSettings.Builder> defaultRouteSettings) The default route settings for the stage.defaultRouteSettings
(RouteSettings defaultRouteSettings) The default route settings for the stage.deploymentId
(String deploymentId) The deployment identifier of the API stage.description
(String description) The description for the API stage.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.routeSettings
(Map<String, RouteSettings> routeSettings) Route settings for the stage, by routeKey.The name of the stage.stageVariables
(Map<String, String> stageVariables) A map that defines the stage variables for a Stage.The collection of tags.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.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
-
accessLogSettings
Settings for logging access in this stage.
- Parameters:
accessLogSettings
- Settings for logging access in this stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
accessLogSettings
default CreateStageRequest.Builder accessLogSettings(Consumer<AccessLogSettings.Builder> accessLogSettings) Settings for logging access in this stage.
This is a convenience method that creates an instance of theAccessLogSettings.Builder
avoiding the need to create one manually viaAccessLogSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toaccessLogSettings(AccessLogSettings)
.- Parameters:
accessLogSettings
- a consumer that will call methods onAccessLogSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
apiId
The API identifier.
- Parameters:
apiId
- The API identifier.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
autoDeploy
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
- Parameters:
autoDeploy
- Specifies whether updates to an API automatically trigger a new deployment. The default value is false.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
clientCertificateId
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
- Parameters:
clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultRouteSettings
The default route settings for the stage.
- Parameters:
defaultRouteSettings
- The default route settings for the stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
defaultRouteSettings
default CreateStageRequest.Builder defaultRouteSettings(Consumer<RouteSettings.Builder> defaultRouteSettings) The default route settings for the stage.
This is a convenience method that creates an instance of theRouteSettings.Builder
avoiding the need to create one manually viaRouteSettings.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todefaultRouteSettings(RouteSettings)
.- Parameters:
defaultRouteSettings
- a consumer that will call methods onRouteSettings.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
deploymentId
The deployment identifier of the API stage.
- Parameters:
deploymentId
- The deployment identifier of the API stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
description
The description for the API stage.
- Parameters:
description
- The description for the API stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
routeSettings
Route settings for the stage, by routeKey.
- Parameters:
routeSettings
- Route settings for the stage, by routeKey.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stageName
The name of the stage.
- Parameters:
stageName
- The name of the stage.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
stageVariables
A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
- Parameters:
stageVariables
- A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
overrideConfiguration
CreateStageRequest.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
CreateStageRequest.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.
-