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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb

Overview

Describes a GraphQL API.

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providersArray<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#api_idString

The API ID.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#arnString

The ARN.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#authentication_typeString

The authentication type.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#log_configTypes::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#nameString

The API name.

Returns:

  • (String)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#open_id_connect_configTypes::OpenIDConnectConfig

The OpenID Connect configuration.



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#tagsHash<String,String>

The tags.

Returns:

  • (Hash<String,String>)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#urisHash<String,String>

The URIs.

Returns:

  • (Hash<String,String>)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#user_pool_configTypes::UserPoolConfig

The Amazon Cognito user pool configuration.



1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end

#xray_enabledBoolean

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

Returns:

  • (Boolean)


1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
# File 'gems/aws-sdk-appsync/lib/aws-sdk-appsync/types.rb', line 1777

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)
  include Aws::Structure
end