createBackend method

Future<CreateBackendResponse> createBackend({
  1. required String appId,
  2. required String appName,
  3. required String backendEnvironmentName,
  4. ResourceConfig? resourceConfig,
  5. String? resourceName,
})

This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation.

May throw BadRequestException. May throw GatewayTimeoutException. May throw NotFoundException. May throw TooManyRequestsException.

Parameter appId : The app ID.

Parameter appName : The name of the app.

Parameter backendEnvironmentName : The name of the backend environment.

Parameter resourceConfig : The resource configuration for creating a backend.

Parameter resourceName : The name of the resource.

Implementation

Future<CreateBackendResponse> createBackend({
  required String appId,
  required String appName,
  required String backendEnvironmentName,
  ResourceConfig? resourceConfig,
  String? resourceName,
}) async {
  final $payload = <String, dynamic>{
    'appId': appId,
    'appName': appName,
    'backendEnvironmentName': backendEnvironmentName,
    if (resourceConfig != null) 'resourceConfig': resourceConfig,
    if (resourceName != null) 'resourceName': resourceName,
  };
  final response = await _protocol.send(
    payload: $payload,
    method: 'POST',
    requestUri: '/backend',
    exceptionFnMap: _exceptionFns,
  );
  return CreateBackendResponse.fromJson(response);
}