Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppSync::Types::UpdateGraphqlApiRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing UpdateGraphqlApiRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  api_id: "String", # required
  name: "String", # required
  log_config: {
    field_log_level: "NONE", # required, accepts NONE, ERROR, ALL
    cloud_watch_logs_role_arn: "String", # required
    exclude_verbose_content: false,
  },
  authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
  user_pool_config: {
    user_pool_id: "String", # required
    aws_region: "String", # required
    default_action: "ALLOW", # required, accepts ALLOW, DENY
    app_id_client_regex: "String",
  },
  open_id_connect_config: {
    issuer: "String", # required
    client_id: "String",
    iat_ttl: 1,
    auth_ttl: 1,
  },
  additional_authentication_providers: [
    {
      authentication_type: "API_KEY", # accepts API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT
      open_id_connect_config: {
        issuer: "String", # required
        client_id: "String",
        iat_ttl: 1,
        auth_ttl: 1,
      },
      user_pool_config: {
        user_pool_id: "String", # required
        aws_region: "String", # required
        app_id_client_regex: "String",
      },
    },
  ],
  xray_enabled: false,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.

Returns:

#api_id ⇒ String

The API ID.

Returns:

  • (String) —

    The API ID.

#authentication_type ⇒ String

The new authentication type for the GraphqlApi object.

Possible values:

  • API_KEY
  • AWS_IAM
  • AMAZON_COGNITO_USER_POOLS
  • OPENID_CONNECT

Returns:

  • (String) —

    The new authentication type for the GraphqlApi object.

#log_config ⇒ Types::LogConfig

The Amazon CloudWatch Logs configuration for the GraphqlApi object.

Returns:

  • (Types::LogConfig) —

    The Amazon CloudWatch Logs configuration for the GraphqlApi object.

#name ⇒ String

The new name for the GraphqlApi object.

Returns:

  • (String) —

    The new name for the GraphqlApi object.

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

The OpenID Connect configuration for the GraphqlApi object.

Returns:

#user_pool_config ⇒ Types::UserPoolConfig

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

Returns:

#xray_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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