Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. appsync
  5. getResolver

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.appsync.getResolver

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-aws-native

    The AWS::AppSync::Resolver resource defines the logical GraphQL resolver that you attach to fields in a schema. Request and response templates for resolvers are written in Apache Velocity Template Language (VTL) format. For more information about resolvers, see Resolver Mapping Template Reference. When you submit an update, CFNLong updates resources based on differences between what you submit and the stack’s current template. To cause this resource to be updated you must change a property value for this resource in the CFNshort template. Changing the S3 file content without changing a property value will not result in an update operation. See Update Behaviors of Stack Resources in the User Guide.

    Using getResolver

    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 getResolver(args: GetResolverArgs, opts?: InvokeOptions): Promise<GetResolverResult>
function getResolverOutput(args: GetResolverOutputArgs, opts?: InvokeOptions): Output<GetResolverResult>
    def get_resolver(resolver_arn: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetResolverResult
def get_resolver_output(resolver_arn: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetResolverResult]
    func LookupResolver(ctx *Context, args *LookupResolverArgs, opts ...InvokeOption) (*LookupResolverResult, error)
func LookupResolverOutput(ctx *Context, args *LookupResolverOutputArgs, opts ...InvokeOption) LookupResolverResultOutput

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

    public static class GetResolver 
{
    public static Task<GetResolverResult> InvokeAsync(GetResolverArgs args, InvokeOptions? opts = null)
    public static Output<GetResolverResult> Invoke(GetResolverInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetResolverResult> getResolver(GetResolverArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:appsync:getResolver
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getResolver Result

    The following output properties are available:

    CachingConfig Pulumi.AwsNative.AppSync.Outputs.ResolverCachingConfig
    The caching configuration for the resolver.
    Code string
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    DataSourceName string
    The resolver data source name.
    Kind string
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    MaxBatchSize int
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    MetricsConfig Pulumi.AwsNative.AppSync.ResolverMetricsConfig
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    PipelineConfig Pulumi.AwsNative.AppSync.Outputs.ResolverPipelineConfig
    Functions linked with the pipeline resolver.
    RequestMappingTemplate string
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    ResolverArn string
    ResponseMappingTemplate string
    The response mapping template.
    Runtime Pulumi.AwsNative.AppSync.Outputs.ResolverAppSyncRuntime
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    SyncConfig Pulumi.AwsNative.AppSync.Outputs.ResolverSyncConfig
    The SyncConfig for a resolver attached to a versioned data source.
    CachingConfig ResolverCachingConfig
    The caching configuration for the resolver.
    Code string
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    DataSourceName string
    The resolver data source name.
    Kind string
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    MaxBatchSize int
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    MetricsConfig ResolverMetricsConfig
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    PipelineConfig ResolverPipelineConfig
    Functions linked with the pipeline resolver.
    RequestMappingTemplate string
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    ResolverArn string
    ResponseMappingTemplate string
    The response mapping template.
    Runtime ResolverAppSyncRuntime
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    SyncConfig ResolverSyncConfig
    The SyncConfig for a resolver attached to a versioned data source.
    cachingConfig ResolverCachingConfig
    The caching configuration for the resolver.
    code String
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    dataSourceName String
    The resolver data source name.
    kind String
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    maxBatchSize Integer
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    metricsConfig ResolverMetricsConfig
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    pipelineConfig ResolverPipelineConfig
    Functions linked with the pipeline resolver.
    requestMappingTemplate String
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    resolverArn String
    responseMappingTemplate String
    The response mapping template.
    runtime ResolverAppSyncRuntime
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    syncConfig ResolverSyncConfig
    The SyncConfig for a resolver attached to a versioned data source.
    cachingConfig ResolverCachingConfig
    The caching configuration for the resolver.
    code string
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    dataSourceName string
    The resolver data source name.
    kind string
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    maxBatchSize number
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    metricsConfig ResolverMetricsConfig
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    pipelineConfig ResolverPipelineConfig
    Functions linked with the pipeline resolver.
    requestMappingTemplate string
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    resolverArn string
    responseMappingTemplate string
    The response mapping template.
    runtime ResolverAppSyncRuntime
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    syncConfig ResolverSyncConfig
    The SyncConfig for a resolver attached to a versioned data source.
    caching_config ResolverCachingConfig
    The caching configuration for the resolver.
    code str
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    data_source_name str
    The resolver data source name.
    kind str
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    max_batch_size int
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    metrics_config ResolverMetricsConfig
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    pipeline_config ResolverPipelineConfig
    Functions linked with the pipeline resolver.
    request_mapping_template str
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    resolver_arn str
    response_mapping_template str
    The response mapping template.
    runtime ResolverAppSyncRuntime
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    sync_config ResolverSyncConfig
    The SyncConfig for a resolver attached to a versioned data source.
    cachingConfig Property Map
    The caching configuration for the resolver.
    code String
    The resolver code that contains the request and response functions. When code is used, the runtime is required. The runtime value must be APPSYNC_JS.
    dataSourceName String
    The resolver data source name.
    kind String
    The resolver type.

    • UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. You can use a UNIT resolver to run a GraphQL query against a single data source.
    • PIPELINE: A PIPELINE resolver type. You can use a PIPELINE resolver to invoke a series of Function objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.
    maxBatchSize Number
    The maximum number of resolver request inputs that will be sent to a single LAMlong function in a BatchInvoke operation.
    metricsConfig "ENABLED" | "DISABLED"
    Enables or disables enhanced resolver metrics for specified resolvers. Note that MetricsConfig won't be used unless the resolverLevelMetricsBehavior value is set to PER_RESOLVER_METRICS. If the resolverLevelMetricsBehavior is set to FULL_REQUEST_RESOLVER_METRICS instead, MetricsConfig will be ignored. However, you can still set its value.
    pipelineConfig Property Map
    Functions linked with the pipeline resolver.
    requestMappingTemplate String
    The request mapping template. Request mapping templates are optional when using a Lambda data source. For all other data sources, a request mapping template is required.
    resolverArn String
    responseMappingTemplate String
    The response mapping template.
    runtime Property Map
    Describes a runtime used by an APSYlong resolver or APSYlong function. Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
    syncConfig Property Map
    The SyncConfig for a resolver attached to a versioned data source.

    Supporting Types

    ResolverAppSyncRuntime

    Name string
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    RuntimeVersion string
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.
    Name string
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    RuntimeVersion string
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.
    name String
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    runtimeVersion String
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.
    name string
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    runtimeVersion string
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.
    name str
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    runtime_version str
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.
    name String
    The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
    runtimeVersion String
    The version of the runtime to use. Currently, the only allowed version is 1.0.0.

    ResolverCachingConfig

    Ttl double
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    CachingKeys List<string>
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
    Ttl float64
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    CachingKeys []string
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
    ttl Double
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    cachingKeys List<String>
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
    ttl number
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    cachingKeys string[]
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
    ttl float
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    caching_keys Sequence[str]
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.
    ttl Number
    The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.
    cachingKeys List<String>
    The caching keys for a resolver that has caching activated. Valid values are entries from the $context.arguments, $context.source, and $context.identity maps.

    ResolverLambdaConflictHandlerConfig

    LambdaConflictHandlerArn string
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
    LambdaConflictHandlerArn string
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
    lambdaConflictHandlerArn String
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
    lambdaConflictHandlerArn string
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
    lambda_conflict_handler_arn str
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
    lambdaConflictHandlerArn String
    The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.

    ResolverMetricsConfig

    ResolverPipelineConfig

    Functions List<string>
    A list of Function objects.
    Functions []string
    A list of Function objects.
    functions List<String>
    A list of Function objects.
    functions string[]
    A list of Function objects.
    functions Sequence[str]
    A list of Function objects.
    functions List<String>
    A list of Function objects.

    ResolverSyncConfig

    ConflictDetection string
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    ConflictHandler string
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    LambdaConflictHandlerConfig Pulumi.AwsNative.AppSync.Inputs.ResolverLambdaConflictHandlerConfig
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
    ConflictDetection string
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    ConflictHandler string
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    LambdaConflictHandlerConfig ResolverLambdaConflictHandlerConfig
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
    conflictDetection String
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    conflictHandler String
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    lambdaConflictHandlerConfig ResolverLambdaConflictHandlerConfig
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
    conflictDetection string
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    conflictHandler string
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    lambdaConflictHandlerConfig ResolverLambdaConflictHandlerConfig
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
    conflict_detection str
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    conflict_handler str
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    lambda_conflict_handler_config ResolverLambdaConflictHandlerConfig
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
    conflictDetection String
    The Conflict Detection strategy to use.

    • VERSION: Detect conflicts based on object versions for this resolver.
    • NONE: Do not detect conflicts when invoking this resolver.
    conflictHandler String
    The Conflict Resolution strategy to perform in the event of a conflict.

    • OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions don't match the latest version at the server.
    • AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy.
    • LAMBDA: Resolve conflicts with an LAMlong function supplied in the LambdaConflictHandlerConfig.
    lambdaConflictHandlerConfig Property Map
    The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-aws-native