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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#additional_authentication_providersArray<Types::AdditionalAuthenticationProvider>

A list of additional authentication providers for the GraphqlApi API.



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_idString

The API ID.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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

#arnString

The ARN.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_typeString

The authentication type.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_configTypes::LambdaAuthorizerConfig

Configuration for AWS Lambda function authorization.



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_configTypes::LogConfig

The Amazon CloudWatch Logs configuration.

Returns:



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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

#nameString

The API name.

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_configTypes::OpenIDConnectConfig

The OpenID Connect configuration.



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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

#tagsHash<String,String>

The tags.

Returns:

  • (Hash<String,String>)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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

#urisHash<String,String>

The URIs.

Returns:

  • (Hash<String,String>)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_configTypes::UserPoolConfig

The Amazon Cognito user pool configuration.



1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_arnString

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

Returns:

  • (String)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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_enabledBoolean

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

Returns:

  • (Boolean)


1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
# 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