Interface AwsApiGatewayV2StageDetails.Builder

    • Method Detail

      • clientCertificateId

        AwsApiGatewayV2StageDetails.Builder clientCertificateId​(String clientCertificateId)

        The identifier of a client certificate for a stage. Supported only for WebSocket API calls.

        Parameters:
        clientCertificateId - The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • createdDate

        AwsApiGatewayV2StageDetails.Builder createdDate​(String createdDate)

        Indicates when the stage was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        createdDate - Indicates when the stage was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

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

        AwsApiGatewayV2StageDetails.Builder defaultRouteSettings​(AwsApiGatewayV2RouteSettings 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

        AwsApiGatewayV2StageDetails.Builder deploymentId​(String deploymentId)

        The identifier of the deployment that the stage is associated with.

        Parameters:
        deploymentId - The identifier of the deployment that the stage is associated with.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastUpdatedDate

        AwsApiGatewayV2StageDetails.Builder lastUpdatedDate​(String lastUpdatedDate)

        Indicates when the stage was most recently updated.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Parameters:
        lastUpdatedDate - Indicates when the stage was most recently updated.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

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

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

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

        A map that defines the stage variables for the stage.

        Variable names can have alphanumeric and underscore characters.

        Variable values can contain the following characters:

        • Uppercase and lowercase letters

        • Numbers

        • Special characters -._~:/?#&=,

        Parameters:
        stageVariables - A map that defines the stage variables for the stage.

        Variable names can have alphanumeric and underscore characters.

        Variable values can contain the following characters:

        • Uppercase and lowercase letters

        • Numbers

        • Special characters -._~:/?#&=,

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

        AwsApiGatewayV2StageDetails.Builder accessLogSettings​(AwsApiGatewayAccessLogSettings accessLogSettings)

        Information about settings for logging access for the stage.

        Parameters:
        accessLogSettings - Information about settings for logging access for the stage.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • autoDeploy

        AwsApiGatewayV2StageDetails.Builder autoDeploy​(Boolean autoDeploy)

        Indicates whether updates to an API automatically trigger a new deployment.

        Parameters:
        autoDeploy - Indicates whether updates to an API automatically trigger a new deployment.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • lastDeploymentStatusMessage

        AwsApiGatewayV2StageDetails.Builder lastDeploymentStatusMessage​(String lastDeploymentStatusMessage)

        The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.

        Parameters:
        lastDeploymentStatusMessage - The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • apiGatewayManaged

        AwsApiGatewayV2StageDetails.Builder apiGatewayManaged​(Boolean apiGatewayManaged)

        Indicates whether the stage is managed by API Gateway.

        Parameters:
        apiGatewayManaged - Indicates whether the stage is managed by API Gateway.
        Returns:
        Returns a reference to this object so that method calls can be chained together.