GraphQLApiProps

class aws_cdk.aws_appsync.GraphQLApiProps(*, name, log_config=None, schema_definition=None, schema_definition_file=None, user_pool_config=None)

Bases: object

__init__(*, name, log_config=None, schema_definition=None, schema_definition_file=None, user_pool_config=None)

Properties for an AppSync GraphQL API.

Parameters
  • name (str) – the name of the GraphQL API.

  • log_config (Optional[LogConfig]) – Logging configuration for this api. Default: - None

  • schema_definition (Optional[str]) – GraphQL schema definition. You have to specify a definition or a file containing one. Default: - Use schemaDefinitionFile

  • schema_definition_file (Optional[str]) – File containing the GraphQL schema definition. You have to specify a definition or a file containing one. Default: - Use schemaDefinition

  • user_pool_config (Optional[UserPoolConfig]) – Optional user pool authorizer configuration. Default: - Do not use Cognito auth

stability :stability: experimental

Attributes

log_config

Logging configuration for this api.

default :default: - None

stability :stability: experimental

Return type

Optional[LogConfig]

name

the name of the GraphQL API.

stability :stability: experimental

Return type

str

schema_definition

GraphQL schema definition.

You have to specify a definition or a file containing one.

default :default: - Use schemaDefinitionFile

stability :stability: experimental

Return type

Optional[str]

schema_definition_file

File containing the GraphQL schema definition.

You have to specify a definition or a file containing one.

default :default: - Use schemaDefinition

stability :stability: experimental

Return type

Optional[str]

user_pool_config

Optional user pool authorizer configuration.

default :default: - Do not use Cognito auth

stability :stability: experimental

Return type

Optional[UserPoolConfig]