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

Inherits:

Struct

• Object
• Struct
• Aws::AppSync::Types::GraphqlApi

Defined in:

gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Describes a GraphQL API.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>

  A list of additional authentication providers for the GraphqlApi API.

• #api_id ⇒ String

  The API ID.

• #arn ⇒ String

  The ARN.

• #authentication_type ⇒ String

  The authentication type.

• #lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig

  Configuration for AWS Lambda function authorization.

• #log_config ⇒ Types::LogConfig

  The Amazon CloudWatch Logs configuration.

• #name ⇒ String

  The API name.

• #open_id_connect_config ⇒ Types::OpenIDConnectConfig

  The OpenID Connect configuration.

• #tags ⇒ Hash<String,String>

  The tags.

• #uris ⇒ Hash<String,String>

  The URIs.

• #user_pool_config ⇒ Types::UserPoolConfig

  The Amazon Cognito user pool configuration.

• #waf_web_acl_arn ⇒ String

  The ARN of the WAF ACL associated with this GraphqlApi, if one exists.

• #xray_enabled ⇒ Boolean

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

Instance Attribute Details

#additional_authentication_providers ⇒ Array<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.

Returns:

• (Array<Types::AdditionalAuthenticationProvider>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#api_id ⇒ String

The API ID.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The ARN.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#authentication_type ⇒ String

The authentication type.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#lambda_authorizer_config ⇒ Types::LambdaAuthorizerConfig

Configuration for AWS Lambda function authorization.

Returns:

• (Types::LambdaAuthorizerConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#log_config ⇒ Types::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:

• (Types::LogConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The API name.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#open_id_connect_config ⇒ Types::OpenIDConnectConfig

The OpenID Connect configuration.

Returns:

• (Types::OpenIDConnectConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#uris ⇒ Hash<String,String>

The URIs.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#user_pool_config ⇒ Types::UserPoolConfig

The Amazon Cognito user pool configuration.

Returns:

• (Types::UserPoolConfig)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#waf_web_acl_arn ⇒ String

The ARN of the WAF ACL associated with this GraphqlApi, if one exists.

Returns:

• (String)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end

#xray_enabled ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1960

class GraphqlApi < Struct.new(
  :name,
  :api_id,
  :authentication_type,
  :log_config,
  :user_pool_config,
  :open_id_connect_config,
  :arn,
  :uris,
  :tags,
  :additional_authentication_providers,
  :xray_enabled,
  :waf_web_acl_arn,
  :lambda_authorizer_config)
  SENSITIVE = []
  include Aws::Structure
end