Class CfnGraphQLApi

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnGraphQLApi
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.AppSync
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnGraphQLApi : CfnResource, IInspectable, IGraphQLApiRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnGraphQLApi Inherits CfnResource Implements IInspectable, IGraphQLApiRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppSync;

             var cfnGraphQLApi = new CfnGraphQLApi(this, "MyCfnGraphQLApi", new CfnGraphQLApiProps {
                 AuthenticationType = "authenticationType",
                 Name = "name",

                 // the properties below are optional
                 AdditionalAuthenticationProviders = new [] { new AdditionalAuthenticationProviderProperty {
                     AuthenticationType = "authenticationType",

                     // the properties below are optional
                     LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                         AuthorizerResultTtlInSeconds = 123,
                         AuthorizerUri = "authorizerUri",
                         IdentityValidationExpression = "identityValidationExpression"
                     },
                     OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                         AuthTtl = 123,
                         ClientId = "clientId",
                         IatTtl = 123,
                         Issuer = "issuer"
                     },
                     UserPoolConfig = new CognitoUserPoolConfigProperty {
                         AppIdClientRegex = "appIdClientRegex",
                         AwsRegion = "awsRegion",
                         UserPoolId = "userPoolId"
                     }
                 } },
                 ApiType = "apiType",
                 EnhancedMetricsConfig = new EnhancedMetricsConfigProperty {
                     DataSourceLevelMetricsBehavior = "dataSourceLevelMetricsBehavior",
                     OperationLevelMetricsConfig = "operationLevelMetricsConfig",
                     ResolverLevelMetricsBehavior = "resolverLevelMetricsBehavior"
                 },
                 EnvironmentVariables = new Dictionary<string, string> {
                     { "environmentVariablesKey", "environmentVariables" }
                 },
                 IntrospectionConfig = "introspectionConfig",
                 LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                     AuthorizerResultTtlInSeconds = 123,
                     AuthorizerUri = "authorizerUri",
                     IdentityValidationExpression = "identityValidationExpression"
                 },
                 LogConfig = new LogConfigProperty {
                     CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                     ExcludeVerboseContent = false,
                     FieldLogLevel = "fieldLogLevel"
                 },
                 MergedApiExecutionRoleArn = "mergedApiExecutionRoleArn",
                 OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                     AuthTtl = 123,
                     ClientId = "clientId",
                     IatTtl = 123,
                     Issuer = "issuer"
                 },
                 OwnerContact = "ownerContact",
                 QueryDepthLimit = 123,
                 ResolverCountLimit = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserPoolConfig = new UserPoolConfigProperty {
                     AppIdClientRegex = "appIdClientRegex",
                     AwsRegion = "awsRegion",
                     DefaultAction = "defaultAction",
                     UserPoolId = "userPoolId"
                 },
                 Visibility = "visibility",
                 XrayEnabled = false
             });

Synopsis

Constructors

CfnGraphQLApi(Construct, string, ICfnGraphQLApiProps)

Create a new AWS::AppSync::GraphQLApi.

Properties

AdditionalAuthenticationProviders

A list of additional authentication providers for the GraphqlApi API.
ApiType

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

Unique AWS AppSync GraphQL API identifier.
AttrArn

The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid .
AttrGraphQlDns

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

The GraphQL endpoint ARN.
AttrGraphQlUrl

The Endpoint URL of your GraphQL API.
AttrRealtimeDns

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

The GraphQL API real-time endpoint URL.
AuthenticationType

Security configuration for your GraphQL API.
CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.
CfnProperties

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.
EnhancedMetricsConfig

Enables and controls the enhanced metrics feature.
EnvironmentVariables

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

A reference to a GraphQLApi resource.
IntrospectionConfig

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.
LambdaAuthorizerConfig

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.
LogConfig

The Amazon CloudWatch Logs configuration.
MergedApiExecutionRoleArn

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

The API name.
OpenIdConnectConfig

The OpenID Connect configuration.
OwnerContact

The owner contact information for an API resource.
QueryDepthLimit

The maximum depth a query can have in a single request.
ResolverCountLimit

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

