AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a GraphQL API.

Inheritance Hierarchy

System.Object
  Amazon.AppSync.Model.GraphqlApi

Namespace: Amazon.AppSync.Model
Assembly: AWSSDK.AppSync.dll
Version: 3.x.y.z

Syntax

C#
public class GraphqlApi

The GraphqlApi type exposes the following members

Constructors

NameDescription
Public Method GraphqlApi()

Properties

NameTypeDescription
Public Property AdditionalAuthenticationProviders System.Collections.Generic.List<Amazon.AppSync.Model.AdditionalAuthenticationProvider>

Gets and sets the property AdditionalAuthenticationProviders.

A list of additional authentication providers for the GraphqlApi API.

Public Property ApiId System.String

Gets and sets the property ApiId.

The API ID.

Public Property ApiType Amazon.AppSync.GraphQLApiType

Gets and sets the property ApiType.

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

Public Property Arn System.String

Gets and sets the property Arn.

The Amazon Resource Name (ARN).

Public Property AuthenticationType Amazon.AppSync.AuthenticationType

Gets and sets the property AuthenticationType.

The authentication type.

Public Property Dns System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Dns.

The DNS records for the API.

Public Property EnhancedMetricsConfig Amazon.AppSync.Model.EnhancedMetricsConfig

Gets and sets the property EnhancedMetricsConfig.

The enhancedMetricsConfig object.

Public Property IntrospectionConfig Amazon.AppSync.GraphQLApiIntrospectionConfig

Gets and sets the property IntrospectionConfig.

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.

Public Property LambdaAuthorizerConfig Amazon.AppSync.Model.LambdaAuthorizerConfig

Gets and sets the property LambdaAuthorizerConfig.

Configuration for Lambda function authorization.

Public Property LogConfig Amazon.AppSync.Model.LogConfig

Gets and sets the property LogConfig.

The Amazon CloudWatch Logs configuration.

Public Property MergedApiExecutionRoleArn System.String

Gets and sets the property MergedApiExecutionRoleArn.

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.

Public Property Name System.String

Gets and sets the property Name.

The API name.

Public Property OpenIDConnectConfig Amazon.AppSync.Model.OpenIDConnectConfig

Gets and sets the property OpenIDConnectConfig.

The OpenID Connect configuration.

Public Property Owner System.String

Gets and sets the property Owner.

The account owner of the GraphQL API.

Public Property OwnerContact System.String

Gets and sets the property OwnerContact.

The owner contact information for an API resource.

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

Public Property QueryDepthLimit System.Int32

Gets and sets the property QueryDepthLimit.

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.

Public Property ResolverCountLimit System.Int32

Gets and sets the property ResolverCountLimit.

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.

Public Property Tags System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Tags.

The tags.

Public Property Uris System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Uris.

The URIs.

Public Property UserPoolConfig Amazon.AppSync.Model.UserPoolConfig

Gets and sets the property UserPoolConfig.

The Amazon Cognito user pool configuration.

Public Property Visibility Amazon.AppSync.GraphQLApiVisibility

Gets and sets the property Visibility.

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.

Public Property WafWebAclArn System.String

Gets and sets the property WafWebAclArn.

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

Public Property XrayEnabled System.Boolean

Gets and sets the property XrayEnabled.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5