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

Class: Aws::AppSync::Types::GraphqlApi

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

Overview

Describes a GraphQL API.

Returned by:

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.

#arn ⇒ String

The ARN.

Returns:

  • (String) —

    The ARN.

#authentication_type ⇒ String

The authentication type.

Possible values:

  • API_KEY
  • AWS_IAM
  • AMAZON_COGNITO_USER_POOLS
  • OPENID_CONNECT

Returns:

  • (String) —

    The authentication type.

#log_config ⇒ Types::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:

#name ⇒ String

The API name.

Returns:

  • (String) —

    The API name.

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

The OpenID Connect configuration.

Returns:

#tags ⇒ Hash<String,String>

The tags.

Returns:

  • (Hash<String,String>) —

    The tags.

#uris ⇒ Hash<String,String>

The URIs.

Returns:

  • (Hash<String,String>) —

    The URIs.

#user_pool_config ⇒ Types::UserPoolConfig

The Amazon Cognito user pool configuration.

Returns:

#waf_web_acl_arn ⇒ String

The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi, if one exists.

Returns:

  • (String) —

    The ARN of the AWS Web Application Firewall (WAF) ACL associated with this GraphqlApi, if one exists.

#xray_enabled ⇒ Boolean

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

Returns:

  • (Boolean) —

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