AwsAppSyncGraphqlApiPropertiesResponse

data class AwsAppSyncGraphqlApiPropertiesResponse(val additionalAuthenticationProviders: List<AdditionalAuthenticationProviderResponse>? = null, val apiId: String? = null, val apiType: GraphQLApiTypeEnumValueResponse? = null, val arn: String? = null, val authenticationType: AuthenticationTypeEnumValueResponse? = null, val dns: Map<String, String>? = null, val enhancedMetricsConfig: EnhancedMetricsConfigResponse? = null, val introspectionConfig: GraphQLApiIntrospectionConfigEnumValueResponse? = null, val lambdaAuthorizerConfig: LambdaAuthorizerConfigResponse? = null, val logConfig: LogConfigResponse? = null, val mergedApiExecutionRoleArn: String? = null, val name: String? = null, val openIDConnectConfig: OpenIDConnectConfigResponse? = null, val owner: String? = null, val ownerContact: String? = null, val queryDepthLimit: Int? = null, val resolverCountLimit: Int? = null, val tags: Map<String, String>? = null, val uris: Map<String, String>? = null, val userPoolConfig: UserPoolConfigResponse? = null, val visibility: GraphQLApiVisibilityEnumValueResponse? = null, val wafWebAclArn: String? = null, val xrayEnabled: Boolean? = null)

Definition of awsAppSyncGraphqlApi

Constructors

Link copied to clipboard
constructor(additionalAuthenticationProviders: List<AdditionalAuthenticationProviderResponse>? = null, apiId: String? = null, apiType: GraphQLApiTypeEnumValueResponse? = null, arn: String? = null, authenticationType: AuthenticationTypeEnumValueResponse? = null, dns: Map<String, String>? = null, enhancedMetricsConfig: EnhancedMetricsConfigResponse? = null, introspectionConfig: GraphQLApiIntrospectionConfigEnumValueResponse? = null, lambdaAuthorizerConfig: LambdaAuthorizerConfigResponse? = null, logConfig: LogConfigResponse? = null, mergedApiExecutionRoleArn: String? = null, name: String? = null, openIDConnectConfig: OpenIDConnectConfigResponse? = null, owner: String? = null, ownerContact: String? = null, queryDepthLimit: Int? = null, resolverCountLimit: Int? = null, tags: Map<String, String>? = null, uris: Map<String, String>? = null, userPoolConfig: UserPoolConfigResponse? = null, visibility: GraphQLApiVisibilityEnumValueResponse? = null, wafWebAclArn: 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

The API ID.

Link copied to clipboard

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).

Link copied to clipboard

The authentication type.

Link copied to clipboard
val dns: Map<String, String>? = null

The DNS records for the API.

Link copied to clipboard

The enhancedMetricsConfig object.

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

Configuration for Lambda function authorization.

Link copied to clipboard

The Amazon CloudWatch Logs configuration.

Link copied to clipboard

The Identity and Access Management service role ARN for a merged API. The AppSync service assumes this role on behalf of the Merged API to validate access to source APIs at runtime and to prompt the AUTO_MERGE to update the merged API endpoint with the source API changes automatically.

Link copied to clipboard
val name: String? = null

The API name.

Link copied to clipboard

The OpenID Connect configuration.

Link copied to clipboard
val owner: String? = null

The account owner of the GraphQL API.

Link copied to clipboard
val ownerContact: String? = null

The owner contact information for an API resource.

This field accepts any string input with a length of 0 - 256 characters.

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. 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: Int? = null

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 tags: Map<String, String>? = null

The tags.

Link copied to clipboard
val uris: Map<String, String>? = null

The URIs.

Link copied to clipboard

The Amazon Cognito user pool configuration.

Link copied to clipboard

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 wafWebAclArn: String? = null

The ARN of the WAF access control list (ACL) associated with this GraphqlApi, if one exists.

Link copied to clipboard
val xrayEnabled: Boolean? = null

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