Tag Manager which manages the tags for this resource.
TagsRaw

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

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

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).
XrayEnabled

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

Methods

ArnForGraphQLApi(IGraphQLApiRef)

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.
Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.
IsCfnGraphQLApi(object)

Checks whether the given object is a CfnGraphQLApi.
RenderProperties(IDictionary<string, object>)

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

Constructors

CfnGraphQLApi(Construct, string, ICfnGraphQLApiProps)

Create a new AWS::AppSync::GraphQLApi.

public CfnGraphQLApi(Construct scope, string id, ICfnGraphQLApiProps props)
Parameters
scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnGraphQLApiProps

Resource properties.

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Properties

AdditionalAuthenticationProviders

A list of additional authentication providers for the GraphqlApi API.

public virtual object? AdditionalAuthenticationProviders { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnGraphQLApi.IAdditionalAuthenticationProviderProperty)[]

ApiType

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

public virtual string? ApiType { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

AttrApiId

Unique AWS AppSync GraphQL API identifier.

public virtual string AttrApiId { get; }
Property Value

string

Remarks

CloudformationAttribute: ApiId

AttrArn

The Amazon Resource Name (ARN) of the API key, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid .

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

AttrGraphQlDns

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

public virtual string AttrGraphQlDns { get; }
Property Value

string

Remarks

CloudformationAttribute: GraphQLDns

AttrGraphQlEndpointArn

The GraphQL endpoint ARN.

public virtual string AttrGraphQlEndpointArn { get; }
Property Value

string

Remarks

CloudformationAttribute: GraphQLEndpointArn

AttrGraphQlUrl

The Endpoint URL of your GraphQL API.

public virtual string AttrGraphQlUrl { get; }
Property Value

string

Remarks

CloudformationAttribute: GraphQLUrl

AttrRealtimeDns

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

public virtual string AttrRealtimeDns { get; }
Property Value

string

Remarks

CloudformationAttribute: RealtimeDns

AttrRealtimeUrl

The GraphQL API real-time endpoint URL.

public virtual string AttrRealtimeUrl { get; }
Property Value

string

Remarks

For more information, see Discovering the real-time endpoint from the GraphQL endpoint .

CloudformationAttribute: RealtimeUrl

AuthenticationType

Security configuration for your GraphQL API.

public virtual string AuthenticationType { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

EnhancedMetricsConfig

Enables and controls the enhanced metrics feature.

public virtual object? EnhancedMetricsConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnGraphQLApi.IEnhancedMetricsConfigProperty

EnvironmentVariables

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

public virtual object? EnvironmentVariables { get; set; }
Property Value

object

Remarks

Type union: either Dictionary<string, string> or IResolvable

GraphQlApiRef

A reference to a GraphQLApi resource.

public virtual IGraphQLApiReference GraphQlApiRef { get; }
Property Value

IGraphQLApiReference

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

IntrospectionConfig

Sets the value of the GraphQL API to enable ( ENABLED ) or disable ( DISABLED ) introspection.

public virtual string? IntrospectionConfig { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

LambdaAuthorizerConfig

A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode.

public virtual object? LambdaAuthorizerConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnGraphQLApi.ILambdaAuthorizerConfigProperty

LogConfig

The Amazon CloudWatch Logs configuration.

public virtual object? LogConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnGraphQLApi.ILogConfigProperty

MergedApiExecutionRoleArn

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

public virtual string? MergedApiExecutionRoleArn { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Name

The API name.

public virtual string Name { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

OpenIdConnectConfig

The OpenID Connect configuration.

public virtual object? OpenIdConnectConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnGraphQLApi.IOpenIDConnectConfigProperty

OwnerContact

The owner contact information for an API resource.

public virtual string? OwnerContact { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

QueryDepthLimit

The maximum depth a query can have in a single request.

public virtual double? QueryDepthLimit { get; set; }
Property Value

double?

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

ResolverCountLimit

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

public virtual double? ResolverCountLimit { get; set; }
Property Value

double?

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }
Property Value

ICfnTag[]

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

UserPoolConfig

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

public virtual object? UserPoolConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnGraphQLApi.IUserPoolConfigProperty

Visibility

Sets the scope of the GraphQL API to public ( GLOBAL ) or private ( PRIVATE ).

public virtual string? Visibility { get; set; }
Property Value

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

XrayEnabled

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

public virtual object? XrayEnabled { get; set; }
Property Value

object

Remarks

Type union: either bool or IResolvable

Methods

ArnForGraphQLApi(IGraphQLApiRef)

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

public static string ArnForGraphQLApi(IGraphQLApiRef resource)
Parameters
resource IGraphQLApiRef
Returns

string

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppSync;

             var cfnGraphQLApi = new CfnGraphQLApi(this, "MyCfnGraphQLApi", new CfnGraphQLApiProps {
                 AuthenticationType = "authenticationType",
                 Name = "name",

                 // the properties below are optional
                 AdditionalAuthenticationProviders = new [] { new AdditionalAuthenticationProviderProperty {
                     AuthenticationType = "authenticationType",

                     // the properties below are optional
                     LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                         AuthorizerResultTtlInSeconds = 123,
                         AuthorizerUri = "authorizerUri",
                         IdentityValidationExpression = "identityValidationExpression"
                     },
                     OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                         AuthTtl = 123,
                         ClientId = "clientId",
                         IatTtl = 123,
                         Issuer = "issuer"
                     },
                     UserPoolConfig = new CognitoUserPoolConfigProperty {
                         AppIdClientRegex = "appIdClientRegex",
                         AwsRegion = "awsRegion",
                         UserPoolId = "userPoolId"
                     }
                 } },
                 ApiType = "apiType",
                 EnhancedMetricsConfig = new EnhancedMetricsConfigProperty {
                     DataSourceLevelMetricsBehavior = "dataSourceLevelMetricsBehavior",
                     OperationLevelMetricsConfig = "operationLevelMetricsConfig",
                     ResolverLevelMetricsBehavior = "resolverLevelMetricsBehavior"
                 },
                 EnvironmentVariables = new Dictionary<string, string> {
                     { "environmentVariablesKey", "environmentVariables" }
                 },
                 IntrospectionConfig = "introspectionConfig",
                 LambdaAuthorizerConfig = new LambdaAuthorizerConfigProperty {
                     AuthorizerResultTtlInSeconds = 123,
                     AuthorizerUri = "authorizerUri",
                     IdentityValidationExpression = "identityValidationExpression"
                 },
                 LogConfig = new LogConfigProperty {
                     CloudWatchLogsRoleArn = "cloudWatchLogsRoleArn",
                     ExcludeVerboseContent = false,
                     FieldLogLevel = "fieldLogLevel"
                 },
                 MergedApiExecutionRoleArn = "mergedApiExecutionRoleArn",
                 OpenIdConnectConfig = new OpenIDConnectConfigProperty {
                     AuthTtl = 123,
                     ClientId = "clientId",
                     IatTtl = 123,
                     Issuer = "issuer"
                 },
                 OwnerContact = "ownerContact",
                 QueryDepthLimit = 123,
                 ResolverCountLimit = 123,
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 UserPoolConfig = new UserPoolConfigProperty {
                     AppIdClientRegex = "appIdClientRegex",
                     AwsRegion = "awsRegion",
                     DefaultAction = "defaultAction",
                     UserPoolId = "userPoolId"
                 },
                 Visibility = "visibility",
                 XrayEnabled = false
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

IsCfnGraphQLApi(object)

Checks whether the given object is a CfnGraphQLApi.

public static bool IsCfnGraphQLApi(object x)
Parameters
x object
Returns

bool

Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppSync::GraphQLApi resource creates a new AWS AppSync GraphQL API.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
Remarks

This is the top-level construct for your application. For more information, see Quick Start in the AWS AppSync Developer Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-graphqlapi.html

CloudformationResource: AWS::AppSync::GraphQLApi

ExampleMetadata: fixture=_generated

Implements

Constructs.IConstruct
Constructs.IDependable