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

Interface CreateStageRequest.Builder

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

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

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