Class: AWSCDK::AppSync::CfnResolver

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSAppsync::IResolverRef
Defined in:
app_sync/cfn_resolver.rb

Overview

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, 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 in the AWS CloudFormation User Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnResolver

Create a new AWS::AppSync::Resolver.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::AppSync::CfnResolverProps) —

    Resource properties.



23
24
25
26
27
28
29
 
# File 'app_sync/cfn_resolver.rb', line 23

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppSync::CfnResolverProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5DZm5SZXNvbHZlclByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_resolver(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'app_sync/cfn_resolver.rb', line 94

def self.arn_for_resolver(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBzeW5jLklSZXNvbHZlclJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.CfnResolver", "arnForResolver", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'app_sync/cfn_resolver.rb', line 201

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appsync.CfnResolver", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_resolver(x) ⇒ Boolean

Checks whether the given object is a CfnResolver.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'app_sync/cfn_resolver.rb', line 103

def self.is_cfn_resolver(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.CfnResolver", "isCfnResolver", [x])
end

.jsii_overridable_methods ⇒ Object 



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'app_sync/cfn_resolver.rb', line 31

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_field_name => { kind: :property, name: "attrFieldName", is_optional: false },
    :attr_resolver_arn => { kind: :property, name: "attrResolverArn", is_optional: false },
    :attr_type_name => { kind: :property, name: "attrTypeName", is_optional: false },
    :resolver_ref => { kind: :property, name: "resolverRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :field_name => { kind: :property, name: "fieldName", is_optional: false },
    :type_name => { kind: :property, name: "typeName", is_optional: false },
    :caching_config => { kind: :property, name: "cachingConfig", is_optional: true },
    :code => { kind: :property, name: "code", is_optional: true },
    :code_s3_location => { kind: :property, name: "codeS3Location", is_optional: true },
    :data_source_name => { kind: :property, name: "dataSourceName", is_optional: true },
    :kind => { kind: :property, name: "kind", is_optional: true },
    :max_batch_size => { kind: :property, name: "maxBatchSize", is_optional: true },
    :metrics_config => { kind: :property, name: "metricsConfig", is_optional: true },
    :pipeline_config => { kind: :property, name: "pipelineConfig", is_optional: true },
    :request_mapping_template => { kind: :property, name: "requestMappingTemplate", is_optional: true },
    :request_mapping_template_s3_location => { kind: :property, name: "requestMappingTemplateS3Location", is_optional: true },
    :response_mapping_template => { kind: :property, name: "responseMappingTemplate", is_optional: true },
    :response_mapping_template_s3_location => { kind: :property, name: "responseMappingTemplateS3Location", is_optional: true },
    :runtime => { kind: :property, name: "runtime", is_optional: true },
    :sync_config => { kind: :property, name: "syncConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



477
478
479
480
 
# File 'app_sync/cfn_resolver.rb', line 477

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



489
490
491
492
 
# File 'app_sync/cfn_resolver.rb', line 489

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



499
500
501
502
 
# File 'app_sync/cfn_resolver.rb', line 499

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



510
511
512
513
514
 
# File 'app_sync/cfn_resolver.rb', line 510

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


567
568
569
570
571
 
# File 'app_sync/cfn_resolver.rb', line 567

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



577
578
579
580
 
# File 'app_sync/cfn_resolver.rb', line 577

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



589
590
591
592
593
 
# File 'app_sync/cfn_resolver.rb', line 589

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#api_id ⇒ String

The AWS AppSync GraphQL API to which you want to attach this resolver.

Returns:

  • (String) 


236
237
238
 
# File 'app_sync/cfn_resolver.rb', line 236

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



240
241
242
243
 
# File 'app_sync/cfn_resolver.rb', line 240

def api_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "apiId")
  jsii_set_property("apiId", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



602
603
604
605
 
# File 'app_sync/cfn_resolver.rb', line 602

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



624
625
626
627
628
629
 
# File 'app_sync/cfn_resolver.rb', line 624

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_field_name ⇒ String

The GraphQL field on a type that invokes the resolver.

Returns:

  • (String) 


208
209
210
 
# File 'app_sync/cfn_resolver.rb', line 208

def attr_field_name()
  jsii_get_property("attrFieldName")
end

#attr_resolver_arn ⇒ String

ARN of the resolver, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/types/typename/resolvers/resolvername .

Returns:

  • (String) 


215
216
217
 
# File 'app_sync/cfn_resolver.rb', line 215

def attr_resolver_arn()
  jsii_get_property("attrResolverArn")
end

#attr_type_name ⇒ String

The GraphQL type that invokes this resolver.

Returns:

  • (String) 


222
223
224
 
# File 'app_sync/cfn_resolver.rb', line 222

def attr_type_name()
  jsii_get_property("attrTypeName")
end

#caching_config ⇒ AWSCDK::IResolvable, ...

The caching configuration for the resolver.

Returns:



272
273
274
 
# File 'app_sync/cfn_resolver.rb', line 272

def caching_config()
  jsii_get_property("cachingConfig")
end

#caching_config=(value) ⇒ Object 



276
277
278
279
280
 
# File 'app_sync/cfn_resolver.rb', line 276

def caching_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnResolver::CachingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmblJlc29sdmVyLkNhY2hpbmdDb25maWdQcm9wZXJ0eSJ9XX19")), "cachingConfig") unless value.nil?
  jsii_set_property("cachingConfig", value)
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



154
155
156
 
# File 'app_sync/cfn_resolver.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 'app_sync/cfn_resolver.rb', line 159

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


633
634
635
636
 
# File 'app_sync/cfn_resolver.rb', line 633

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


164
165
166
 
# File 'app_sync/cfn_resolver.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 'app_sync/cfn_resolver.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#code ⇒ String?

The resolver code that contains the request and response functions.

Returns:

  • (String, nil) 


285
286
287
 
# File 'app_sync/cfn_resolver.rb', line 285

def code()
  jsii_get_property("code")
end

#code=(value) ⇒ Object 



289
290
291
292
 
# File 'app_sync/cfn_resolver.rb', line 289

def code=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "code") unless value.nil?
  jsii_set_property("code", value)
end

#code_s3_location ⇒ String?

The Amazon S3 endpoint.

Returns:

  • (String, nil) 


297
298
299
 
# File 'app_sync/cfn_resolver.rb', line 297

def code_s3_location()
  jsii_get_property("codeS3Location")
end

#code_s3_location=(value) ⇒ Object 



301
302
303
304
 
# File 'app_sync/cfn_resolver.rb', line 301

def code_s3_location=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "codeS3Location") unless value.nil?
  jsii_set_property("codeS3Location", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


116
117
118
 
# File 'app_sync/cfn_resolver.rb', line 116

def creation_stack()
  jsii_get_property("creationStack")
end

#data_source_name ⇒ String?

The resolver data source name.

Returns:

  • (String, nil) 


309
310
311
 
# File 'app_sync/cfn_resolver.rb', line 309

def data_source_name()
  jsii_get_property("dataSourceName")
end

#data_source_name=(value) ⇒ Object 



313
314
315
316
 
# File 'app_sync/cfn_resolver.rb', line 313

def data_source_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSourceName") unless value.nil?
  jsii_set_property("dataSourceName", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'app_sync/cfn_resolver.rb', line 176

def env()
  jsii_get_property("env")
end

#field_name ⇒ String

The GraphQL field on a type that invokes the resolver.

Returns:

  • (String) 


248
249
250
 
# File 'app_sync/cfn_resolver.rb', line 248

def field_name()
  jsii_get_property("fieldName")
end

#field_name=(value) ⇒ Object 



252
253
254
255
 
# File 'app_sync/cfn_resolver.rb', line 252

def field_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fieldName")
  jsii_set_property("fieldName", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



646
647
648
649
650
 
# File 'app_sync/cfn_resolver.rb', line 646

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



657
658
659
660
 
# File 'app_sync/cfn_resolver.rb', line 657

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



727
728
729
730
 
# File 'app_sync/cfn_resolver.rb', line 727

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kind ⇒ String?

The resolver type.

Returns:

  • (String, nil) 


321
322
323
 
# File 'app_sync/cfn_resolver.rb', line 321

def kind()
  jsii_get_property("kind")
end

#kind=(value) ⇒ Object 



325
326
327
328
 
# File 'app_sync/cfn_resolver.rb', line 325

def kind=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kind") unless value.nil?
  jsii_set_property("kind", value)
end

#logical_id ⇒ String

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 override_logical_id(new_logical_id).

Returns:

  • (String) 


128
129
130
 
# File 'app_sync/cfn_resolver.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#max_batch_size ⇒ Numeric?

The maximum number of resolver request inputs that will be sent to a single AWS Lambda function in a BatchInvoke operation.

Returns:

  • (Numeric, nil) 


333
334
335
 
# File 'app_sync/cfn_resolver.rb', line 333

def max_batch_size()
  jsii_get_property("maxBatchSize")
end

#max_batch_size=(value) ⇒ Object 



337
338
339
340
 
# File 'app_sync/cfn_resolver.rb', line 337

def max_batch_size=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxBatchSize") unless value.nil?
  jsii_set_property("maxBatchSize", value)
end

#metrics_config ⇒ String?

Enables or disables enhanced resolver metrics for specified resolvers.

Returns:

  • (String, nil) 


345
346
347
 
# File 'app_sync/cfn_resolver.rb', line 345

def metrics_config()
  jsii_get_property("metricsConfig")
end

#metrics_config=(value) ⇒ Object 



349
350
351
352
 
# File 'app_sync/cfn_resolver.rb', line 349

def metrics_config=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricsConfig") unless value.nil?
  jsii_set_property("metricsConfig", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'app_sync/cfn_resolver.rb', line 111

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



668
669
670
 
# File 'app_sync/cfn_resolver.rb', line 668

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



675
676
677
 
# File 'app_sync/cfn_resolver.rb', line 675

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



468
469
470
471
 
# File 'app_sync/cfn_resolver.rb', line 468

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#pipeline_config ⇒ AWSCDK::IResolvable, ...

Functions linked with the pipeline resolver.

Returns:



357
358
359
 
# File 'app_sync/cfn_resolver.rb', line 357

def pipeline_config()
  jsii_get_property("pipelineConfig")
end

#pipeline_config=(value) ⇒ Object 



361
362
363
364
365
 
# File 'app_sync/cfn_resolver.rb', line 361

def pipeline_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnResolver::PipelineConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmblJlc29sdmVyLlBpcGVsaW5lQ29uZmlnUHJvcGVydHkifV19fQ==")), "pipelineConfig") unless value.nil?
  jsii_set_property("pipelineConfig", value)
end

#ref ⇒ String

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 }).

Returns:

  • (String) 


147
148
149
 
# File 'app_sync/cfn_resolver.rb', line 147

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



686
687
688
689
 
# File 'app_sync/cfn_resolver.rb', line 686

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


693
694
695
696
 
# File 'app_sync/cfn_resolver.rb', line 693

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



703
704
705
706
707
 
# File 'app_sync/cfn_resolver.rb', line 703

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#request_mapping_template ⇒ String?

The request mapping template.

Returns:

  • (String, nil) 


370
371
372
 
# File 'app_sync/cfn_resolver.rb', line 370

def request_mapping_template()
  jsii_get_property("requestMappingTemplate")
end

#request_mapping_template=(value) ⇒ Object 



374
375
376
377
 
# File 'app_sync/cfn_resolver.rb', line 374

def request_mapping_template=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requestMappingTemplate") unless value.nil?
  jsii_set_property("requestMappingTemplate", value)
end

#request_mapping_template_s3_location ⇒ String?

The location of a request mapping template in an Amazon S3 bucket.

Returns:

  • (String, nil) 


382
383
384
 
# File 'app_sync/cfn_resolver.rb', line 382

def request_mapping_template_s3_location()
  jsii_get_property("requestMappingTemplateS3Location")
end

#request_mapping_template_s3_location=(value) ⇒ Object 



386
387
388
389
 
# File 'app_sync/cfn_resolver.rb', line 386

def request_mapping_template_s3_location=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "requestMappingTemplateS3Location") unless value.nil?
  jsii_set_property("requestMappingTemplateS3Location", value)
end

#resolver_ref ⇒ AWSCDK::Interfaces::AWSAppsync::ResolverReference

A reference to a Resolver resource.

Returns:



229
230
231
 
# File 'app_sync/cfn_resolver.rb', line 229

def resolver_ref()
  jsii_get_property("resolverRef")
end

#response_mapping_template ⇒ String?

The response mapping template.

Returns:

  • (String, nil) 


394
395
396
 
# File 'app_sync/cfn_resolver.rb', line 394

def response_mapping_template()
  jsii_get_property("responseMappingTemplate")
end

#response_mapping_template=(value) ⇒ Object 



398
399
400
401
 
# File 'app_sync/cfn_resolver.rb', line 398

def response_mapping_template=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "responseMappingTemplate") unless value.nil?
  jsii_set_property("responseMappingTemplate", value)
end

#response_mapping_template_s3_location ⇒ String?

The location of a response mapping template in an Amazon S3 bucket.

Returns:

  • (String, nil) 


406
407
408
 
# File 'app_sync/cfn_resolver.rb', line 406

def response_mapping_template_s3_location()
  jsii_get_property("responseMappingTemplateS3Location")
end

#response_mapping_template_s3_location=(value) ⇒ Object 



410
411
412
413
 
# File 'app_sync/cfn_resolver.rb', line 410

def response_mapping_template_s3_location=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "responseMappingTemplateS3Location") unless value.nil?
  jsii_set_property("responseMappingTemplateS3Location", value)
end

#runtime ⇒ AWSCDK::IResolvable, ...

Describes a runtime used by an AWS AppSync resolver or AWS AppSync function.

Returns:



418
419
420
 
# File 'app_sync/cfn_resolver.rb', line 418

def runtime()
  jsii_get_property("runtime")
end

#runtime=(value) ⇒ Object 



422
423
424
425
426
 
# File 'app_sync/cfn_resolver.rb', line 422

def runtime=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnResolver::AppSyncRuntimeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmblJlc29sdmVyLkFwcFN5bmNSdW50aW1lUHJvcGVydHkifV19fQ==")), "runtime") unless value.nil?
  jsii_set_property("runtime", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



712
713
714
 
# File 'app_sync/cfn_resolver.rb', line 712

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



137
138
139
 
# File 'app_sync/cfn_resolver.rb', line 137

def stack()
  jsii_get_property("stack")
end

#sync_config ⇒ AWSCDK::IResolvable, ...

The SyncConfig for a resolver attached to a versioned data source.

Returns:



431
432
433
 
# File 'app_sync/cfn_resolver.rb', line 431

def sync_config()
  jsii_get_property("syncConfig")
end

#sync_config=(value) ⇒ Object 



435
436
437
438
439
 
# File 'app_sync/cfn_resolver.rb', line 435

def sync_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnResolver::SyncConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmblJlc29sdmVyLlN5bmNDb25maWdQcm9wZXJ0eSJ9XX19")), "syncConfig") unless value.nil?
  jsii_set_property("syncConfig", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



444
445
446
 
# File 'app_sync/cfn_resolver.rb', line 444

def to_string()
  jsii_call_method("toString", [])
end

#type_name ⇒ String

The GraphQL type that invokes this resolver.

Returns:

  • (String) 


260
261
262
 
# File 'app_sync/cfn_resolver.rb', line 260

def type_name()
  jsii_get_property("typeName")
end

#type_name=(value) ⇒ Object 



264
265
266
267
 
# File 'app_sync/cfn_resolver.rb', line 264

def type_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "typeName")
  jsii_set_property("typeName", value)
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


184
185
186
 
# File 'app_sync/cfn_resolver.rb', line 184

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


194
195
196
 
# File 'app_sync/cfn_resolver.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


718
719
720
721
 
# File 'app_sync/cfn_resolver.rb', line 718

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


457
458
459
460
461
462
 
# File 'app_sync/cfn_resolver.rb', line 457

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end