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

Interface CreateDeploymentRequest.Builder

    • Method Detail

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

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

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