Class: AWSCDK::AppSync::BaseAppsyncFunctionProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_sync/base_appsync_function_props.rb

Overview

the base properties for AppSync Functions.

Direct Known Subclasses

AppsyncFunctionProps

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, code: nil, description: nil, max_batch_size: nil, request_mapping_template: nil, response_mapping_template: nil, runtime: nil) ⇒ BaseAppsyncFunctionProps

Returns a new instance of BaseAppsyncFunctionProps.

Parameters:

  • name (String) —

    the name of the AppSync Function.

  • code (AWSCDK::AppSync::Code, nil) (defaults to: nil) —

    The function code.

  • description (String, nil) (defaults to: nil) —

    the description for this AppSync Function.

  • max_batch_size (Numeric, nil) (defaults to: nil) —

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

  • request_mapping_template (AWSCDK::AppSync::MappingTemplate, nil) (defaults to: nil) —

    the request mapping template for the AppSync Function.

  • response_mapping_template (AWSCDK::AppSync::MappingTemplate, nil) (defaults to: nil) —

    the response mapping template for the AppSync Function.

  • runtime (AWSCDK::AppSync::FunctionRuntime, nil) (defaults to: nil) —

    The functions runtime.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'app_sync/base_appsync_function_props.rb', line 14

def initialize(name:, code: nil, description: nil, max_batch_size: nil, request_mapping_template: nil, response_mapping_template: nil, runtime: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @code = code
  Jsii::Type.check_type(@code, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5Db2RlIn0=")), "code") unless @code.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @max_batch_size = max_batch_size
  Jsii::Type.check_type(@max_batch_size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxBatchSize") unless @max_batch_size.nil?
  @request_mapping_template = request_mapping_template
  Jsii::Type.check_type(@request_mapping_template, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5NYXBwaW5nVGVtcGxhdGUifQ==")), "requestMappingTemplate") unless @request_mapping_template.nil?
  @response_mapping_template = response_mapping_template
  Jsii::Type.check_type(@response_mapping_template, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5NYXBwaW5nVGVtcGxhdGUifQ==")), "responseMappingTemplate") unless @response_mapping_template.nil?
  @runtime = runtime
  Jsii::Type.check_type(@runtime, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3luYy5GdW5jdGlvblJ1bnRpbWUifQ==")), "runtime") unless @runtime.nil?
end

Instance Attribute Details

#code ⇒ AWSCDK::AppSync::Code? (readonly)

Note:

Default: - no code is used

The function code.

Returns:



39
40
41
 
# File 'app_sync/base_appsync_function_props.rb', line 39

def code
  @code
end

#description ⇒ String? (readonly)

Note:

Default: - no description

the description for this AppSync Function.

Returns:

  • (String, nil) 


44
45
46
 
# File 'app_sync/base_appsync_function_props.rb', line 44

def description
  @description
end

#max_batch_size ⇒ Numeric? (readonly)

Note:

Default: - No max batch size

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

Can only be set when using LambdaDataSource.

Returns:

  • (Numeric, nil) 


51
52
53
 
# File 'app_sync/base_appsync_function_props.rb', line 51

def max_batch_size
  @max_batch_size
end

#name ⇒ String (readonly)

the name of the AppSync Function.

Returns:

  • (String) 


34
35
36
 
# File 'app_sync/base_appsync_function_props.rb', line 34

def name
  @name
end

#request_mapping_template ⇒ AWSCDK::AppSync::MappingTemplate? (readonly)

Note:

Default: - no request mapping template

the request mapping template for the AppSync Function.

Returns:



56
57
58
 
# File 'app_sync/base_appsync_function_props.rb', line 56

def request_mapping_template
  @request_mapping_template
end

#response_mapping_template ⇒ AWSCDK::AppSync::MappingTemplate? (readonly)

Note:

Default: - no response mapping template

the response mapping template for the AppSync Function.

Returns:



61
62
63
 
# File 'app_sync/base_appsync_function_props.rb', line 61

def response_mapping_template
  @response_mapping_template
end

#runtime ⇒ AWSCDK::AppSync::FunctionRuntime? (readonly)

Note:

Default: - no function runtime, VTL mapping templates used

The functions runtime.

Returns:



66
67
68
 
# File 'app_sync/base_appsync_function_props.rb', line 66

def runtime
  @runtime
end

Class Method Details

.jsii_properties ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
 
# File 'app_sync/base_appsync_function_props.rb', line 68

def self.jsii_properties
  {
    :name => "name",
    :code => "code",
    :description => "description",
    :max_batch_size => "maxBatchSize",
    :request_mapping_template => "requestMappingTemplate",
    :response_mapping_template => "responseMappingTemplate",
    :runtime => "runtime",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'app_sync/base_appsync_function_props.rb', line 80

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "code" => @code,
    "description" => @description,
    "maxBatchSize" => @max_batch_size,
    "requestMappingTemplate" => @request_mapping_template,
    "responseMappingTemplate" => @response_mapping_template,
    "runtime" => @runtime,
  })
  result.compact
end