Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. appsync
  5. getGraphQlApi

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.getGraphQlApi

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource Type definition for AWS::AppSync::GraphQLApi

Using getGraphQlApi

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGraphQlApi(args: GetGraphQlApiArgs, opts?: InvokeOptions): Promise<GetGraphQlApiResult>
function getGraphQlApiOutput(args: GetGraphQlApiOutputArgs, opts?: InvokeOptions): Output<GetGraphQlApiResult>
Copy
def get_graph_ql_api(api_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetGraphQlApiResult
def get_graph_ql_api_output(api_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetGraphQlApiResult]
Copy
func LookupGraphQlApi(ctx *Context, args *LookupGraphQlApiArgs, opts ...InvokeOption) (*LookupGraphQlApiResult, error)
func LookupGraphQlApiOutput(ctx *Context, args *LookupGraphQlApiOutputArgs, opts ...InvokeOption) LookupGraphQlApiResultOutput
Copy

> Note: This function is named LookupGraphQlApi in the Go SDK.

public static class GetGraphQlApi 
{
    public static Task<GetGraphQlApiResult> InvokeAsync(GetGraphQlApiArgs args, InvokeOptions? opts = null)
    public static Output<GetGraphQlApiResult> Invoke(GetGraphQlApiInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGraphQlApiResult> getGraphQlApi(GetGraphQlApiArgs args, InvokeOptions options)
public static Output<GetGraphQlApiResult> getGraphQlApi(GetGraphQlApiArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws-native:appsync:getGraphQlApi
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApiId This property is required. string
Unique AWS AppSync GraphQL API identifier.
ApiId This property is required. string
Unique AWS AppSync GraphQL API identifier.
apiId This property is required. String
Unique AWS AppSync GraphQL API identifier.
apiId This property is required. string
Unique AWS AppSync GraphQL API identifier.
api_id This property is required. str
Unique AWS AppSync GraphQL API identifier.
apiId This property is required. String
Unique AWS AppSync GraphQL API identifier.

getGraphQlApi Result

The following output properties are available:

AdditionalAuthenticationProviders List<Pulumi.AwsNative.AppSync.Outputs.GraphQlApiAdditionalAuthenticationProvider>
A list of additional authentication providers for the GraphqlApi API.
ApiId string
Unique AWS AppSync GraphQL API identifier.
ApiType string
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
Arn string
The Amazon Resource Name (ARN) of the API key
AuthenticationType string
Security configuration for your GraphQL API
EnhancedMetricsConfig Pulumi.AwsNative.AppSync.Outputs.GraphQlApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
EnvironmentVariables Dictionary<string, string>
A map containing the list of resources with their properties and environment variables.
GraphQlDns string
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
GraphQlEndpointArn string
The GraphQL endpoint ARN.
GraphQlUrl string
The Endpoint URL of your GraphQL API.
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.
LambdaAuthorizerConfig Pulumi.AwsNative.AppSync.Outputs.GraphQlApiLambdaAuthorizerConfig
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
LogConfig Pulumi.AwsNative.AppSync.Outputs.GraphQlApiLogConfig
The Amazon CloudWatch Logs configuration.
MergedApiExecutionRoleArn string
The AWS Identity and Access Management service role ARN for a merged API.
Name string
The API name
OpenIdConnectConfig Pulumi.AwsNative.AppSync.Outputs.GraphQlApiOpenIdConnectConfig
The OpenID Connect configuration.
OwnerContact string
The owner contact information for an API resource.
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.
RealtimeDns string
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
RealtimeUrl string
The GraphQL API real-time endpoint URL.
ResolverCountLimit int
The maximum number of resolvers that can be invoked in a single request.
Tags List<Pulumi.AwsNative.Outputs.Tag>
An arbitrary set of tags (key-value pairs) for this GraphQL API.
UserPoolConfig Pulumi.AwsNative.AppSync.Outputs.GraphQlApiUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
Visibility string
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
XrayEnabled bool
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
AdditionalAuthenticationProviders []GraphQlApiAdditionalAuthenticationProvider
A list of additional authentication providers for the GraphqlApi API.
ApiId string
Unique AWS AppSync GraphQL API identifier.
ApiType string
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
Arn string
The Amazon Resource Name (ARN) of the API key
AuthenticationType string
Security configuration for your GraphQL API
EnhancedMetricsConfig GraphQlApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
EnvironmentVariables map[string]string
A map containing the list of resources with their properties and environment variables.
GraphQlDns string
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
GraphQlEndpointArn string
The GraphQL endpoint ARN.
GraphQlUrl string
The Endpoint URL of your GraphQL API.
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.
LambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
LogConfig GraphQlApiLogConfig
The Amazon CloudWatch Logs configuration.
MergedApiExecutionRoleArn string
The AWS Identity and Access Management service role ARN for a merged API.
Name string
The API name
OpenIdConnectConfig GraphQlApiOpenIdConnectConfig
The OpenID Connect configuration.
OwnerContact string
The owner contact information for an API resource.
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.
RealtimeDns string
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
RealtimeUrl string
The GraphQL API real-time endpoint URL.
ResolverCountLimit int
The maximum number of resolvers that can be invoked in a single request.
Tags Tag
An arbitrary set of tags (key-value pairs) for this GraphQL API.
UserPoolConfig GraphQlApiUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
Visibility string
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
XrayEnabled bool
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
additionalAuthenticationProviders List<GraphQlApiAdditionalAuthenticationProvider>
A list of additional authentication providers for the GraphqlApi API.
apiId String
Unique AWS AppSync GraphQL API identifier.
apiType String
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
arn String
The Amazon Resource Name (ARN) of the API key
authenticationType String
Security configuration for your GraphQL API
enhancedMetricsConfig GraphQlApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
environmentVariables Map<String,String>
A map containing the list of resources with their properties and environment variables.
graphQlDns String
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
graphQlEndpointArn String
The GraphQL endpoint ARN.
graphQlUrl String
The Endpoint URL of your GraphQL API.
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.
lambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
logConfig GraphQlApiLogConfig
The Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn String
The AWS Identity and Access Management service role ARN for a merged API.
name String
The API name
openIdConnectConfig GraphQlApiOpenIdConnectConfig
The OpenID Connect configuration.
ownerContact String
The owner contact information for an API resource.
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.
realtimeDns String
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
realtimeUrl String
The GraphQL API real-time endpoint URL.
resolverCountLimit Integer
The maximum number of resolvers that can be invoked in a single request.
tags List<Tag>
An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfig GraphQlApiUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility String
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
xrayEnabled Boolean
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
additionalAuthenticationProviders GraphQlApiAdditionalAuthenticationProvider[]
A list of additional authentication providers for the GraphqlApi API.
apiId string
Unique AWS AppSync GraphQL API identifier.
apiType string
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
arn string
The Amazon Resource Name (ARN) of the API key
authenticationType string
Security configuration for your GraphQL API
enhancedMetricsConfig GraphQlApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
environmentVariables {[key: string]: string}
A map containing the list of resources with their properties and environment variables.
graphQlDns string
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
graphQlEndpointArn string
The GraphQL endpoint ARN.
graphQlUrl string
The Endpoint URL of your GraphQL API.
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.
lambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
logConfig GraphQlApiLogConfig
The Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn string
The AWS Identity and Access Management service role ARN for a merged API.
name string
The API name
openIdConnectConfig GraphQlApiOpenIdConnectConfig
The OpenID Connect configuration.
ownerContact string
The owner contact information for an API resource.
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.
realtimeDns string
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
realtimeUrl string
The GraphQL API real-time endpoint URL.
resolverCountLimit number
The maximum number of resolvers that can be invoked in a single request.
tags Tag[]
An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfig GraphQlApiUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility string
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
xrayEnabled boolean
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
additional_authentication_providers Sequence[GraphQlApiAdditionalAuthenticationProvider]
A list of additional authentication providers for the GraphqlApi API.
api_id str
Unique AWS AppSync GraphQL API identifier.
api_type str
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
arn str
The Amazon Resource Name (ARN) of the API key
authentication_type str
Security configuration for your GraphQL API
enhanced_metrics_config GraphQlApiEnhancedMetricsConfig
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
environment_variables Mapping[str, str]
A map containing the list of resources with their properties and environment variables.
graph_ql_dns str
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
graph_ql_endpoint_arn str
The GraphQL endpoint ARN.
graph_ql_url str
The Endpoint URL of your GraphQL API.
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.
lambda_authorizer_config GraphQlApiLambdaAuthorizerConfig
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
log_config GraphQlApiLogConfig
The Amazon CloudWatch Logs configuration.
merged_api_execution_role_arn str
The AWS Identity and Access Management service role ARN for a merged API.
name str
The API name
open_id_connect_config GraphQlApiOpenIdConnectConfig
The OpenID Connect configuration.
owner_contact str
The owner contact information for an API resource.
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.
realtime_dns str
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
realtime_url str
The GraphQL API real-time endpoint URL.
resolver_count_limit int
The maximum number of resolvers that can be invoked in a single request.
tags Sequence[root_Tag]
An arbitrary set of tags (key-value pairs) for this GraphQL API.
user_pool_config GraphQlApiUserPoolConfig
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility str
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
xray_enabled bool
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.
additionalAuthenticationProviders List<Property Map>
A list of additional authentication providers for the GraphqlApi API.
apiId String
Unique AWS AppSync GraphQL API identifier.
apiType String
The value that indicates whether the GraphQL API is a standard API (GRAPHQL) or merged API (MERGED).
arn String
The Amazon Resource Name (ARN) of the API key
authenticationType String
Security configuration for your GraphQL API
enhancedMetricsConfig Property Map
Enables and controls the enhanced metrics feature. Enhanced metrics emit granular data on API usage and performance such as AppSync request and error counts, latency, and cache hits/misses. All enhanced metric data is sent to your CloudWatch account, and you can configure the types of data that will be sent.
environmentVariables Map<String>
A map containing the list of resources with their properties and environment variables.
graphQlDns String
The fully qualified domain name (FQDN) of the endpoint URL of your GraphQL API.
graphQlEndpointArn String
The GraphQL endpoint ARN.
graphQlUrl String
The Endpoint URL of your GraphQL API.
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.
lambdaAuthorizerConfig Property Map
A LambdaAuthorizerConfig holds configuration on how to authorize AWS AppSync API access when using the AWS_LAMBDA authorizer mode. Be aware that an AWS AppSync API may have only one Lambda authorizer configured at a time.
logConfig Property Map
The Amazon CloudWatch Logs configuration.
mergedApiExecutionRoleArn String
The AWS Identity and Access Management service role ARN for a merged API.
name String
The API name
openIdConnectConfig Property Map
The OpenID Connect configuration.
ownerContact String
The owner contact information for an API resource.
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.
realtimeDns String
The fully qualified domain name (FQDN) of the real-time endpoint URL of your GraphQL API.
realtimeUrl String
The GraphQL API real-time endpoint URL.
resolverCountLimit Number
The maximum number of resolvers that can be invoked in a single request.
tags List<Property Map>
An arbitrary set of tags (key-value pairs) for this GraphQL API.
userPoolConfig Property Map
Optional authorization configuration for using Amazon Cognito user pools with your GraphQL endpoint.
visibility String
Sets the scope of the GraphQL API to public (GLOBAL) or private (PRIVATE). By default, the scope is set to Global if no value is provided.
xrayEnabled Boolean
A flag indicating whether to use AWS X-Ray tracing for this GraphqlApi.

Supporting Types

GraphQlApiAdditionalAuthenticationProvider

AuthenticationType This property is required. string
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
LambdaAuthorizerConfig Pulumi.AwsNative.AppSync.Inputs.GraphQlApiLambdaAuthorizerConfig
Configuration for AWS Lambda function authorization.
OpenIdConnectConfig Pulumi.AwsNative.AppSync.Inputs.GraphQlApiOpenIdConnectConfig
The OIDC configuration.
UserPoolConfig Pulumi.AwsNative.AppSync.Inputs.GraphQlApiCognitoUserPoolConfig
The Amazon Cognito user pool configuration.
AuthenticationType This property is required. string
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
LambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
Configuration for AWS Lambda function authorization.
OpenIdConnectConfig GraphQlApiOpenIdConnectConfig
The OIDC configuration.
UserPoolConfig GraphQlApiCognitoUserPoolConfig
The Amazon Cognito user pool configuration.
authenticationType This property is required. String
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
lambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
Configuration for AWS Lambda function authorization.
openIdConnectConfig GraphQlApiOpenIdConnectConfig
The OIDC configuration.
userPoolConfig GraphQlApiCognitoUserPoolConfig
The Amazon Cognito user pool configuration.
authenticationType This property is required. string
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
lambdaAuthorizerConfig GraphQlApiLambdaAuthorizerConfig
Configuration for AWS Lambda function authorization.
openIdConnectConfig GraphQlApiOpenIdConnectConfig
The OIDC configuration.
userPoolConfig GraphQlApiCognitoUserPoolConfig
The Amazon Cognito user pool configuration.
authentication_type This property is required. str
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
lambda_authorizer_config GraphQlApiLambdaAuthorizerConfig
Configuration for AWS Lambda function authorization.
open_id_connect_config GraphQlApiOpenIdConnectConfig
The OIDC configuration.
user_pool_config GraphQlApiCognitoUserPoolConfig
The Amazon Cognito user pool configuration.
authenticationType This property is required. String
The authentication type for API key, AWS Identity and Access Management, OIDC, Amazon Cognito user pools, or AWS Lambda.
lambdaAuthorizerConfig Property Map
Configuration for AWS Lambda function authorization.
openIdConnectConfig Property Map
The OIDC configuration.
userPoolConfig Property Map
The Amazon Cognito user pool configuration.

GraphQlApiCognitoUserPoolConfig

AppIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
AwsRegion string
The AWS Region in which the user pool was created.
UserPoolId string
The user pool ID
AppIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
AwsRegion string
The AWS Region in which the user pool was created.
UserPoolId string
The user pool ID
appIdClientRegex String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion String
The AWS Region in which the user pool was created.
userPoolId String
The user pool ID
appIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion string
The AWS Region in which the user pool was created.
userPoolId string
The user pool ID
app_id_client_regex str
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
aws_region str
The AWS Region in which the user pool was created.
user_pool_id str
The user pool ID
appIdClientRegex String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion String
The AWS Region in which the user pool was created.
userPoolId String
The user pool ID

GraphQlApiEnhancedMetricsConfig

DataSourceLevelMetricsBehavior This property is required. string
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
OperationLevelMetricsConfig This property is required. string
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
ResolverLevelMetricsBehavior This property is required. string
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
DataSourceLevelMetricsBehavior This property is required. string
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
OperationLevelMetricsConfig This property is required. string
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
ResolverLevelMetricsBehavior This property is required. string
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
dataSourceLevelMetricsBehavior This property is required. String
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
operationLevelMetricsConfig This property is required. String
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
resolverLevelMetricsBehavior This property is required. String
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
dataSourceLevelMetricsBehavior This property is required. string
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
operationLevelMetricsConfig This property is required. string
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
resolverLevelMetricsBehavior This property is required. string
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
data_source_level_metrics_behavior This property is required. str
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
operation_level_metrics_config This property is required. str
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
resolver_level_metrics_behavior This property is required. str
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:
dataSourceLevelMetricsBehavior This property is required. String
Controls how data source metrics will be emitted to CloudWatch. Data source metrics include:
operationLevelMetricsConfig This property is required. String
Controls how operation metrics will be emitted to CloudWatch. Operation metrics include:
resolverLevelMetricsBehavior This property is required. String
Controls how resolver metrics will be emitted to CloudWatch. Resolver metrics include:

GraphQlApiLambdaAuthorizerConfig

AuthorizerResultTtlInSeconds int
The number of seconds a response should be cached for.
AuthorizerUri string
The ARN of the Lambda function to be called for authorization.
IdentityValidationExpression string
A regular expression for validation of tokens before the Lambda function is called.
AuthorizerResultTtlInSeconds int
The number of seconds a response should be cached for.
AuthorizerUri string
The ARN of the Lambda function to be called for authorization.
IdentityValidationExpression string
A regular expression for validation of tokens before the Lambda function is called.
authorizerResultTtlInSeconds Integer
The number of seconds a response should be cached for.
authorizerUri String
The ARN of the Lambda function to be called for authorization.
identityValidationExpression String
A regular expression for validation of tokens before the Lambda function is called.
authorizerResultTtlInSeconds number
The number of seconds a response should be cached for.
authorizerUri string
The ARN of the Lambda function to be called for authorization.
identityValidationExpression string
A regular expression for validation of tokens before the Lambda function is called.
authorizer_result_ttl_in_seconds int
The number of seconds a response should be cached for.
authorizer_uri str
The ARN of the Lambda function to be called for authorization.
identity_validation_expression str
A regular expression for validation of tokens before the Lambda function is called.
authorizerResultTtlInSeconds Number
The number of seconds a response should be cached for.
authorizerUri String
The ARN of the Lambda function to be called for authorization.
identityValidationExpression String
A regular expression for validation of tokens before the Lambda function is called.

GraphQlApiLogConfig

CloudWatchLogsRoleArn string
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
ExcludeVerboseContent bool
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
FieldLogLevel string
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
CloudWatchLogsRoleArn string
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
ExcludeVerboseContent bool
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
FieldLogLevel string
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
cloudWatchLogsRoleArn String
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
excludeVerboseContent Boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
fieldLogLevel String
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
cloudWatchLogsRoleArn string
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
excludeVerboseContent boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
fieldLogLevel string
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
cloud_watch_logs_role_arn str
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
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.
field_log_level str
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.
cloudWatchLogsRoleArn String
The service role that AWS AppSync will assume to publish to Amazon CloudWatch Logs in your account.
excludeVerboseContent Boolean
Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
fieldLogLevel String
The field logging level. Values can be NONE, ERROR, INFO, DEBUG, or ALL.

GraphQlApiOpenIdConnectConfig

AuthTtl double
The number of milliseconds that a token is valid after being authenticated.
ClientId string
The client identifier of the Relying party at the OpenID identity provider.
IatTtl double
The number of milliseconds that a token is valid after it's issued to a user.
Issuer string
The issuer for the OIDC configuration.
AuthTtl float64
The number of milliseconds that a token is valid after being authenticated.
ClientId string
The client identifier of the Relying party at the OpenID identity provider.
IatTtl float64
The number of milliseconds that a token is valid after it's issued to a user.
Issuer string
The issuer for the OIDC configuration.
authTtl Double
The number of milliseconds that a token is valid after being authenticated.
clientId String
The client identifier of the Relying party at the OpenID identity provider.
iatTtl Double
The number of milliseconds that a token is valid after it's issued to a user.
issuer String
The issuer for the OIDC configuration.
authTtl number
The number of milliseconds that a token is valid after being authenticated.
clientId string
The client identifier of the Relying party at the OpenID identity provider.
iatTtl number
The number of milliseconds that a token is valid after it's issued to a user.
issuer string
The issuer for the OIDC configuration.
auth_ttl float
The number of milliseconds that a token is valid after being authenticated.
client_id str
The client identifier of the Relying party at the OpenID identity provider.
iat_ttl float
The number of milliseconds that a token is valid after it's issued to a user.
issuer str
The issuer for the OIDC configuration.
authTtl Number
The number of milliseconds that a token is valid after being authenticated.
clientId String
The client identifier of the Relying party at the OpenID identity provider.
iatTtl Number
The number of milliseconds that a token is valid after it's issued to a user.
issuer String
The issuer for the OIDC configuration.

GraphQlApiUserPoolConfig

AppIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
AwsRegion string
The AWS Region in which the user pool was created.
DefaultAction string
The 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.
UserPoolId string
The user pool ID.
AppIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
AwsRegion string
The AWS Region in which the user pool was created.
DefaultAction string
The 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.
UserPoolId string
The user pool ID.
appIdClientRegex String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion String
The AWS Region in which the user pool was created.
defaultAction String
The 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.
userPoolId String
The user pool ID.
appIdClientRegex string
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion string
The AWS Region in which the user pool was created.
defaultAction string
The 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.
userPoolId string
The user pool ID.
app_id_client_regex str
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
aws_region str
The AWS Region in which the user pool was created.
default_action str
The 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.
user_pool_id str
The user pool ID.
appIdClientRegex String
A regular expression for validating the incoming Amazon Cognito user pool app client ID.
awsRegion String
The AWS Region in which the user pool was created.
defaultAction String
The 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.
userPoolId String
The user pool ID.

Tag

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native