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

Class UpdateApiRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request
software.amazon.awssdk.services.apigatewayv2.model.UpdateApiRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateApiRequest.Builder,UpdateApiRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateApiRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateApiRequest.Builder,UpdateApiRequest>

Updates an Api.

  • Method Details

    • apiId

      public final String apiId()

      The API identifier.

      Returns:
      The API identifier.

    • apiKeySelectionExpression

      public final String apiKeySelectionExpression()

      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

      Returns:
      An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

    • corsConfiguration

      public final Cors corsConfiguration()

      A CORS configuration. Supported only for HTTP APIs.

      Returns:
      A CORS configuration. Supported only for HTTP APIs.

    • credentialsArn

      public final String credentialsArn()

      This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

      Returns:
      This property is part of quick create. It specifies the credentials required for the integration, if any. For a Lambda integration, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, don't specify this parameter. Currently, this property is not used for HTTP integrations. If provided, this value replaces the credentials associated with the quick create integration. Supported only for HTTP APIs.

    • description

      public final String description()

      The description of the API.

      Returns:
      The description of the API.

    • disableSchemaValidation

      public final Boolean disableSchemaValidation()

      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

      Returns:
      Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

    • disableExecuteApiEndpoint

      public final Boolean disableExecuteApiEndpoint()

      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

      Returns:
      Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

    • name

      public final String name()

      The name of the API.

      Returns:
      The name of the API.

    • routeKey

      public final String routeKey()

      This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

      Returns:
      This property is part of quick create. If not specified, the route created using quick create is kept. Otherwise, this value replaces the route key of the quick create route. Additional routes may still be added after the API is updated. Supported only for HTTP APIs.

    • routeSelectionExpression

      public final String routeSelectionExpression()

      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

      Returns:
      The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

    • target

      public final String target()

      This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

      Returns:
      This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

    • version

      public final String version()

      A version identifier for the API.

      Returns:
      A version identifier for the API.

    • toBuilder

      public UpdateApiRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateApiRequest.Builder,UpdateApiRequest>
      Specified by:
      toBuilder in class ApiGatewayV2Request
      Returns:
      a builder for type T

    • builder

      public static UpdateApiRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateApiRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.