CfnResolver
- class aws_cdk.aws_appsync.CfnResolver(scope, id, *, api_id, field_name, type_name, caching_config=None, code=None, code_s3_location=None, data_source_name=None, kind=None, max_batch_size=None, pipeline_config=None, request_mapping_template=None, request_mapping_template_s3_location=None, response_mapping_template=None, response_mapping_template_s3_location=None, runtime=None, sync_config=None)
Bases:
CfnResource
A CloudFormation
AWS::AppSync::Resolver
.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 . .. epigraph:When you submit an update, AWS CloudFormation 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 CloudFormation template. Changing the Amazon S3 file content without changing a property value will not result in an update operation. See `Update Behaviors of Stack Resources <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html>`_ in the *AWS CloudFormation User Guide* .
- CloudformationResource:
AWS::AppSync::Resolver
- Link:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appsync-resolver.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync cfn_resolver = appsync.CfnResolver(self, "MyCfnResolver", api_id="apiId", field_name="fieldName", type_name="typeName", # the properties below are optional caching_config=appsync.CfnResolver.CachingConfigProperty( ttl=123, # the properties below are optional caching_keys=["cachingKeys"] ), code="code", code_s3_location="codeS3Location", data_source_name="dataSourceName", kind="kind", max_batch_size=123, pipeline_config=appsync.CfnResolver.PipelineConfigProperty( functions=["functions"] ), request_mapping_template="requestMappingTemplate", request_mapping_template_s3_location="requestMappingTemplateS3Location", response_mapping_template="responseMappingTemplate", response_mapping_template_s3_location="responseMappingTemplateS3Location", runtime=appsync.CfnResolver.AppSyncRuntimeProperty( name="name", runtime_version="runtimeVersion" ), sync_config=appsync.CfnResolver.SyncConfigProperty( conflict_detection="conflictDetection", # the properties below are optional conflict_handler="conflictHandler", lambda_conflict_handler_config=appsync.CfnResolver.LambdaConflictHandlerConfigProperty( lambda_conflict_handler_arn="lambdaConflictHandlerArn" ) ) )
Create a new
AWS::AppSync::Resolver
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
api_id (
str
) – The AWS AppSync GraphQL API to which you want to attach this resolver.field_name (
str
) – The GraphQL field on a type that invokes the resolver.type_name (
str
) – The GraphQL type that invokes this resolver.caching_config (
Union
[IResolvable
,CachingConfigProperty
,Dict
[str
,Any
],None
]) – The caching configuration for the resolver.code (
Optional
[str
]) – Theresolver
code that contains the request and response functions. When code is used, theruntime
is required. The runtime value must beAPPSYNC_JS
.code_s3_location (
Optional
[str
]) – The Amazon S3 endpoint.data_source_name (
Optional
[str
]) – The resolver data source name.kind (
Optional
[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 ofFunction
objects in a serial manner. You can use a pipeline resolver to run a GraphQL query against multiple data sources.max_batch_size (
Union
[int
,float
,None
]) – The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in aBatchInvoke
operation.pipeline_config (
Union
[IResolvable
,PipelineConfigProperty
,Dict
[str
,Any
],None
]) – Functions linked with the pipeline resolver.request_mapping_template (
Optional
[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.request_mapping_template_s3_location (
Optional
[str
]) – The location of a request mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.response_mapping_template (
Optional
[str
]) – The response mapping template.response_mapping_template_s3_location (
Optional
[str
]) – The location of a response mapping template in an Amazon S3 bucket. Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.runtime (
Union
[IResolvable
,AppSyncRuntimeProperty
,Dict
[str
,Any
],None
]) – Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync 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 (
Union
[IResolvable
,SyncConfigProperty
,Dict
[str
,Any
],None
]) – TheSyncConfig
for a resolver attached to a versioned data source.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
with “Properties.” (i.e.Properties.TopicName
).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.
in the property name, prefix with a\
. In most programming languages you will need to write this as"\\."
because the\
itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY
), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn
), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::AppSync::Resolver'
- api_id
The AWS AppSync GraphQL API to which you want to attach this resolver.
- attr_field_name
The GraphQL field on a type that invokes the resolver.
- CloudformationAttribute:
FieldName
- attr_resolver_arn
ARN of the resolver, such as
arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername
.- CloudformationAttribute:
ResolverArn
- attr_type_name
The GraphQL type that invokes this resolver.
- CloudformationAttribute:
TypeName
- caching_config
The caching configuration for the resolver.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- code
The
resolver
code that contains the request and response functions.When code is used, the
runtime
is required. The runtime value must beAPPSYNC_JS
.
- code_s3_location
The Amazon S3 endpoint.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- data_source_name
The resolver data source name.
- field_name
The GraphQL field on a type that invokes the resolver.
- kind
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.
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- max_batch_size
The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a
BatchInvoke
operation.
- node
The construct tree node associated with this construct.
- pipeline_config
Functions linked with the pipeline resolver.
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }
for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref })
.
- request_mapping_template
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.
- request_mapping_template_s3_location
The location of a request mapping template in an Amazon S3 bucket.
Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
- response_mapping_template
The response mapping template.
- response_mapping_template_s3_location
The location of a response mapping template in an Amazon S3 bucket.
Use this if you want to provision with a template file in Amazon S3 rather than embedding it in your CloudFormation template.
- runtime
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- sync_config
The
SyncConfig
for a resolver attached to a versioned data source.
- type_name
The GraphQL type that invokes this resolver.
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
AppSyncRuntimeProperty
- class CfnResolver.AppSyncRuntimeProperty(*, name, runtime_version)
Bases:
object
Describes a runtime used by an AWS AppSync pipeline resolver or AWS AppSync function.
Specifies the name and version of the runtime to use. Note that if a runtime is specified, code must also be specified.
- Parameters:
name (
str
) – Thename
of the runtime to use. Currently, the only allowed value isAPPSYNC_JS
.runtime_version (
str
) – Theversion
of the runtime to use. Currently, the only allowed version is1.0.0
.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync app_sync_runtime_property = appsync.CfnResolver.AppSyncRuntimeProperty( name="name", runtime_version="runtimeVersion" )
Attributes
- name
The
name
of the runtime to use.Currently, the only allowed value is
APPSYNC_JS
.
- runtime_version
The
version
of the runtime to use.Currently, the only allowed version is
1.0.0
.
CachingConfigProperty
- class CfnResolver.CachingConfigProperty(*, ttl, caching_keys=None)
Bases:
object
The caching configuration for a resolver that has caching activated.
- Parameters:
ttl (
Union
[int
,float
]) – The TTL in seconds for a resolver that has caching activated. Valid values are 1–3,600 seconds.caching_keys (
Optional
[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.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync caching_config_property = appsync.CfnResolver.CachingConfigProperty( ttl=123, # the properties below are optional caching_keys=["cachingKeys"] )
Attributes
- caching_keys
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
The TTL in seconds for a resolver that has caching activated.
Valid values are 1–3,600 seconds.
LambdaConflictHandlerConfigProperty
- class CfnResolver.LambdaConflictHandlerConfigProperty(*, lambda_conflict_handler_arn=None)
Bases:
object
The
LambdaConflictHandlerConfig
when configuring LAMBDA as the Conflict Handler.- Parameters:
lambda_conflict_handler_arn (
Optional
[str
]) – The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync lambda_conflict_handler_config_property = appsync.CfnResolver.LambdaConflictHandlerConfigProperty( lambda_conflict_handler_arn="lambdaConflictHandlerArn" )
Attributes
- lambda_conflict_handler_arn
The Amazon Resource Name (ARN) for the Lambda function to use as the Conflict Handler.
PipelineConfigProperty
- class CfnResolver.PipelineConfigProperty(*, functions=None)
Bases:
object
Use the
PipelineConfig
property type to specifyPipelineConfig
for an AWS AppSync resolver.PipelineConfig
is a property of the AWS::AppSync::Resolver resource.- Parameters:
functions (
Optional
[Sequence
[str
]]) – A list ofFunction
objects.- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync pipeline_config_property = appsync.CfnResolver.PipelineConfigProperty( functions=["functions"] )
Attributes
- functions
A list of
Function
objects.
SyncConfigProperty
- class CfnResolver.SyncConfigProperty(*, conflict_detection, conflict_handler=None, lambda_conflict_handler_config=None)
Bases:
object
Describes a Sync configuration for a resolver.
Specifies which Conflict Detection strategy and Resolution strategy to use when the resolver is invoked.
- Parameters:
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 (
Optional
[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 AWS Lambda function supplied in theLambdaConflictHandlerConfig
.lambda_conflict_handler_config (
Union
[IResolvable
,LambdaConflictHandlerConfigProperty
,Dict
[str
,Any
],None
]) – TheLambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_appsync as appsync sync_config_property = appsync.CfnResolver.SyncConfigProperty( conflict_detection="conflictDetection", # the properties below are optional conflict_handler="conflictHandler", lambda_conflict_handler_config=appsync.CfnResolver.LambdaConflictHandlerConfigProperty( lambda_conflict_handler_arn="lambdaConflictHandlerArn" ) )
Attributes
- conflict_detection
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
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 AWS Lambda function supplied in the
LambdaConflictHandlerConfig
.
- lambda_conflict_handler_config
The
LambdaConflictHandlerConfig
when configuringLAMBDA
as the Conflict Handler.