createApi method

Future<CreateApiResponse> createApi({ required String name, required ProtocolType protocolType, String? apiKeySelectionExpression, Cors? corsConfiguration, String? credentialsArn, String? description, bool? disableExecuteApiEndpoint, bool? disableSchemaValidation, String? routeKey, String? routeSelectionExpression, Map<String, String>? tags, String? target, String? version, })

Creates an Api resource.

May throw NotFoundException. May throw TooManyRequestsException. May throw BadRequestException. May throw ConflictException.

Parameter name : The name of the API.

Parameter protocolType : The API protocol.

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

Parameter corsConfiguration : A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.

Parameter 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, specify null. Currently, this property is not used for HTTP integrations. Supported only for HTTP APIs.

Parameter description : The description of the API.

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

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

Parameter routeKey : This property is part of quick create. If you don't specify a routeKey, a default route of $default is created. The $default route acts as a catch-all for any request made to your API, for a particular stage. The $default route key can't be modified. You can add routes after creating the API, and you can update the route keys of additional routes. Supported only for HTTP APIs.

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

Parameter tags : The collection of tags. Each tag element is associated with a given resource.

Parameter target : This property is part of quick create. Quick create produces an API with an integration, a default catch-all route, and a default stage which is configured to automatically deploy changes. 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. Supported only for HTTP APIs.

Parameter version : A version identifier for the API.

Implementation

Future<CreateApiResponse> createApi({
  required String name,
  required ProtocolType protocolType,
  String? apiKeySelectionExpression,
  Cors? corsConfiguration,
  String? credentialsArn,
  String? description,
  bool? disableExecuteApiEndpoint,
  bool? disableSchemaValidation,
  String? routeKey,
  String? routeSelectionExpression,
  Map<String, String>? tags,
  String? target,
  String? version,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  ArgumentError.checkNotNull(protocolType, 'protocolType');
  final $payload = <String, dynamic>{
    'name': name,
    'protocolType': protocolType.toValue(),
    if (apiKeySelectionExpression != null)
      'apiKeySelectionExpression': apiKeySelectionExpression,
    if (corsConfiguration != null) 'corsConfiguration': corsConfiguration,
    if (credentialsArn != null) 'credentialsArn': credentialsArn,
    if (description != null) 'description': description,
    if (disableExecuteApiEndpoint != null)
      'disableExecuteApiEndpoint': disableExecuteApiEndpoint,
    if (disableSchemaValidation != null)
      'disableSchemaValidation': disableSchemaValidation,
    if (routeKey != null) 'routeKey': routeKey,
    if (routeSelectionExpression != null)
      'routeSelectionExpression': routeSelectionExpression,
    if (tags != null) 'tags': tags,
    if (target != null) 'target': target,
    if (version != null) 'version': version,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/v2/apis',
    exceptionFnMap: _exceptionFns,
  );
  return CreateApiResponse.fromJson(response);
}