GetGraphQlApiResult

data class GetGraphQlApiResult(val additionalAuthenticationProviders: List<GraphQlApiAdditionalAuthenticationProvider>? = null, val apiId: String? = null, val apiType: String? = null, val arn: String? = null, val authenticationType: String? = null, val enhancedMetricsConfig: GraphQlApiEnhancedMetricsConfig? = null, val environmentVariables: Map<String, String>? = null, val graphQlDns: String? = null, val graphQlEndpointArn: String? = null, val graphQlUrl: String? = null, val introspectionConfig: String? = null, val lambdaAuthorizerConfig: GraphQlApiLambdaAuthorizerConfig? = null, val logConfig: GraphQlApiLogConfig? = null, val mergedApiExecutionRoleArn: String? = null, val name: String? = null, val openIdConnectConfig: GraphQlApiOpenIdConnectConfig? = null, val ownerContact: String? = null, val queryDepthLimit: Int? = null, val realtimeDns: String? = null, val realtimeUrl: String? = null, val resolverCountLimit: Int? = null, val tags: List<Tag>? = null, val userPoolConfig: GraphQlApiUserPoolConfig? = null, val visibility: String? = null, val xrayEnabled: Boolean? = null)

Constructors

Link copied to clipboard
constructor(additionalAuthenticationProviders: List<GraphQlApiAdditionalAuthenticationProvider>? = null, apiId: String? = null, apiType: String? = null, arn: String? = null, authenticationType: String? = null, enhancedMetricsConfig: GraphQlApiEnhancedMetricsConfig? = null, environmentVariables: Map<String, String>? = null, graphQlDns: String? = null, graphQlEndpointArn: String? = null, graphQlUrl: String? = null, introspectionConfig: String? = null, lambdaAuthorizerConfig: GraphQlApiLambdaAuthorizerConfig? = null, logConfig: GraphQlApiLogConfig? = null, mergedApiExecutionRoleArn: String? = null, name: String? = null, openIdConnectConfig: GraphQlApiOpenIdConnectConfig? = null, ownerContact: String? = null, queryDepthLimit: Int? = null, realtimeDns: String? = null, realtimeUrl: String? = null, resolverCountLimit: Int? = null, tags: List<Tag>? = null, userPoolConfig: GraphQlApiUserPoolConfig? = null, visibility: String? = null, xrayEnabled: Boolean? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

A list of additional authentication providers for the GraphqlApi API.

Link copied to clipboard
val apiId: String? = null

Unique AWS AppSync GraphQL API identifier.

Link copied to clipboard
val apiType: String? = null

The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).

Link copied to clipboard
val arn: String? = null

The Amazon Resource Name (ARN) of the API key

Link copied to clipboard

Security configuration for your GraphQL API

Link copied to clipboard

Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.

Link copied to clipboard

A map containing the list of resources with their properties and environment variables.

Link copied to clipboard
val graphQlDns: String? = null

The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.

Link copied to clipboard

The GraphQL endpoint ARN.

Link copied to clipboard
val graphQlUrl: String? = null

The Endpoint URL of your GraphQL API.

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.

Link copied to clipboard

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.

Link copied to clipboard

The Amazon CloudWatch Logs configuration.

Link copied to clipboard

The AWS Identity and Access Management service role ARN for a merged API.

Link copied to clipboard
val name: String? = null

The API name

Link copied to clipboard

The OpenID Connect configuration.

Link copied to clipboard
val ownerContact: String? = null

The owner contact information for an API resource.

Link copied to clipboard
val queryDepthLimit: Int? = null

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.

Link copied to clipboard
val realtimeDns: String? = null

The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.

Link copied to clipboard
val realtimeUrl: String? = null

The GraphQL API real-time endpoint URL.

Link copied to clipboard
val resolverCountLimit: Int? = null

The maximum number of resolvers that can be invoked in a single request.

Link copied to clipboard
val tags: List<Tag>? = null

An arbitrary set of tags (key-value pairs) for this GraphQL API.

Link copied to clipboard

Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.

Link copied to clipboard
val visibility: String? = null

Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.

Link copied to clipboard
val xrayEnabled: Boolean? = null

A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.