AWS Tools for Windows PowerShell
Command Reference

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

Synopsis

Calls the AWS AppSync CreateResolver API operation.

Syntax

New-ASYNResolver
-DataSourceName <String>
-ApiId <String>
-CachingConfig_CachingKey <String[]>
-Code <String>
-SyncConfig_ConflictDetection <ConflictDetectionType>
-SyncConfig_ConflictHandler <ConflictHandlerType>
-FieldName <String>
-PipelineConfig_Function <String[]>
-Kind <ResolverKind>
-LambdaConflictHandlerConfig_LambdaConflictHandlerArn <String>
-MaxBatchSize <Int32>
-MetricsConfig <ResolverLevelMetricsConfig>
-Runtime_Name <RuntimeName>
-RequestMappingTemplate <String>
-ResponseMappingTemplate <String>
-Runtime_RuntimeVersion <String>
-CachingConfig_Ttl <Int64>
-TypeName <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonAppSyncConfig>

Description

Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand, and converts the data source's responses into GraphQL.

Parameters

-ApiId <String>
The ID for the GraphQL API for which the resolver is being created.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-CachingConfig_CachingKey <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. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCachingConfig_CachingKeys
-CachingConfig_Ttl <Int64>
The TTL in seconds for a resolver that has caching activated.Valid values are 1–3,600 seconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonAppSyncConfig>
Amazon.PowerShell.Cmdlets.ASYN.AmazonAppSyncClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DataSourceName <String>
The name of the data source for which the resolver is being created.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-FieldName <String>
The name of the field to attach the resolver to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Kind <ResolverKind>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-LambdaConflictHandlerConfig_LambdaConflictHandlerArn <String>
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSyncConfig_LambdaConflictHandlerConfig_LambdaConflictHandlerArn
-MaxBatchSize <Int32>
The maximum batching size for a resolver.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-MetricsConfig <ResolverLevelMetricsConfig>
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.metricsConfig can be ENABLED or DISABLED.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PipelineConfig_Function <String[]>
A list of Function objects. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesPipelineConfig_Functions
-RequestMappingTemplate <String>
The mapping template to use for requests.A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).VTL request mapping templates are optional when using an Lambda data source. For all other data sources, VTL request and response mapping templates are required.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ResponseMappingTemplate <String>
The mapping template to use for responses from the data source.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Runtime_Name <RuntimeName>
The name of the runtime to use. Currently, the only allowed value is APPSYNC_JS.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Runtime_RuntimeVersion <String>
The version of the runtime to use. Currently, the only allowed version is 1.0.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Resolver'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.AppSync.Model.CreateResolverResponse). Specifying the name of a property of type Amazon.AppSync.Model.CreateResolverResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SyncConfig_ConflictDetection <ConflictDetectionType>
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.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SyncConfig_ConflictHandler <ConflictHandlerType>
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 Lambda function supplied in the LambdaConflictHandlerConfig.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TypeName <String>
The name of the Type.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.AppSync.Model.Resolver or Amazon.AppSync.Model.CreateResolverResponse
This cmdlet returns an Amazon.AppSync.Model.Resolver object. The service call response (type Amazon.AppSync.Model.CreateResolverResponse) can be returned by specifying '-Select *'.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z