Interface AwsApiGatewayV2ApiDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>, SdkBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>, SdkPojo
Enclosing class:
AwsApiGatewayV2ApiDetails
@Mutable @NotThreadSafe public static interface AwsApiGatewayV2ApiDetails.Builder extends SdkPojo, CopyableBuilder<AwsApiGatewayV2ApiDetails.Builder,AwsApiGatewayV2ApiDetails>

  • Method Details

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

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Parameters:
      createdDate - Indicates when the API was created.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      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.

    • corsConfiguration

      default AwsApiGatewayV2ApiDetails.Builder corsConfiguration(Consumer<AwsCorsConfiguration.Builder> corsConfiguration)

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

      This is a convenience method that creates an instance of the AwsCorsConfiguration.Builder avoiding the need to create one manually via AwsCorsConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to corsConfiguration(AwsCorsConfiguration).

      Parameters:
      corsConfiguration - a consumer that will call methods on AwsCorsConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: