Package software.amazon.awssdk.services.apigatewayv2.model

Interface Stage.Builder

    • Method Detail

      • accessLogSettings

        Stage.Builder accessLogSettings​(AccessLogSettings 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.

      • apiGatewayManaged

        Stage.Builder apiGatewayManaged​(Boolean apiGatewayManaged)

        Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

        Parameters:
        apiGatewayManaged - Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • autoDeploy

        Stage.Builder autoDeploy​(Boolean 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

        Stage.Builder clientCertificateId​(String 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.

      • createdDate

        Stage.Builder createdDate​(Instant createdDate)

        The timestamp when the stage was created.

        Parameters:
        createdDate - The timestamp when the stage was created.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • defaultRouteSettings

        Stage.Builder defaultRouteSettings​(RouteSettings defaultRouteSettings)

        Default route settings for the stage.

        Parameters:
        defaultRouteSettings - Default route settings for the stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • deploymentId

        Stage.Builder deploymentId​(String deploymentId)

        The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

        Parameters:
        deploymentId - The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        Stage.Builder description​(String description)

        The description of the stage.

        Parameters:
        description - The description of the stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastDeploymentStatusMessage

        Stage.Builder lastDeploymentStatusMessage​(String lastDeploymentStatusMessage)

        Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

        Parameters:
        lastDeploymentStatusMessage - Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • lastUpdatedDate

        Stage.Builder lastUpdatedDate​(Instant lastUpdatedDate)

        The timestamp when the stage was last updated.

        Parameters:
        lastUpdatedDate - The timestamp when the stage was last updated.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • routeSettings

        Stage.Builder routeSettings​(Map<String,​RouteSettings> 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

        Stage.Builder stageName​(String 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

        Stage.Builder stageVariables​(Map<String,​String> stageVariables)

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

      • tags

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