Package software.amazon.awssdk.services.apigateway.model

Interface CreateDeploymentRequest.Builder

All Superinterfaces:
ApiGatewayRequest.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateDeploymentRequest
public static interface CreateDeploymentRequest.Builder extends ApiGatewayRequest.Builder, SdkPojo, CopyableBuilder<CreateDeploymentRequest.Builder,CreateDeploymentRequest>

  • Method Details

    • restApiId

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

      CreateDeploymentRequest.Builder stageName(String stageName)

      The name of the Stage resource for the Deployment resource to create.

      Parameters:
      stageName - The name of the Stage resource for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stageDescription

      CreateDeploymentRequest.Builder stageDescription(String stageDescription)

      The description of the Stage resource for the Deployment resource to create.

      Parameters:
      stageDescription - The description of the Stage resource for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateDeploymentRequest.Builder description(String description)

      The description for the Deployment resource to create.

      Parameters:
      description - The description for the Deployment resource to create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheClusterEnabled

      CreateDeploymentRequest.Builder cacheClusterEnabled(Boolean cacheClusterEnabled)

      Enables a cache cluster for the Stage resource specified in the input.

      Parameters:
      cacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cacheClusterSize

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

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

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

    • canarySettings

      CreateDeploymentRequest.Builder canarySettings(DeploymentCanarySettings canarySettings)

      The input configuration for the canary deployment when the deployment is a canary release deployment.

      Parameters:
      canarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • canarySettings

      default CreateDeploymentRequest.Builder canarySettings(Consumer<DeploymentCanarySettings.Builder> canarySettings)

      The input configuration for the canary deployment when the deployment is a canary release deployment.

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

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

      Parameters:
      canarySettings - a consumer that will call methods on DeploymentCanarySettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tracingEnabled

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

    • overrideConfiguration

      CreateDeploymentRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateDeploymentRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.