GraphqlApiProps¶
-
class
aws_cdk.aws_appsync.
GraphqlApiProps
(*, name, authorization_config=None, log_config=None, schema=None, xray_enabled=None)¶ Bases:
object
(experimental) Properties for an AppSync GraphQL API.
- Parameters
name (
str
) – (experimental) the name of the GraphQL API.authorization_config (
Optional
[AuthorizationConfig
]) – (experimental) Optional authorization configuration. Default: - API Key authorizationlog_config (
Optional
[LogConfig
]) – (experimental) Logging configuration for this api. Default: - Noneschema (
Optional
[Schema
]) – (experimental) GraphQL schema definition. Specify how you want to define your schema. Schema.fromFile(filePath: string) allows schema definition through schema.graphql file Default: - schema will be generated code-first (i.e. addType, addObjectType, etc.)xray_enabled (
Optional
[bool
]) – (experimental) A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API. Default: - false
- Stability
experimental
Attributes
(experimental) Optional authorization configuration.
- Default
API Key authorization
- Stability
experimental
- Return type
Optional
[AuthorizationConfig
]
-
log_config
¶ (experimental) Logging configuration for this api.
- Default
None
- Stability
experimental
- Return type
Optional
[LogConfig
]
-
name
¶ (experimental) the name of the GraphQL API.
- Stability
experimental
- Return type
str
-
schema
¶ (experimental) GraphQL schema definition. Specify how you want to define your schema.
Schema.fromFile(filePath: string) allows schema definition through schema.graphql file
- Default
schema will be generated code-first (i.e. addType, addObjectType, etc.)
- Stability
experimental
- Return type
Optional
[Schema
]
-
xray_enabled
¶ (experimental) A flag indicating whether or not X-Ray tracing is enabled for the GraphQL API.
- Default
false
- Stability
experimental
- Return type
Optional
[bool
]