[ aws . amplifybackend ]

update-backend-api

Description

Updates an existing backend API resource.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-backend-api
--app-id <value>
--backend-environment-name <value>
[--resource-config <value>]
--resource-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--app-id (string)

The app ID.

--backend-environment-name (string)

The name of the backend environment.

--resource-config (structure)

Defines the resource configuration for the data model in your Amplify project.

AdditionalAuthTypes -> (list)

Additional authentication methods used to interact with your data models.

(structure)

Describes the auth types for your configured data models.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID is used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID is used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The openID provider name, if openID is used as an authentication mechanism to access your data models.

ApiName -> (string)

The API name used to interact with the data model, configured as a part of the Amplify project.

ConflictResolution -> (structure)

The conflict resolution strategy for your data stored in the data models.

ResolutionStrategy -> (string)

The strategy for conflict resolution.

DefaultAuthType -> (structure)

The default authentication type for interacting with the configured data models in your Amplify project.

Mode -> (string)

Describes the authentication mode.

Settings -> (structure)

Describes settings for the authentication mode.

CognitoUserPoolId -> (string)

The Amazon Cognito user pool ID, if Amazon Cognito is used as an authentication setting to access your data models.

Description -> (string)

The API key description for API_KEY, if it is used as an authentication mechanism to access your data models.

ExpirationTime -> (double)

The API key expiration time for API_KEY, if it is used as an authentication mechanism to access your data models.

OpenIDAuthTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDClientId -> (string)

The clientID for openID, if openID is used as an authentication setting to access your data models.

OpenIDIatTTL -> (string)

The expiry time for the OpenID authentication mechanism.

OpenIDIssueURL -> (string)

The openID issuer URL, if openID is used as an authentication setting to access your data models.

OpenIDProviderName -> (string)

The openID provider name, if openID is used as an authentication mechanism to access your data models.

Service -> (string)

The service used to provision and interact with the data model.

TransformSchema -> (string)

The definition of the data model in the annotated transform of the GraphQL schema.

JSON Syntax:

{
  "AdditionalAuthTypes": [
    {
      "Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
      "Settings": {
        "CognitoUserPoolId": "string",
        "Description": "string",
        "ExpirationTime": double,
        "OpenIDAuthTTL": "string",
        "OpenIDClientId": "string",
        "OpenIDIatTTL": "string",
        "OpenIDIssueURL": "string",
        "OpenIDProviderName": "string"
      }
    }
    ...
  ],
  "ApiName": "string",
  "ConflictResolution": {
    "ResolutionStrategy": "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"
  },
  "DefaultAuthType": {
    "Mode": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
    "Settings": {
      "CognitoUserPoolId": "string",
      "Description": "string",
      "ExpirationTime": double,
      "OpenIDAuthTTL": "string",
      "OpenIDClientId": "string",
      "OpenIDIatTTL": "string",
      "OpenIDIssueURL": "string",
      "OpenIDProviderName": "string"
    }
  },
  "Service": "string",
  "TransformSchema": "string"
}

--resource-name (string)

The name of this resource.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

AppId -> (string)

The app ID.

BackendEnvironmentName -> (string)

The name of the backend environment.

Error -> (string)

If the request failed, this is the returned error.

JobId -> (string)

The ID for the job.

Operation -> (string)

The name of the operation.

Status -> (string)

The current status of the request.