software.amazon.awssdk.services.apigateway.model

Interface CreateStageRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkBuilder<CreateStageRequest.Builder,CreateStageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateStageRequest

public static interface CreateStageRequest.Builder
extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Method Summary

Modifier and Type	Method and Description
CreateStageRequest.Builder	cacheClusterEnabled(Boolean cacheClusterEnabled) Whether cache clustering is enabled for the stage.
CreateStageRequest.Builder	cacheClusterSize(String cacheClusterSize) The stage's cache capacity in GB.
CreateStageRequest.Builder	canarySettings(CanarySettings canarySettings) The canary deployment settings of this stage.
default CreateStageRequest.Builder	canarySettings(Consumer<CanarySettings.Builder> canarySettings) The canary deployment settings of this stage.
CreateStageRequest.Builder	deploymentId(String deploymentId) The identifier of the Deployment resource for the Stage resource.
CreateStageRequest.Builder	description(String description) The description of the Stage resource.
CreateStageRequest.Builder	documentationVersion(String documentationVersion) The version of the associated API documentation.
CreateStageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateStageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateStageRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.
CreateStageRequest.Builder	stageName(String stageName) The name for the Stage resource.
CreateStageRequest.Builder	tags(Map<String,String> tags) The key-value map of strings.
CreateStageRequest.Builder	tracingEnabled(Boolean tracingEnabled) Specifies whether active tracing with X-ray is enabled for the Stage.
CreateStageRequest.Builder	variables(Map<String,String> variables) A map that defines the stage variables for the new Stage resource.

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

restApiId

CreateStageRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

stageName

CreateStageRequest.Builder stageName(String stageName)

The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Parameters:

stageName - The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns:

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

deploymentId

CreateStageRequest.Builder deploymentId(String deploymentId)

The identifier of the Deployment resource for the Stage resource.

Parameters:

deploymentId - The identifier of the Deployment resource for the Stage resource.

Returns:

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

description

CreateStageRequest.Builder description(String description)

The description of the Stage resource.

Parameters:

description - The description of the Stage resource.

Returns:

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

cacheClusterEnabled

CreateStageRequest.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

Whether cache clustering is enabled for the stage.

Parameters:

cacheClusterEnabled - Whether cache clustering is enabled for the stage.

Returns:

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

cacheClusterSize

CreateStageRequest.Builder cacheClusterSize(String cacheClusterSize)

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Parameters:

cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

Returns:

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

variables

CreateStageRequest.Builder variables(Map<String,String> variables)

A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Parameters:

variables - A map that defines the stage variables for the new Stage resource. 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.

documentationVersion

CreateStageRequest.Builder documentationVersion(String documentationVersion)

The version of the associated API documentation.

Parameters:

documentationVersion - The version of the associated API documentation.

Returns:

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

canarySettings

CreateStageRequest.Builder canarySettings(CanarySettings canarySettings)

The canary deployment settings of this stage.

Parameters:

canarySettings - The canary deployment settings of this stage.

Returns:

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

canarySettings

default CreateStageRequest.Builder canarySettings(Consumer<CanarySettings.Builder> canarySettings)

The canary deployment settings of this stage.

This is a convenience method that creates an instance of the CanarySettings.Builder avoiding the need to create one manually via CanarySettings.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to canarySettings(CanarySettings).

Parameters:

canarySettings - a consumer that will call methods on CanarySettings.Builder

Returns:

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

See Also:

canarySettings(CanarySettings)

tracingEnabled

CreateStageRequest.Builder tracingEnabled(Boolean tracingEnabled)

Specifies whether active tracing with X-ray is enabled for the Stage.

Parameters:

tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:

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

tags

CreateStageRequest.Builder tags(Map<String,String> 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 with aws:. The tag value can be up to 256 characters.

Returns:

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

overrideConfiguration

CreateStageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder