[ aws . appsync ]

update-graphql-api

Description

Updates a GraphqlApi object.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-graphql-api
--api-id <value>
--name <value>
[--log-config <value>]
[--authentication-type <value>]
[--user-pool-config <value>]
[--open-id-connect-config <value>]
[--additional-authentication-providers <value>]
[--xray-enabled | --no-xray-enabled]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--api-id (string)

The API ID.

--name (string)

The new name for the GraphqlApi object.

--log-config (structure)

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

fieldLogLevel -> (string)

The field logging level. Values can be NONE, ERROR, or ALL.

• NONE : No field-level logs are captured.

• ERROR : Logs the following information only for the fields that are in error:

  • The error section in the server response.

  • Field-level errors.

  • The generated request/response functions that got resolved for error fields.

• ALL : The following information is logged for all fields in the query:

  • Field-level tracing information.

  • The generated request/response functions that got resolved for each field.

cloudWatchLogsRoleArn -> (string)

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.

excludeVerboseContent -> (boolean)

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

Shorthand Syntax:

fieldLogLevel=string,cloudWatchLogsRoleArn=string,excludeVerboseContent=boolean

JSON Syntax:

{
  "fieldLogLevel": "NONE"|"ERROR"|"ALL",
  "cloudWatchLogsRoleArn": "string",
  "excludeVerboseContent": true|false
}

--authentication-type (string)

The new authentication type for the GraphqlApi object.

Possible values:

• API_KEY

• AWS_IAM

• AMAZON_COGNITO_USER_POOLS

• OPENID_CONNECT

--user-pool-config (structure)

The new Amazon Cognito user pool configuration for the GraphqlApi object.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The AWS Region in which the user pool was created.

defaultAction -> (string)

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn’t match the Amazon Cognito user pool configuration.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

Shorthand Syntax:

userPoolId=string,awsRegion=string,defaultAction=string,appIdClientRegex=string

JSON Syntax:

{
  "userPoolId": "string",
  "awsRegion": "string",
  "defaultAction": "ALLOW"|"DENY",
  "appIdClientRegex": "string"
}

--open-id-connect-config (structure)

The OpenID Connect configuration for the GraphqlApi object.

issuer -> (string)

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds a token is valid after being issued to a user.

authTTL -> (long)

The number of milliseconds a token is valid after being authenticated.

Shorthand Syntax:

issuer=string,clientId=string,iatTTL=long,authTTL=long

JSON Syntax:

{
  "issuer": "string",
  "clientId": "string",
  "iatTTL": long,
  "authTTL": long
}

--additional-authentication-providers (list)

A list of additional authentication providers for the GraphqlApi API.

(structure)

Describes an additional authentication provider.

authenticationType -> (string)

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

openIDConnectConfig -> (structure)

The OpenID Connect configuration.

issuer -> (string)

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds a token is valid after being issued to a user.

authTTL -> (long)

The number of milliseconds a token is valid after being authenticated.

userPoolConfig -> (structure)

The Amazon Cognito user pool configuration.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The AWS Region in which the user pool was created.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

Shorthand Syntax:

authenticationType=string,openIDConnectConfig={issuer=string,clientId=string,iatTTL=long,authTTL=long},userPoolConfig={userPoolId=string,awsRegion=string,appIdClientRegex=string} ...

JSON Syntax:

[
  {
    "authenticationType": "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT",
    "openIDConnectConfig": {
      "issuer": "string",
      "clientId": "string",
      "iatTTL": long,
      "authTTL": long
    },
    "userPoolConfig": {
      "userPoolId": "string",
      "awsRegion": "string",
      "appIdClientRegex": "string"
    }
  }
  ...
]

--xray-enabled | --no-xray-enabled (boolean)

A flag indicating whether to enable X-Ray tracing for the GraphqlApi .

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

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

graphqlApi -> (structure)

The updated GraphqlApi object.

name -> (string)

The API name.

apiId -> (string)

The API ID.

authenticationType -> (string)

The authentication type.

logConfig -> (structure)

The Amazon CloudWatch Logs configuration.

fieldLogLevel -> (string)

The field logging level. Values can be NONE, ERROR, or ALL.

• NONE : No field-level logs are captured.

• ERROR : Logs the following information only for the fields that are in error:

  • The error section in the server response.

  • Field-level errors.

  • The generated request/response functions that got resolved for error fields.

• ALL : The following information is logged for all fields in the query:

  • Field-level tracing information.

  • The generated request/response functions that got resolved for each field.

cloudWatchLogsRoleArn -> (string)

The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.

excludeVerboseContent -> (boolean)

Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.

userPoolConfig -> (structure)

The Amazon Cognito user pool configuration.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The AWS Region in which the user pool was created.

defaultAction -> (string)

The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn’t match the Amazon Cognito user pool configuration.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

openIDConnectConfig -> (structure)

The OpenID Connect configuration.

issuer -> (string)

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds a token is valid after being issued to a user.

authTTL -> (long)

The number of milliseconds a token is valid after being authenticated.

arn -> (string)

The ARN.

uris -> (map)

The URIs.

key -> (string)

value -> (string)

tags -> (map)

The tags.

key -> (string)

The key for the tag.

value -> (string)

The value for the tag.

additionalAuthenticationProviders -> (list)

A list of additional authentication providers for the GraphqlApi API.

(structure)

Describes an additional authentication provider.

authenticationType -> (string)

The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.

openIDConnectConfig -> (structure)

The OpenID Connect configuration.

issuer -> (string)

The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.

clientId -> (string)

The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.

iatTTL -> (long)

The number of milliseconds a token is valid after being issued to a user.

authTTL -> (long)

The number of milliseconds a token is valid after being authenticated.

userPoolConfig -> (structure)

The Amazon Cognito user pool configuration.

userPoolId -> (string)

The user pool ID.

awsRegion -> (string)

The AWS Region in which the user pool was created.

appIdClientRegex -> (string)

A regular expression for validating the incoming Amazon Cognito user pool app client ID.

xrayEnabled -> (boolean)

A flag representing whether X-Ray tracing is enabled for this GraphqlApi .