Class: AWSCDK::AppSync::CfnFunctionConfiguration

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

Overview

The AWS::AppSync::FunctionConfiguration resource defines the functions in GraphQL APIs to perform certain operations.

You can use pipeline resolvers to attach functions. For more information, see Pipeline Resolvers in the AWS AppSync Developer Guide .

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) ⇒ CfnFunctionConfiguration

Create a new AWS::AppSync::FunctionConfiguration.

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::CfnFunctionConfigurationProps) —

    Resource properties.



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppSync::CfnFunctionConfigurationProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5DZm5GdW5jdGlvbkNvbmZpZ3VyYXRpb25Qcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'app_sync/cfn_function_configuration.rb', line 192

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

.is_cfn_function_configuration(x) ⇒ Boolean

Checks whether the given object is a CfnFunctionConfiguration.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

def self.is_cfn_function_configuration(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appsync.CfnFunctionConfiguration", "isCfnFunctionConfiguration", [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
 
# File 'app_sync/cfn_function_configuration.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_data_source_name => { kind: :property, name: "attrDataSourceName", is_optional: false },
    :attr_function_arn => { kind: :property, name: "attrFunctionArn", is_optional: false },
    :attr_function_id => { kind: :property, name: "attrFunctionId", is_optional: false },
    :attr_name => { kind: :property, name: "attrName", is_optional: false },
    :function_configuration_ref => { kind: :property, name: "functionConfigurationRef", is_optional: false },
    :api_id => { kind: :property, name: "apiId", is_optional: false },
    :data_source_name => { kind: :property, name: "dataSourceName", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :code => { kind: :property, name: "code", is_optional: true },
    :code_s3_location => { kind: :property, name: "codeS3Location", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :function_version => { kind: :property, name: "functionVersion", is_optional: true },
    :max_batch_size => { kind: :property, name: "maxBatchSize", 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.



437
438
439
440
 
# File 'app_sync/cfn_function_configuration.rb', line 437

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:



449
450
451
452
 
# File 'app_sync/cfn_function_configuration.rb', line 449

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:



459
460
461
462
 
# File 'app_sync/cfn_function_configuration.rb', line 459

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:



470
471
472
473
474
 
# File 'app_sync/cfn_function_configuration.rb', line 470

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.


527
528
529
530
531
 
# File 'app_sync/cfn_function_configuration.rb', line 527

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.



537
538
539
540
 
# File 'app_sync/cfn_function_configuration.rb', line 537

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.



549
550
551
552
553
 
# File 'app_sync/cfn_function_configuration.rb', line 549

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 that you want to attach using this function.

Returns:

  • (String) 


234
235
236
 
# File 'app_sync/cfn_function_configuration.rb', line 234

def api_id()
  jsii_get_property("apiId")
end

#api_id=(value) ⇒ Object 



238
239
240
241
 
# File 'app_sync/cfn_function_configuration.rb', line 238

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:



562
563
564
565
 
# File 'app_sync/cfn_function_configuration.rb', line 562

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:



584
585
586
587
588
589
 
# File 'app_sync/cfn_function_configuration.rb', line 584

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_data_source_name ⇒ String

The name of data source this function will attach.

Returns:

  • (String) 


199
200
201
 
# File 'app_sync/cfn_function_configuration.rb', line 199

def attr_data_source_name()
  jsii_get_property("attrDataSourceName")
end

#attr_function_arn ⇒ String

ARN of the function, such as arn:aws:appsync:us-east-1:123456789012:apis/graphqlapiid/functions/functionId .

Returns:

  • (String) 


206
207
208
 
# File 'app_sync/cfn_function_configuration.rb', line 206

def attr_function_arn()
  jsii_get_property("attrFunctionArn")
end

#attr_function_id ⇒ String

The unique ID of this function.

Returns:

  • (String) 


213
214
215
 
# File 'app_sync/cfn_function_configuration.rb', line 213

def attr_function_id()
  jsii_get_property("attrFunctionId")
end

#attr_name ⇒ String

The name of the function.

Returns:

  • (String) 


220
221
222
 
# File 'app_sync/cfn_function_configuration.rb', line 220

def attr_name()
  jsii_get_property("attrName")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



145
146
147
 
# File 'app_sync/cfn_function_configuration.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'app_sync/cfn_function_configuration.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


593
594
595
596
 
# File 'app_sync/cfn_function_configuration.rb', line 593

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


155
156
157
 
# File 'app_sync/cfn_function_configuration.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'app_sync/cfn_function_configuration.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#code ⇒ String?

The resolver code that contains the request and response functions.

Returns:

  • (String, nil) 


270
271
272
 
# File 'app_sync/cfn_function_configuration.rb', line 270

def code()
  jsii_get_property("code")
end

#code=(value) ⇒ Object 



274
275
276
277
 
# File 'app_sync/cfn_function_configuration.rb', line 274

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) 


282
283
284
 
# File 'app_sync/cfn_function_configuration.rb', line 282

def code_s3_location()
  jsii_get_property("codeS3Location")
end

#code_s3_location=(value) ⇒ Object 



286
287
288
289
 
# File 'app_sync/cfn_function_configuration.rb', line 286

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


107
108
109
 
# File 'app_sync/cfn_function_configuration.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#data_source_name ⇒ String

The name of data source this function will attach.

Returns:

  • (String) 


246
247
248
 
# File 'app_sync/cfn_function_configuration.rb', line 246

def data_source_name()
  jsii_get_property("dataSourceName")
end

#data_source_name=(value) ⇒ Object 



250
251
252
253
 
# File 'app_sync/cfn_function_configuration.rb', line 250

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

#description ⇒ String?

The Function description.

Returns:

  • (String, nil) 


294
295
296
 
# File 'app_sync/cfn_function_configuration.rb', line 294

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



298
299
300
301
 
# File 'app_sync/cfn_function_configuration.rb', line 298

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'app_sync/cfn_function_configuration.rb', line 167

def env()
  jsii_get_property("env")
end

#function_configuration_ref ⇒ AWSCDK::Interfaces::AWSAppsync::FunctionConfigurationReference

A reference to a FunctionConfiguration resource.

Returns:



227
228
229
 
# File 'app_sync/cfn_function_configuration.rb', line 227

def function_configuration_ref()
  jsii_get_property("functionConfigurationRef")
end

#function_version ⇒ String?

The version of the request mapping template.

Returns:

  • (String, nil) 


306
307
308
 
# File 'app_sync/cfn_function_configuration.rb', line 306

def function_version()
  jsii_get_property("functionVersion")
end

#function_version=(value) ⇒ Object 



310
311
312
313
 
# File 'app_sync/cfn_function_configuration.rb', line 310

def function_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "functionVersion") unless value.nil?
  jsii_set_property("functionVersion", 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:



606
607
608
609
610
 
# File 'app_sync/cfn_function_configuration.rb', line 606

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:



617
618
619
620
 
# File 'app_sync/cfn_function_configuration.rb', line 617

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:



687
688
689
690
 
# File 'app_sync/cfn_function_configuration.rb', line 687

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


119
120
121
 
# File 'app_sync/cfn_function_configuration.rb', line 119

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) 


318
319
320
 
# File 'app_sync/cfn_function_configuration.rb', line 318

def max_batch_size()
  jsii_get_property("maxBatchSize")
end

#max_batch_size=(value) ⇒ Object 



322
323
324
325
 
# File 'app_sync/cfn_function_configuration.rb', line 322

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

#name ⇒ String

The name of the function.

Returns:

  • (String) 


258
259
260
 
# File 'app_sync/cfn_function_configuration.rb', line 258

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



262
263
264
265
 
# File 'app_sync/cfn_function_configuration.rb', line 262

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'app_sync/cfn_function_configuration.rb', line 102

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:



628
629
630
 
# File 'app_sync/cfn_function_configuration.rb', line 628

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:



635
636
637
 
# File 'app_sync/cfn_function_configuration.rb', line 635

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.



428
429
430
431
 
# File 'app_sync/cfn_function_configuration.rb', line 428

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

#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) 


138
139
140
 
# File 'app_sync/cfn_function_configuration.rb', line 138

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:



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

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


653
654
655
656
 
# File 'app_sync/cfn_function_configuration.rb', line 653

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:



663
664
665
666
667
 
# File 'app_sync/cfn_function_configuration.rb', line 663

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 Function request mapping template.

Returns:

  • (String, nil) 


330
331
332
 
# File 'app_sync/cfn_function_configuration.rb', line 330

def request_mapping_template()
  jsii_get_property("requestMappingTemplate")
end

#request_mapping_template=(value) ⇒ Object 



334
335
336
337
 
# File 'app_sync/cfn_function_configuration.rb', line 334

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?

Describes a Sync configuration for a resolver.

Returns:

  • (String, nil) 


342
343
344
 
# File 'app_sync/cfn_function_configuration.rb', line 342

def request_mapping_template_s3_location()
  jsii_get_property("requestMappingTemplateS3Location")
end

#request_mapping_template_s3_location=(value) ⇒ Object 



346
347
348
349
 
# File 'app_sync/cfn_function_configuration.rb', line 346

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

#response_mapping_template ⇒ String?

The Function response mapping template.

Returns:

  • (String, nil) 


354
355
356
 
# File 'app_sync/cfn_function_configuration.rb', line 354

def response_mapping_template()
  jsii_get_property("responseMappingTemplate")
end

#response_mapping_template=(value) ⇒ Object 



358
359
360
361
 
# File 'app_sync/cfn_function_configuration.rb', line 358

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) 


366
367
368
 
# File 'app_sync/cfn_function_configuration.rb', line 366

def response_mapping_template_s3_location()
  jsii_get_property("responseMappingTemplateS3Location")
end

#response_mapping_template_s3_location=(value) ⇒ Object 



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

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:



378
379
380
 
# File 'app_sync/cfn_function_configuration.rb', line 378

def runtime()
  jsii_get_property("runtime")
end

#runtime=(value) ⇒ Object 



382
383
384
385
386
 
# File 'app_sync/cfn_function_configuration.rb', line 382

def runtime=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnFunctionConfiguration::AppSyncRuntimeProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkZ1bmN0aW9uQ29uZmlndXJhdGlvbi5BcHBTeW5jUnVudGltZVByb3BlcnR5In1dfX0=")), "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.



672
673
674
 
# File 'app_sync/cfn_function_configuration.rb', line 672

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:



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

def stack()
  jsii_get_property("stack")
end

#sync_config ⇒ AWSCDK::IResolvable, ...

Describes a Sync configuration for a resolver.

Returns:



391
392
393
 
# File 'app_sync/cfn_function_configuration.rb', line 391

def sync_config()
  jsii_get_property("syncConfig")
end

#sync_config=(value) ⇒ Object 



395
396
397
398
399
 
# File 'app_sync/cfn_function_configuration.rb', line 395

def sync_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppSync::CfnFunctionConfiguration::SyncConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzeW5jLkNmbkZ1bmN0aW9uQ29uZmlndXJhdGlvbi5TeW5jQ29uZmlnUHJvcGVydHkifV19fQ==")), "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



404
405
406
 
# File 'app_sync/cfn_function_configuration.rb', line 404

def to_string()
  jsii_call_method("toString", [])
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}) 


175
176
177
 
# File 'app_sync/cfn_function_configuration.rb', line 175

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


185
186
187
 
# File 'app_sync/cfn_function_configuration.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


678
679
680
681
 
# File 'app_sync/cfn_function_configuration.rb', line 678

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) 


417
418
419
420
421
422
 
# File 'app_sync/cfn_function_configuration.rb', line 417

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