Package software.amazon.awssdk.services.securityhub.model

Interface AwsApiGatewayV2ApiDetails.Builder

    • Method Detail

      • apiEndpoint

        AwsApiGatewayV2ApiDetails.Builder apiEndpoint​(String apiEndpoint)

        The URI of the API.

        Uses the format <api-id>.execute-api.<region>.amazonaws.com

        The stage name is typically appended to the URI to form a complete path to a deployed API stage.

        Parameters:
        apiEndpoint - The URI of the API.

        Uses the format <api-id>.execute-api.<region>.amazonaws.com

        The stage name is typically appended to the URI to form a complete path to a deployed API stage.

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

      • apiId

        AwsApiGatewayV2ApiDetails.Builder apiId​(String apiId)

        The identifier of the API.

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

      • apiKeySelectionExpression

        AwsApiGatewayV2ApiDetails.Builder apiKeySelectionExpression​(String apiKeySelectionExpression)

        An API key selection expression. Supported only for WebSocket APIs.

        Parameters:
        apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • createdDate

        AwsApiGatewayV2ApiDetails.Builder createdDate​(String createdDate)

        Indicates when the API 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 API 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

        AwsApiGatewayV2ApiDetails.Builder description​(String description)

        A description of the API.

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

      • version

        AwsApiGatewayV2ApiDetails.Builder version​(String version)

        The version identifier for the API.

        Parameters:
        version - The version identifier for the API.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        AwsApiGatewayV2ApiDetails.Builder name​(String name)

        The name of the API.

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

      • protocolType

        AwsApiGatewayV2ApiDetails.Builder protocolType​(String protocolType)

        The API protocol for the API.

        Valid values: WEBSOCKET | HTTP

        Parameters:
        protocolType - The API protocol for the API.

        Valid values: WEBSOCKET | HTTP

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

      • routeSelectionExpression

        AwsApiGatewayV2ApiDetails.Builder routeSelectionExpression​(String routeSelectionExpression)

        The route selection expression for the API.

        For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

        For WebSocket APIs, there is no default value.

        Parameters:
        routeSelectionExpression - The route selection expression for the API.

        For HTTP APIs, must be ${request.method} ${request.path}. This is the default value for HTTP APIs.

        For WebSocket APIs, there is no default value.

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

      • corsConfiguration

        AwsApiGatewayV2ApiDetails.Builder corsConfiguration​(AwsCorsConfiguration corsConfiguration)

        A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.

        Parameters:
        corsConfiguration - A cross-origin resource sharing (CORS) configuration. Supported only for HTTP APIs.
        Returns:
        Returns a reference to this object so that method calls can be chained together.