GraphQLApi

class GraphQLApi : KotlinCustomResource

Properties

Link copied to clipboard

One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.

Link copied to clipboard
val apiType: Output<String>?

API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.

Link copied to clipboard
val arn: Output<String>

ARN

Link copied to clipboard

Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA

Link copied to clipboard

Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.

Link copied to clipboard
val id: Output<String>
Link copied to clipboard

Sets the value of the GraphQL API to enable (ENABLED) or disable (DISABLED) introspection. If no value is provided, the introspection configuration will be set to ENABLED by default. This field will produce an error if the operation attempts to use the introspection feature while this field is disabled. For more information about introspection, see GraphQL introspection.

Link copied to clipboard

Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.

Link copied to clipboard

Nested argument containing logging configuration. See log_config Block for details.

Link copied to clipboard

ARN of the execution role when api_type is set to MERGED.

Link copied to clipboard
val name: Output<String>

User-supplied name for the GraphQL API. The following arguments are optional:

Link copied to clipboard

Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.

Link copied to clipboard
val pulumiChildResources: Set<KotlinResource>
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val queryDepthLimit: Output<Int>?

The maximum depth a query can have in a single request. Depth refers to the amount of nested levels allowed in the body of query. The default value is 0 (or unspecified), which indicates there's no depth limit. If you set a limit, it can be between 1 and 75 nested levels. This field will produce a limit error if the operation falls out of bounds. Note that fields can still be set to nullable or non-nullable. If a non-nullable field produces an error, the error will be thrown upwards to the first nullable field available.

Link copied to clipboard
val resolverCountLimit: Output<Int>?

The maximum number of resolvers that can be invoked in a single request. The default value is 0 (or unspecified), which will set the limit to 10000. When specified, the limit value can be between 1 and 10000. This field will produce a limit error if the operation falls out of bounds.

Link copied to clipboard
val schema: Output<String>?

Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.

Link copied to clipboard
val tags: Output<Map<String, String>>?

Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Link copied to clipboard
val tagsAll: Output<Map<String, String>>

Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Link copied to clipboard
val uris: Output<Map<String, String>>

Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql

Link copied to clipboard
val urn: Output<String>
Link copied to clipboard

Amazon Cognito User Pool configuration. See user_pool_config Block for details.

Link copied to clipboard
val visibility: Output<String>?

Sets the value of the GraphQL API to public (GLOBAL) or private (PRIVATE). If no value is provided, the visibility will be set to GLOBAL by default. This value cannot be changed once the API has been created.

Link copied to clipboard
val xrayEnabled: Output<Boolean>?

Whether tracing with X-ray is enabled. Defaults to false.