Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. appsync
  5. GraphQLApi
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

aws.appsync.GraphQLApi

Explore with Pulumi AI

AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws

Create GraphQLApi Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GraphQLApi(name: string, args: GraphQLApiArgs, opts?: CustomResourceOptions);
@overload
def GraphQLApi(resource_name: str,
               args: GraphQLApiArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def GraphQLApi(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               authentication_type: Optional[str] = None,
               name: Optional[str] = None,
               query_depth_limit: Optional[int] = None,
               enhanced_metrics_config: Optional[GraphQLApiEnhancedMetricsConfigArgs] = None,
               introspection_config: Optional[str] = None,
               lambda_authorizer_config: Optional[GraphQLApiLambdaAuthorizerConfigArgs] = None,
               log_config: Optional[GraphQLApiLogConfigArgs] = None,
               api_type: Optional[str] = None,
               merged_api_execution_role_arn: Optional[str] = None,
               openid_connect_config: Optional[GraphQLApiOpenidConnectConfigArgs] = None,
               additional_authentication_providers: Optional[Sequence[GraphQLApiAdditionalAuthenticationProviderArgs]] = None,
               resolver_count_limit: Optional[int] = None,
               schema: Optional[str] = None,
               tags: Optional[Mapping[str, str]] = None,
               user_pool_config: Optional[GraphQLApiUserPoolConfigArgs] = None,
               visibility: Optional[str] = None,
               xray_enabled: Optional[bool] = None)
func NewGraphQLApi(ctx *Context, name string, args GraphQLApiArgs, opts ...ResourceOption) (*GraphQLApi, error)
public GraphQLApi(string name, GraphQLApiArgs args, CustomResourceOptions? opts = null)
public GraphQLApi(String name, GraphQLApiArgs args)
public GraphQLApi(String name, GraphQLApiArgs args, CustomResourceOptions options)

type: aws:appsync:GraphQLApi
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GraphQLApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GraphQLApiArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GraphQLApiArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GraphQLApiArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GraphQLApiArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var graphQLApiResource = new Aws.AppSync.GraphQLApi("graphQLApiResource", new()
{
    AuthenticationType = "string",
    Name = "string",
    QueryDepthLimit = 0,
    EnhancedMetricsConfig = new Aws.AppSync.Inputs.GraphQLApiEnhancedMetricsConfigArgs
    {
        DataSourceLevelMetricsBehavior = "string",
        OperationLevelMetricsConfig = "string",
        ResolverLevelMetricsBehavior = "string",
    },
    IntrospectionConfig = "string",
    LambdaAuthorizerConfig = new Aws.AppSync.Inputs.GraphQLApiLambdaAuthorizerConfigArgs
    {
        AuthorizerUri = "string",
        AuthorizerResultTtlInSeconds = 0,
        IdentityValidationExpression = "string",
    },
    LogConfig = new Aws.AppSync.Inputs.GraphQLApiLogConfigArgs
    {
        CloudwatchLogsRoleArn = "string",
        FieldLogLevel = "string",
        ExcludeVerboseContent = false,
    },
    ApiType = "string",
    MergedApiExecutionRoleArn = "string",
    OpenidConnectConfig = new Aws.AppSync.Inputs.GraphQLApiOpenidConnectConfigArgs
    {
        Issuer = "string",
        AuthTtl = 0,
        ClientId = "string",
        IatTtl = 0,
    },
    AdditionalAuthenticationProviders = new[]
    {
        new Aws.AppSync.Inputs.GraphQLApiAdditionalAuthenticationProviderArgs
        {
            AuthenticationType = "string",
            LambdaAuthorizerConfig = new Aws.AppSync.Inputs.GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfigArgs
            {
                AuthorizerUri = "string",
                AuthorizerResultTtlInSeconds = 0,
                IdentityValidationExpression = "string",
            },
            OpenidConnectConfig = new Aws.AppSync.Inputs.GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfigArgs
            {
                Issuer = "string",
                AuthTtl = 0,
                ClientId = "string",
                IatTtl = 0,
            },
            UserPoolConfig = new Aws.AppSync.Inputs.GraphQLApiAdditionalAuthenticationProviderUserPoolConfigArgs
            {
                UserPoolId = "string",
                AppIdClientRegex = "string",
                AwsRegion = "string",
            },
        },
    },
    ResolverCountLimit = 0,
    Schema = "string",
    Tags = 
    {
        { "string", "string" },
    },
    UserPoolConfig = new Aws.AppSync.Inputs.GraphQLApiUserPoolConfigArgs
    {
        DefaultAction = "string",
        UserPoolId = "string",
        AppIdClientRegex = "string",
        AwsRegion = "string",
    },
    Visibility = "string",
    XrayEnabled = false,
});
Copy
example, err := appsync.NewGraphQLApi(ctx, "graphQLApiResource", &appsync.GraphQLApiArgs{
	AuthenticationType: pulumi.String("string"),
	Name:               pulumi.String("string"),
	QueryDepthLimit:    pulumi.Int(0),
	EnhancedMetricsConfig: &appsync.GraphQLApiEnhancedMetricsConfigArgs{
		DataSourceLevelMetricsBehavior: pulumi.String("string"),
		OperationLevelMetricsConfig:    pulumi.String("string"),
		ResolverLevelMetricsBehavior:   pulumi.String("string"),
	},
	IntrospectionConfig: pulumi.String("string"),
	LambdaAuthorizerConfig: &appsync.GraphQLApiLambdaAuthorizerConfigArgs{
		AuthorizerUri:                pulumi.String("string"),
		AuthorizerResultTtlInSeconds: pulumi.Int(0),
		IdentityValidationExpression: pulumi.String("string"),
	},
	LogConfig: &appsync.GraphQLApiLogConfigArgs{
		CloudwatchLogsRoleArn: pulumi.String("string"),
		FieldLogLevel:         pulumi.String("string"),
		ExcludeVerboseContent: pulumi.Bool(false),
	},
	ApiType:                   pulumi.String("string"),
	MergedApiExecutionRoleArn: pulumi.String("string"),
	OpenidConnectConfig: &appsync.GraphQLApiOpenidConnectConfigArgs{
		Issuer:   pulumi.String("string"),
		AuthTtl:  pulumi.Int(0),
		ClientId: pulumi.String("string"),
		IatTtl:   pulumi.Int(0),
	},
	AdditionalAuthenticationProviders: appsync.GraphQLApiAdditionalAuthenticationProviderArray{
		&appsync.GraphQLApiAdditionalAuthenticationProviderArgs{
			AuthenticationType: pulumi.String("string"),
			LambdaAuthorizerConfig: &appsync.GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfigArgs{
				AuthorizerUri:                pulumi.String("string"),
				AuthorizerResultTtlInSeconds: pulumi.Int(0),
				IdentityValidationExpression: pulumi.String("string"),
			},
			OpenidConnectConfig: &appsync.GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfigArgs{
				Issuer:   pulumi.String("string"),
				AuthTtl:  pulumi.Int(0),
				ClientId: pulumi.String("string"),
				IatTtl:   pulumi.Int(0),
			},
			UserPoolConfig: &appsync.GraphQLApiAdditionalAuthenticationProviderUserPoolConfigArgs{
				UserPoolId:       pulumi.String("string"),
				AppIdClientRegex: pulumi.String("string"),
				AwsRegion:        pulumi.String("string"),
			},
		},
	},
	ResolverCountLimit: pulumi.Int(0),
	Schema:             pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UserPoolConfig: &appsync.GraphQLApiUserPoolConfigArgs{
		DefaultAction:    pulumi.String("string"),
		UserPoolId:       pulumi.String("string"),
		AppIdClientRegex: pulumi.String("string"),
		AwsRegion:        pulumi.String("string"),
	},
	Visibility:  pulumi.String("string"),
	XrayEnabled: pulumi.Bool(false),
})
Copy
var graphQLApiResource = new GraphQLApi("graphQLApiResource", GraphQLApiArgs.builder()
    .authenticationType("string")
    .name("string")
    .queryDepthLimit(0)
    .enhancedMetricsConfig(GraphQLApiEnhancedMetricsConfigArgs.builder()
        .dataSourceLevelMetricsBehavior("string")
        .operationLevelMetricsConfig("string")
        .resolverLevelMetricsBehavior("string")
        .build())
    .introspectionConfig("string")
    .lambdaAuthorizerConfig(GraphQLApiLambdaAuthorizerConfigArgs.builder()
        .authorizerUri("string")
        .authorizerResultTtlInSeconds(0)
        .identityValidationExpression("string")
        .build())
    .logConfig(GraphQLApiLogConfigArgs.builder()
        .cloudwatchLogsRoleArn("string")
        .fieldLogLevel("string")
        .excludeVerboseContent(false)
        .build())
    .apiType("string")
    .mergedApiExecutionRoleArn("string")
    .openidConnectConfig(GraphQLApiOpenidConnectConfigArgs.builder()
        .issuer("string")
        .authTtl(0)
        .clientId("string")
        .iatTtl(0)
        .build())
    .additionalAuthenticationProviders(GraphQLApiAdditionalAuthenticationProviderArgs.builder()
        .authenticationType("string")
        .lambdaAuthorizerConfig(GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfigArgs.builder()
            .authorizerUri("string")
            .authorizerResultTtlInSeconds(0)
            .identityValidationExpression("string")
            .build())
        .openidConnectConfig(GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfigArgs.builder()
            .issuer("string")
            .authTtl(0)
            .clientId("string")
            .iatTtl(0)
            .build())
        .userPoolConfig(GraphQLApiAdditionalAuthenticationProviderUserPoolConfigArgs.builder()
            .userPoolId("string")
            .appIdClientRegex("string")
            .awsRegion("string")
            .build())
        .build())
    .resolverCountLimit(0)
    .schema("string")
    .tags(Map.of("string", "string"))
    .userPoolConfig(GraphQLApiUserPoolConfigArgs.builder()
        .defaultAction("string")
        .userPoolId("string")
        .appIdClientRegex("string")
        .awsRegion("string")
        .build())
    .visibility("string")
    .xrayEnabled(false)
    .build());
Copy
graph_ql_api_resource = aws.appsync.GraphQLApi("graphQLApiResource",
    authentication_type="string",
    name="string",
    query_depth_limit=0,
    enhanced_metrics_config={
        "data_source_level_metrics_behavior": "string",
        "operation_level_metrics_config": "string",
        "resolver_level_metrics_behavior": "string",
    },
    introspection_config="string",
    lambda_authorizer_config={
        "authorizer_uri": "string",
        "authorizer_result_ttl_in_seconds": 0,
        "identity_validation_expression": "string",
    },
    log_config={
        "cloudwatch_logs_role_arn": "string",
        "field_log_level": "string",
        "exclude_verbose_content": False,
    },
    api_type="string",
    merged_api_execution_role_arn="string",
    openid_connect_config={
        "issuer": "string",
        "auth_ttl": 0,
        "client_id": "string",
        "iat_ttl": 0,
    },
    additional_authentication_providers=[{
        "authentication_type": "string",
        "lambda_authorizer_config": {
            "authorizer_uri": "string",
            "authorizer_result_ttl_in_seconds": 0,
            "identity_validation_expression": "string",
        },
        "openid_connect_config": {
            "issuer": "string",
            "auth_ttl": 0,
            "client_id": "string",
            "iat_ttl": 0,
        },
        "user_pool_config": {
            "user_pool_id": "string",
            "app_id_client_regex": "string",
            "aws_region": "string",
        },
    }],
    resolver_count_limit=0,
    schema="string",
    tags={
        "string": "string",
    },
    user_pool_config={
        "default_action": "string",
        "user_pool_id": "string",
        "app_id_client_regex": "string",
        "aws_region": "string",
    },
    visibility="string",
    xray_enabled=False)
Copy
const graphQLApiResource = new aws.appsync.GraphQLApi("graphQLApiResource", {
    authenticationType: "string",
    name: "string",
    queryDepthLimit: 0,
    enhancedMetricsConfig: {
        dataSourceLevelMetricsBehavior: "string",
        operationLevelMetricsConfig: "string",
        resolverLevelMetricsBehavior: "string",
    },
    introspectionConfig: "string",
    lambdaAuthorizerConfig: {
        authorizerUri: "string",
        authorizerResultTtlInSeconds: 0,
        identityValidationExpression: "string",
    },
    logConfig: {
        cloudwatchLogsRoleArn: "string",
        fieldLogLevel: "string",
        excludeVerboseContent: false,
    },
    apiType: "string",
    mergedApiExecutionRoleArn: "string",
    openidConnectConfig: {
        issuer: "string",
        authTtl: 0,
        clientId: "string",
        iatTtl: 0,
    },
    additionalAuthenticationProviders: [{
        authenticationType: "string",
        lambdaAuthorizerConfig: {
            authorizerUri: "string",
            authorizerResultTtlInSeconds: 0,
            identityValidationExpression: "string",
        },
        openidConnectConfig: {
            issuer: "string",
            authTtl: 0,
            clientId: "string",
            iatTtl: 0,
        },
        userPoolConfig: {
            userPoolId: "string",
            appIdClientRegex: "string",
            awsRegion: "string",
        },
    }],
    resolverCountLimit: 0,
    schema: "string",
    tags: {
        string: "string",
    },
    userPoolConfig: {
        defaultAction: "string",
        userPoolId: "string",
        appIdClientRegex: "string",
        awsRegion: "string",
    },
    visibility: "string",
    xrayEnabled: false,
});
Copy
type: aws:appsync:GraphQLApi
properties:
    additionalAuthenticationProviders:
        - authenticationType: string
          lambdaAuthorizerConfig:
            authorizerResultTtlInSeconds: 0
            authorizerUri: string
            identityValidationExpression: string
          openidConnectConfig:
            authTtl: 0
            clientId: string
            iatTtl: 0
            issuer: string
          userPoolConfig:
            appIdClientRegex: string
            awsRegion: string
            userPoolId: string
    apiType: string
    authenticationType: string
    enhancedMetricsConfig:
        dataSourceLevelMetricsBehavior: string
        operationLevelMetricsConfig: string
        resolverLevelMetricsBehavior: string
    introspectionConfig: string
    lambdaAuthorizerConfig:
        authorizerResultTtlInSeconds: 0
        authorizerUri: string
        identityValidationExpression: string
    logConfig:
        cloudwatchLogsRoleArn: string
        excludeVerboseContent: false
        fieldLogLevel: string
    mergedApiExecutionRoleArn: string
    name: string
    openidConnectConfig:
        authTtl: 0
        clientId: string
        iatTtl: 0
        issuer: string
    queryDepthLimit: 0
    resolverCountLimit: 0
    schema: string
    tags:
        string: string
    userPoolConfig:
        appIdClientRegex: string
        awsRegion: string
        defaultAction: string
        userPoolId: string
    visibility: string
    xrayEnabled: false
Copy

GraphQLApi Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GraphQLApi resource accepts the following input properties:

AuthenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
AdditionalAuthenticationProviders List<GraphQLApiAdditionalAuthenticationProvider>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
ApiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
EnhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
IntrospectionConfig string
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.
LambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
LogConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
MergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
Name string

User-supplied name for the GraphQL API.

The following arguments are optional:

OpenidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
QueryDepthLimit 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.

ResolverCountLimit 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.
Schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
Tags Dictionary<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.
UserPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
Visibility Changes to this property will trigger replacement. 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.
XrayEnabled bool
Whether tracing with X-ray is enabled. Defaults to false.
AuthenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
AdditionalAuthenticationProviders []GraphQLApiAdditionalAuthenticationProviderArgs
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
ApiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
EnhancedMetricsConfig GraphQLApiEnhancedMetricsConfigArgs
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
IntrospectionConfig string
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.
LambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfigArgs
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
LogConfig GraphQLApiLogConfigArgs
Nested argument containing logging configuration. See log_config Block for details.
MergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
Name string

User-supplied name for the GraphQL API.

The following arguments are optional:

OpenidConnectConfig GraphQLApiOpenidConnectConfigArgs
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
QueryDepthLimit 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.

ResolverCountLimit 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.
Schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
Tags 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.
UserPoolConfig GraphQLApiUserPoolConfigArgs
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
Visibility Changes to this property will trigger replacement. 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.
XrayEnabled bool
Whether tracing with X-ray is enabled. Defaults to false.
authenticationType This property is required. String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
additionalAuthenticationProviders List<GraphQLApiAdditionalAuthenticationProvider>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. String
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
enhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig String
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.
lambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn String
ARN of the execution role when api_type is set to MERGED.
name String

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit Integer

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.

resolverCountLimit Integer
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.
schema String
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags 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.
userPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled Boolean
Whether tracing with X-ray is enabled. Defaults to false.
authenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
additionalAuthenticationProviders GraphQLApiAdditionalAuthenticationProvider[]
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
enhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig string
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.
lambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
name string

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit number

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.

resolverCountLimit number
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.
schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags {[key: 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.
userPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled boolean
Whether tracing with X-ray is enabled. Defaults to false.
authentication_type This property is required. str
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
additional_authentication_providers Sequence[GraphQLApiAdditionalAuthenticationProviderArgs]
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
api_type Changes to this property will trigger replacement. str
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
enhanced_metrics_config GraphQLApiEnhancedMetricsConfigArgs
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspection_config str
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.
lambda_authorizer_config GraphQLApiLambdaAuthorizerConfigArgs
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
log_config GraphQLApiLogConfigArgs
Nested argument containing logging configuration. See log_config Block for details.
merged_api_execution_role_arn str
ARN of the execution role when api_type is set to MERGED.
name str

User-supplied name for the GraphQL API.

The following arguments are optional:

openid_connect_config GraphQLApiOpenidConnectConfigArgs
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
query_depth_limit 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.

resolver_count_limit 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.
schema str
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags Mapping[str, str]
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.
user_pool_config GraphQLApiUserPoolConfigArgs
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. str
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.
xray_enabled bool
Whether tracing with X-ray is enabled. Defaults to false.
authenticationType This property is required. String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
additionalAuthenticationProviders List<Property Map>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. String
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
enhancedMetricsConfig Property Map
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig String
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.
lambdaAuthorizerConfig Property Map
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig Property Map
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn String
ARN of the execution role when api_type is set to MERGED.
name String

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig Property Map
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit Number

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.

resolverCountLimit Number
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.
schema String
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags Map<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.
userPoolConfig Property Map
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled Boolean
Whether tracing with X-ray is enabled. Defaults to false.

Outputs

All input properties are implicitly available as output properties. Additionally, the GraphQLApi resource produces the following output properties:

Arn string
ARN
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uris Dictionary<string, string>
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
Arn string
ARN
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uris map[string]string
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
arn String
ARN
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris Map<String,String>
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
arn string
ARN
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris {[key: string]: string}
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
arn str
ARN
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris Mapping[str, str]
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
arn String
ARN
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

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

Look up Existing GraphQLApi Resource

Get an existing GraphQLApi resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GraphQLApiState, opts?: CustomResourceOptions): GraphQLApi
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_authentication_providers: Optional[Sequence[GraphQLApiAdditionalAuthenticationProviderArgs]] = None,
        api_type: Optional[str] = None,
        arn: Optional[str] = None,
        authentication_type: Optional[str] = None,
        enhanced_metrics_config: Optional[GraphQLApiEnhancedMetricsConfigArgs] = None,
        introspection_config: Optional[str] = None,
        lambda_authorizer_config: Optional[GraphQLApiLambdaAuthorizerConfigArgs] = None,
        log_config: Optional[GraphQLApiLogConfigArgs] = None,
        merged_api_execution_role_arn: Optional[str] = None,
        name: Optional[str] = None,
        openid_connect_config: Optional[GraphQLApiOpenidConnectConfigArgs] = None,
        query_depth_limit: Optional[int] = None,
        resolver_count_limit: Optional[int] = None,
        schema: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None,
        uris: Optional[Mapping[str, str]] = None,
        user_pool_config: Optional[GraphQLApiUserPoolConfigArgs] = None,
        visibility: Optional[str] = None,
        xray_enabled: Optional[bool] = None) -> GraphQLApi
func GetGraphQLApi(ctx *Context, name string, id IDInput, state *GraphQLApiState, opts ...ResourceOption) (*GraphQLApi, error)
public static GraphQLApi Get(string name, Input<string> id, GraphQLApiState? state, CustomResourceOptions? opts = null)
public static GraphQLApi get(String name, Output<String> id, GraphQLApiState state, CustomResourceOptions options)
resources:  _:    type: aws:appsync:GraphQLApi    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdditionalAuthenticationProviders List<GraphQLApiAdditionalAuthenticationProvider>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
ApiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
Arn string
ARN
AuthenticationType string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
EnhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
IntrospectionConfig string
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.
LambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
LogConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
MergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
Name string

User-supplied name for the GraphQL API.

The following arguments are optional:

OpenidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
QueryDepthLimit 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.

ResolverCountLimit 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.
Schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
Tags Dictionary<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.
TagsAll Dictionary<string, string>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uris Dictionary<string, string>
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
UserPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
Visibility Changes to this property will trigger replacement. 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.
XrayEnabled bool
Whether tracing with X-ray is enabled. Defaults to false.
AdditionalAuthenticationProviders []GraphQLApiAdditionalAuthenticationProviderArgs
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
ApiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
Arn string
ARN
AuthenticationType string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
EnhancedMetricsConfig GraphQLApiEnhancedMetricsConfigArgs
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
IntrospectionConfig string
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.
LambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfigArgs
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
LogConfig GraphQLApiLogConfigArgs
Nested argument containing logging configuration. See log_config Block for details.
MergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
Name string

User-supplied name for the GraphQL API.

The following arguments are optional:

OpenidConnectConfig GraphQLApiOpenidConnectConfigArgs
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
QueryDepthLimit 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.

ResolverCountLimit 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.
Schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
Tags 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.
TagsAll map[string]string
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Uris map[string]string
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
UserPoolConfig GraphQLApiUserPoolConfigArgs
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
Visibility Changes to this property will trigger replacement. 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.
XrayEnabled bool
Whether tracing with X-ray is enabled. Defaults to false.
additionalAuthenticationProviders List<GraphQLApiAdditionalAuthenticationProvider>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. String
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
arn String
ARN
authenticationType String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
enhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig String
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.
lambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn String
ARN of the execution role when api_type is set to MERGED.
name String

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit Integer

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.

resolverCountLimit Integer
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.
schema String
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags 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.
tagsAll Map<String,String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris Map<String,String>
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
userPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled Boolean
Whether tracing with X-ray is enabled. Defaults to false.
additionalAuthenticationProviders GraphQLApiAdditionalAuthenticationProvider[]
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. string
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
arn string
ARN
authenticationType string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
enhancedMetricsConfig GraphQLApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig string
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.
lambdaAuthorizerConfig GraphQLApiLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig GraphQLApiLogConfig
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn string
ARN of the execution role when api_type is set to MERGED.
name string

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig GraphQLApiOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit number

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.

resolverCountLimit number
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.
schema string
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags {[key: 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.
tagsAll {[key: string]: string}
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris {[key: string]: string}
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
userPoolConfig GraphQLApiUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled boolean
Whether tracing with X-ray is enabled. Defaults to false.
additional_authentication_providers Sequence[GraphQLApiAdditionalAuthenticationProviderArgs]
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
api_type Changes to this property will trigger replacement. str
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
arn str
ARN
authentication_type str
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
enhanced_metrics_config GraphQLApiEnhancedMetricsConfigArgs
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspection_config str
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.
lambda_authorizer_config GraphQLApiLambdaAuthorizerConfigArgs
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
log_config GraphQLApiLogConfigArgs
Nested argument containing logging configuration. See log_config Block for details.
merged_api_execution_role_arn str
ARN of the execution role when api_type is set to MERGED.
name str

User-supplied name for the GraphQL API.

The following arguments are optional:

openid_connect_config GraphQLApiOpenidConnectConfigArgs
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
query_depth_limit 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.

resolver_count_limit 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.
schema str
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags Mapping[str, str]
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.
tags_all Mapping[str, str]
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris Mapping[str, str]
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
user_pool_config GraphQLApiUserPoolConfigArgs
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. str
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.
xray_enabled bool
Whether tracing with X-ray is enabled. Defaults to false.
additionalAuthenticationProviders List<Property Map>
One or more additional authentication providers for the GraphQL API. See additional_authentication_provider Block for details.
apiType Changes to this property will trigger replacement. String
API type. Valid values are GRAPHQL or MERGED. A MERGED type requires merged_api_execution_role_arn to be set.
arn String
ARN
authenticationType String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
enhancedMetricsConfig Property Map
Enables and controls the enhanced metrics feature. See enhanced_metrics_config Block for details.
introspectionConfig String
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.
lambdaAuthorizerConfig Property Map
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
logConfig Property Map
Nested argument containing logging configuration. See log_config Block for details.
mergedApiExecutionRoleArn String
ARN of the execution role when api_type is set to MERGED.
name String

User-supplied name for the GraphQL API.

The following arguments are optional:

openidConnectConfig Property Map
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
queryDepthLimit Number

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.

resolverCountLimit Number
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.
schema String
Schema definition, in GraphQL schema language format. This provider cannot perform drift detection of this configuration.
tags Map<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.
tagsAll Map<String>
Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

uris Map<String>
Map of URIs associated with the API E.g., uris["GRAPHQL"] = https://ID.appsync-api.REGION.amazonaws.com/graphql
userPoolConfig Property Map
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
visibility Changes to this property will trigger replacement. 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.
xrayEnabled Boolean
Whether tracing with X-ray is enabled. Defaults to false.

Supporting Types

GraphQLApiAdditionalAuthenticationProvider
, GraphQLApiAdditionalAuthenticationProviderArgs

AuthenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
LambdaAuthorizerConfig GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
OpenidConnectConfig GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
UserPoolConfig GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
AuthenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
LambdaAuthorizerConfig GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
OpenidConnectConfig GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
UserPoolConfig GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
authenticationType This property is required. String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
lambdaAuthorizerConfig GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
openidConnectConfig GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
userPoolConfig GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
authenticationType This property is required. string
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
lambdaAuthorizerConfig GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
openidConnectConfig GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
userPoolConfig GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
authentication_type This property is required. str
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
lambda_authorizer_config GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
openid_connect_config GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
user_pool_config GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
Amazon Cognito User Pool configuration. See user_pool_config Block for details.
authenticationType This property is required. String
Authentication type. Valid values: API_KEY, AWS_IAM, AMAZON_COGNITO_USER_POOLS, OPENID_CONNECT, AWS_LAMBDA
lambdaAuthorizerConfig Property Map
Nested argument containing Lambda authorizer configuration. See lambda_authorizer_config Block for details.
openidConnectConfig Property Map
Nested argument containing OpenID Connect configuration. See openid_connect_config Block for details.
userPoolConfig Property Map
Amazon Cognito User Pool configuration. See user_pool_config Block for details.

GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfig
, GraphQLApiAdditionalAuthenticationProviderLambdaAuthorizerConfigArgs

AuthorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
AuthorizerResultTtlInSeconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
IdentityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
AuthorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
AuthorizerResultTtlInSeconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
IdentityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. String
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds Integer
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression String
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds number
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
authorizer_uri This property is required. str
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizer_result_ttl_in_seconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identity_validation_expression str
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. String
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds Number
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression String
Regular expression for validation of tokens before the Lambda function is called.

GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfig
, GraphQLApiAdditionalAuthenticationProviderOpenidConnectConfigArgs

Issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
AuthTtl int
Number of milliseconds a token is valid after being authenticated.
ClientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
IatTtl int
Number of milliseconds a token is valid after being issued to a user.
Issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
AuthTtl int
Number of milliseconds a token is valid after being authenticated.
ClientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
IatTtl int
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. String
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl Integer
Number of milliseconds a token is valid after being authenticated.
clientId String
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl Integer
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl number
Number of milliseconds a token is valid after being authenticated.
clientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl number
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. str
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
auth_ttl int
Number of milliseconds a token is valid after being authenticated.
client_id str
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iat_ttl int
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. String
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl Number
Number of milliseconds a token is valid after being authenticated.
clientId String
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl Number
Number of milliseconds a token is valid after being issued to a user.

GraphQLApiAdditionalAuthenticationProviderUserPoolConfig
, GraphQLApiAdditionalAuthenticationProviderUserPoolConfigArgs

UserPoolId This property is required. string
User pool ID.
AppIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
AwsRegion string
AWS region in which the user pool was created.
UserPoolId This property is required. string
User pool ID.
AppIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
AwsRegion string
AWS region in which the user pool was created.
userPoolId This property is required. String
User pool ID.
appIdClientRegex String
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion String
AWS region in which the user pool was created.
userPoolId This property is required. string
User pool ID.
appIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion string
AWS region in which the user pool was created.
user_pool_id This property is required. str
User pool ID.
app_id_client_regex str
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
aws_region str
AWS region in which the user pool was created.
userPoolId This property is required. String
User pool ID.
appIdClientRegex String
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion String
AWS region in which the user pool was created.

GraphQLApiEnhancedMetricsConfig
, GraphQLApiEnhancedMetricsConfigArgs

DataSourceLevelMetricsBehavior This property is required. string
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
OperationLevelMetricsConfig This property is required. string
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
ResolverLevelMetricsBehavior This property is required. string
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS
DataSourceLevelMetricsBehavior This property is required. string
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
OperationLevelMetricsConfig This property is required. string
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
ResolverLevelMetricsBehavior This property is required. string
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS
dataSourceLevelMetricsBehavior This property is required. String
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
operationLevelMetricsConfig This property is required. String
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
resolverLevelMetricsBehavior This property is required. String
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS
dataSourceLevelMetricsBehavior This property is required. string
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
operationLevelMetricsConfig This property is required. string
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
resolverLevelMetricsBehavior This property is required. string
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS
data_source_level_metrics_behavior This property is required. str
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
operation_level_metrics_config This property is required. str
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
resolver_level_metrics_behavior This property is required. str
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS
dataSourceLevelMetricsBehavior This property is required. String
How data source metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_DATA_SOURCE_METRICS, PER_DATA_SOURCE_METRICS
operationLevelMetricsConfig This property is required. String
How operation metrics will be emitted to CloudWatch. Valid values: ENABLED, DISABLED
resolverLevelMetricsBehavior This property is required. String
How resolver metrics will be emitted to CloudWatch. Valid values: FULL_REQUEST_RESOLVER_METRICS, PER_RESOLVER_METRICS

GraphQLApiLambdaAuthorizerConfig
, GraphQLApiLambdaAuthorizerConfigArgs

AuthorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
AuthorizerResultTtlInSeconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
IdentityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
AuthorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
AuthorizerResultTtlInSeconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
IdentityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. String
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds Integer
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression String
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. string
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds number
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression string
Regular expression for validation of tokens before the Lambda function is called.
authorizer_uri This property is required. str
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizer_result_ttl_in_seconds int
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identity_validation_expression str
Regular expression for validation of tokens before the Lambda function is called.
authorizerUri This property is required. String
ARN of the Lambda function to be called for authorization. Note: This Lambda function must have a resource-based policy assigned to it, to allow lambda:InvokeFunction from service principal appsync.amazonaws.com.
authorizerResultTtlInSeconds Number
Number of seconds a response should be cached for. The default is 5 minutes (300 seconds). The Lambda function can override this by returning a ttlOverride key in its response. A value of 0 disables caching of responses. Minimum value of 0. Maximum value of 3600.
identityValidationExpression String
Regular expression for validation of tokens before the Lambda function is called.

GraphQLApiLogConfig
, GraphQLApiLogConfigArgs

CloudwatchLogsRoleArn This property is required. string
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
FieldLogLevel This property is required. string
Field logging level. Valid values: ALL, ERROR, NONE.
ExcludeVerboseContent bool
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false
CloudwatchLogsRoleArn This property is required. string
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
FieldLogLevel This property is required. string
Field logging level. Valid values: ALL, ERROR, NONE.
ExcludeVerboseContent bool
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false
cloudwatchLogsRoleArn This property is required. String
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
fieldLogLevel This property is required. String
Field logging level. Valid values: ALL, ERROR, NONE.
excludeVerboseContent Boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false
cloudwatchLogsRoleArn This property is required. string
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
fieldLogLevel This property is required. string
Field logging level. Valid values: ALL, ERROR, NONE.
excludeVerboseContent boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false
cloudwatch_logs_role_arn This property is required. str
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
field_log_level This property is required. str
Field logging level. Valid values: ALL, ERROR, NONE.
exclude_verbose_content bool
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false
cloudwatchLogsRoleArn This property is required. String
Amazon Resource Name of the service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
fieldLogLevel This property is required. String
Field logging level. Valid values: ALL, ERROR, NONE.
excludeVerboseContent Boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level. Valid values: true, false. Default value: false

GraphQLApiOpenidConnectConfig
, GraphQLApiOpenidConnectConfigArgs

Issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
AuthTtl int
Number of milliseconds a token is valid after being authenticated.
ClientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
IatTtl int
Number of milliseconds a token is valid after being issued to a user.
Issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
AuthTtl int
Number of milliseconds a token is valid after being authenticated.
ClientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
IatTtl int
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. String
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl Integer
Number of milliseconds a token is valid after being authenticated.
clientId String
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl Integer
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. string
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl number
Number of milliseconds a token is valid after being authenticated.
clientId string
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl number
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. str
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
auth_ttl int
Number of milliseconds a token is valid after being authenticated.
client_id str
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iat_ttl int
Number of milliseconds a token is valid after being issued to a user.
issuer This property is required. String
Issuer for the OpenID Connect configuration. The issuer returned by discovery MUST exactly match the value of iss in the ID Token.
authTtl Number
Number of milliseconds a token is valid after being authenticated.
clientId String
Client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
iatTtl Number
Number of milliseconds a token is valid after being issued to a user.

GraphQLApiUserPoolConfig
, GraphQLApiUserPoolConfigArgs

DefaultAction This property is required. string
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
UserPoolId This property is required. string
User pool ID.
AppIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
AwsRegion string
AWS region in which the user pool was created.
DefaultAction This property is required. string
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
UserPoolId This property is required. string
User pool ID.
AppIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
AwsRegion string
AWS region in which the user pool was created.
defaultAction This property is required. String
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
userPoolId This property is required. String
User pool ID.
appIdClientRegex String
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion String
AWS region in which the user pool was created.
defaultAction This property is required. string
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
userPoolId This property is required. string
User pool ID.
appIdClientRegex string
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion string
AWS region in which the user pool was created.
default_action This property is required. str
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
user_pool_id This property is required. str
User pool ID.
app_id_client_regex str
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
aws_region str
AWS region in which the user pool was created.
defaultAction This property is required. String
Action that you want your GraphQL API to take when a request that uses Amazon Cognito User Pool authentication doesn't match the Amazon Cognito User Pool configuration. Valid: ALLOW and DENY
userPoolId This property is required. String
User pool ID.
appIdClientRegex String
Regular expression for validating the incoming Amazon Cognito User Pool app client ID.
awsRegion String
AWS region in which the user pool was created.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.77.0 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-aws