Class: AWSCDK::SAM::CfnFunction

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSSAM::IFunctionRef
Defined in:
sam/cfn_function.rb

Overview

https://github.com/awslabs/serverless-application-model/blob/master/versions/2016-10-31.md#awsserverlessfunction.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnFunction

Create a new AWS::Serverless::Function.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

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

  • props (AWSCDK::SAM::CfnFunctionProps, nil) (defaults to: nil) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'sam/cfn_function.rb', line 18

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunctionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FtLkNmbkZ1bmN0aW9uUHJvcHMifQ==")), "props") unless props.nil?
  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) 


205
206
207
 
# File 'sam/cfn_function.rb', line 205

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

.is_cfn_function(x) ⇒ Boolean

Checks whether the given object is a CfnFunction.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


107
108
109
110
 
# File 'sam/cfn_function.rb', line 107

def self.is_cfn_function(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_sam.CfnFunction", "isCfnFunction", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
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
91
92
93
94
95
96
97
98
99
100
101
 
# File 'sam/cfn_function.rb', line 26

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 },
    :function_ref => { kind: :property, name: "functionRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :assume_role_policy_document => { kind: :property, name: "assumeRolePolicyDocument", is_optional: false },
    :architectures => { kind: :property, name: "architectures", is_optional: true },
    :auto_publish_alias => { kind: :property, name: "autoPublishAlias", is_optional: true },
    :auto_publish_code_sha256 => { kind: :property, name: "autoPublishCodeSha256", is_optional: true },
    :code_signing_config_arn => { kind: :property, name: "codeSigningConfigArn", is_optional: true },
    :code_uri => { kind: :property, name: "codeUri", is_optional: true },
    :dead_letter_queue => { kind: :property, name: "deadLetterQueue", is_optional: true },
    :deployment_preference => { kind: :property, name: "deploymentPreference", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :environment => { kind: :property, name: "environment", is_optional: true },
    :ephemeral_storage => { kind: :property, name: "ephemeralStorage", is_optional: true },
    :event_invoke_config => { kind: :property, name: "eventInvokeConfig", is_optional: true },
    :events => { kind: :property, name: "events", is_optional: true },
    :file_system_configs => { kind: :property, name: "fileSystemConfigs", is_optional: true },
    :function_name => { kind: :property, name: "functionName", is_optional: true },
    :function_url_config => { kind: :property, name: "functionUrlConfig", is_optional: true },
    :handler => { kind: :property, name: "handler", is_optional: true },
    :image_config => { kind: :property, name: "imageConfig", is_optional: true },
    :image_uri => { kind: :property, name: "imageUri", is_optional: true },
    :inline_code => { kind: :property, name: "inlineCode", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :layers => { kind: :property, name: "layers", is_optional: true },
    :memory_size => { kind: :property, name: "memorySize", is_optional: true },
    :package_type => { kind: :property, name: "packageType", is_optional: true },
    :permissions_boundary => { kind: :property, name: "permissionsBoundary", is_optional: true },
    :policies => { kind: :property, name: "policies", is_optional: true },
    :provisioned_concurrency_config => { kind: :property, name: "provisionedConcurrencyConfig", is_optional: true },
    :reserved_concurrent_executions => { kind: :property, name: "reservedConcurrentExecutions", is_optional: true },
    :role => { kind: :property, name: "role", is_optional: true },
    :runtime => { kind: :property, name: "runtime", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :timeout => { kind: :property, name: "timeout", is_optional: true },
    :tracing => { kind: :property, name: "tracing", is_optional: true },
    :version_description => { kind: :property, name: "versionDescription", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", 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

.REQUIRED_TRANSFORM ⇒ String

The Transform a template must use in order to use this resource.

Returns:

  • (String) 


212
213
214
 
# File 'sam/cfn_function.rb', line 212

def self.REQUIRED_TRANSFORM()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_sam.CfnFunction", "REQUIRED_TRANSFORM")
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.



627
628
629
630
 
# File 'sam/cfn_function.rb', line 627

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:



639
640
641
642
 
# File 'sam/cfn_function.rb', line 639

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:



649
650
651
652
 
# File 'sam/cfn_function.rb', line 649

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:



660
661
662
663
664
 
# File 'sam/cfn_function.rb', line 660

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.


717
718
719
720
721
 
# File 'sam/cfn_function.rb', line 717

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.



727
728
729
730
 
# File 'sam/cfn_function.rb', line 727

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.



739
740
741
742
743
 
# File 'sam/cfn_function.rb', line 739

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

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



752
753
754
755
 
# File 'sam/cfn_function.rb', line 752

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:



774
775
776
777
778
779
 
# File 'sam/cfn_function.rb', line 774

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

#architectures ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


241
242
243
 
# File 'sam/cfn_function.rb', line 241

def architectures()
  jsii_get_property("architectures")
end

#architectures=(value) ⇒ Object 



245
246
247
248
 
# File 'sam/cfn_function.rb', line 245

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

#assume_role_policy_document ⇒ Object

Returns:

  • (Object) 


231
232
233
 
# File 'sam/cfn_function.rb', line 231

def assume_role_policy_document()
  jsii_get_property("assumeRolePolicyDocument")
end

#assume_role_policy_document=(value) ⇒ Object 



235
236
237
238
 
# File 'sam/cfn_function.rb', line 235

def assume_role_policy_document=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "assumeRolePolicyDocument")
  jsii_set_property("assumeRolePolicyDocument", value)
end

#auto_publish_alias ⇒ String?

Returns:

  • (String, nil) 


251
252
253
 
# File 'sam/cfn_function.rb', line 251

def auto_publish_alias()
  jsii_get_property("autoPublishAlias")
end

#auto_publish_alias=(value) ⇒ Object 



255
256
257
258
 
# File 'sam/cfn_function.rb', line 255

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

#auto_publish_code_sha256 ⇒ String?

Returns:

  • (String, nil) 


261
262
263
 
# File 'sam/cfn_function.rb', line 261

def auto_publish_code_sha256()
  jsii_get_property("autoPublishCodeSha256")
end

#auto_publish_code_sha256=(value) ⇒ Object 



265
266
267
268
 
# File 'sam/cfn_function.rb', line 265

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

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'sam/cfn_function.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'sam/cfn_function.rb', line 163

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


783
784
785
786
 
# File 'sam/cfn_function.rb', line 783

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


168
169
170
 
# File 'sam/cfn_function.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'sam/cfn_function.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#code_signing_config_arn ⇒ String?

Returns:

  • (String, nil) 


271
272
273
 
# File 'sam/cfn_function.rb', line 271

def code_signing_config_arn()
  jsii_get_property("codeSigningConfigArn")
end

#code_signing_config_arn=(value) ⇒ Object 



275
276
277
278
 
# File 'sam/cfn_function.rb', line 275

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

#code_uri ⇒ String, ...

Returns:



281
282
283
 
# File 'sam/cfn_function.rb', line 281

def code_uri()
  jsii_get_property("codeUri")
end

#code_uri=(value) ⇒ Object 



285
286
287
288
289
 
# File 'sam/cfn_function.rb', line 285

def code_uri=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5GdW5jdGlvbi5TM0xvY2F0aW9uUHJvcGVydHkifV19fQ==")), "codeUri") unless value.nil?
  jsii_set_property("codeUri", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


120
121
122
 
# File 'sam/cfn_function.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#dead_letter_queue ⇒ AWSCDK::IResolvable, ...

Returns:



292
293
294
 
# File 'sam/cfn_function.rb', line 292

def dead_letter_queue()
  jsii_get_property("deadLetterQueue")
end

#dead_letter_queue=(value) ⇒ Object 



296
297
298
299
300
 
# File 'sam/cfn_function.rb', line 296

def dead_letter_queue=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::DeadLetterQueueProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRGVhZExldHRlclF1ZXVlUHJvcGVydHkifV19fQ==")), "deadLetterQueue") unless value.nil?
  jsii_set_property("deadLetterQueue", value)
end

#deployment_preference ⇒ AWSCDK::IResolvable, ...

Returns:



303
304
305
 
# File 'sam/cfn_function.rb', line 303

def deployment_preference()
  jsii_get_property("deploymentPreference")
end

#deployment_preference=(value) ⇒ Object 



307
308
309
310
311
 
# File 'sam/cfn_function.rb', line 307

def deployment_preference=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::DeploymentPreferenceProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRGVwbG95bWVudFByZWZlcmVuY2VQcm9wZXJ0eSJ9XX19")), "deploymentPreference") unless value.nil?
  jsii_set_property("deploymentPreference", value)
end

#description ⇒ String?

Returns:

  • (String, nil) 


314
315
316
 
# File 'sam/cfn_function.rb', line 314

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



318
319
320
321
 
# File 'sam/cfn_function.rb', line 318

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:



180
181
182
 
# File 'sam/cfn_function.rb', line 180

def env()
  jsii_get_property("env")
end

#environment ⇒ AWSCDK::IResolvable, ...

Returns:



324
325
326
 
# File 'sam/cfn_function.rb', line 324

def environment()
  jsii_get_property("environment")
end

#environment=(value) ⇒ Object 



328
329
330
331
332
 
# File 'sam/cfn_function.rb', line 328

def environment=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::FunctionEnvironmentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRnVuY3Rpb25FbnZpcm9ubWVudFByb3BlcnR5In1dfX0=")), "environment") unless value.nil?
  jsii_set_property("environment", value)
end

#ephemeral_storage ⇒ AWSCDK::IResolvable, ...

Returns:



335
336
337
 
# File 'sam/cfn_function.rb', line 335

def ephemeral_storage()
  jsii_get_property("ephemeralStorage")
end

#ephemeral_storage=(value) ⇒ Object 



339
340
341
342
343
 
# File 'sam/cfn_function.rb', line 339

def ephemeral_storage=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::EphemeralStorageProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRXBoZW1lcmFsU3RvcmFnZVByb3BlcnR5In1dfX0=")), "ephemeralStorage") unless value.nil?
  jsii_set_property("ephemeralStorage", value)
end

#event_invoke_config ⇒ AWSCDK::IResolvable, ...

Returns:



346
347
348
 
# File 'sam/cfn_function.rb', line 346

def event_invoke_config()
  jsii_get_property("eventInvokeConfig")
end

#event_invoke_config=(value) ⇒ Object 



350
351
352
353
354
 
# File 'sam/cfn_function.rb', line 350

def event_invoke_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::EventInvokeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRXZlbnRJbnZva2VDb25maWdQcm9wZXJ0eSJ9XX19")), "eventInvokeConfig") unless value.nil?
  jsii_set_property("eventInvokeConfig", value)
end

#events ⇒ AWSCDK::IResolvable, ...

Returns:



357
358
359
 
# File 'sam/cfn_function.rb', line 357

def events()
  jsii_get_property("events")
end

#events=(value) ⇒ Object 



361
362
363
364
 
# File 'sam/cfn_function.rb', line 361

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

#file_system_configs ⇒ AWSCDK::IResolvable, ...

Returns:



367
368
369
 
# File 'sam/cfn_function.rb', line 367

def file_system_configs()
  jsii_get_property("fileSystemConfigs")
end

#file_system_configs=(value) ⇒ Object 



371
372
373
374
 
# File 'sam/cfn_function.rb', line 371

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

#function_name ⇒ String?

Returns:

  • (String, nil) 


377
378
379
 
# File 'sam/cfn_function.rb', line 377

def function_name()
  jsii_get_property("functionName")
end

#function_name=(value) ⇒ Object 



381
382
383
384
 
# File 'sam/cfn_function.rb', line 381

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

#function_ref ⇒ AWSCDK::Interfaces::AWSSAM::FunctionReference

A reference to a Function resource.

Returns:



219
220
221
 
# File 'sam/cfn_function.rb', line 219

def function_ref()
  jsii_get_property("functionRef")
end

#function_url_config ⇒ AWSCDK::IResolvable, ...

Returns:



387
388
389
 
# File 'sam/cfn_function.rb', line 387

def function_url_config()
  jsii_get_property("functionUrlConfig")
end

#function_url_config=(value) ⇒ Object 



391
392
393
394
395
 
# File 'sam/cfn_function.rb', line 391

def function_url_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::FunctionURLConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uRnVuY3Rpb25VcmxDb25maWdQcm9wZXJ0eSJ9XX19")), "functionUrlConfig") unless value.nil?
  jsii_set_property("functionUrlConfig", 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:



796
797
798
799
800
 
# File 'sam/cfn_function.rb', line 796

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:



807
808
809
810
 
# File 'sam/cfn_function.rb', line 807

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

#handler ⇒ String?

Returns:

  • (String, nil) 


398
399
400
 
# File 'sam/cfn_function.rb', line 398

def handler()
  jsii_get_property("handler")
end

#handler=(value) ⇒ Object 



402
403
404
405
 
# File 'sam/cfn_function.rb', line 402

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

#image_config ⇒ AWSCDK::IResolvable, ...

Returns:



408
409
410
 
# File 'sam/cfn_function.rb', line 408

def image_config()
  jsii_get_property("imageConfig")
end

#image_config=(value) ⇒ Object 



412
413
414
415
416
 
# File 'sam/cfn_function.rb', line 412

def image_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::ImageConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uSW1hZ2VDb25maWdQcm9wZXJ0eSJ9XX19")), "imageConfig") unless value.nil?
  jsii_set_property("imageConfig", value)
end

#image_uri ⇒ String?

Returns:

  • (String, nil) 


419
420
421
 
# File 'sam/cfn_function.rb', line 419

def image_uri()
  jsii_get_property("imageUri")
end

#image_uri=(value) ⇒ Object 



423
424
425
426
 
# File 'sam/cfn_function.rb', line 423

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

#inline_code ⇒ String?

Returns:

  • (String, nil) 


429
430
431
 
# File 'sam/cfn_function.rb', line 429

def inline_code()
  jsii_get_property("inlineCode")
end

#inline_code=(value) ⇒ Object 



433
434
435
436
 
# File 'sam/cfn_function.rb', line 433

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



877
878
879
880
 
# File 'sam/cfn_function.rb', line 877

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

#kms_key_arn ⇒ String?

Returns:

  • (String, nil) 


439
440
441
 
# File 'sam/cfn_function.rb', line 439

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



443
444
445
446
 
# File 'sam/cfn_function.rb', line 443

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

#layers ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


449
450
451
 
# File 'sam/cfn_function.rb', line 449

def layers()
  jsii_get_property("layers")
end

#layers=(value) ⇒ Object 



453
454
455
456
 
# File 'sam/cfn_function.rb', line 453

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


132
133
134
 
# File 'sam/cfn_function.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#memory_size ⇒ Numeric?

Returns:

  • (Numeric, nil) 


459
460
461
 
# File 'sam/cfn_function.rb', line 459

def memory_size()
  jsii_get_property("memorySize")
end

#memory_size=(value) ⇒ Object 



463
464
465
466
 
# File 'sam/cfn_function.rb', line 463

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


115
116
117
 
# File 'sam/cfn_function.rb', line 115

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:



818
819
820
 
# File 'sam/cfn_function.rb', line 818

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:



825
826
827
 
# File 'sam/cfn_function.rb', line 825

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.



618
619
620
621
 
# File 'sam/cfn_function.rb', line 618

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

#package_type ⇒ String?

Returns:

  • (String, nil) 


469
470
471
 
# File 'sam/cfn_function.rb', line 469

def package_type()
  jsii_get_property("packageType")
end

#package_type=(value) ⇒ Object 



473
474
475
476
 
# File 'sam/cfn_function.rb', line 473

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

#permissions_boundary ⇒ String?

Returns:

  • (String, nil) 


479
480
481
 
# File 'sam/cfn_function.rb', line 479

def permissions_boundary()
  jsii_get_property("permissionsBoundary")
end

#permissions_boundary=(value) ⇒ Object 



483
484
485
486
 
# File 'sam/cfn_function.rb', line 483

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

#policies ⇒ String, ...

Returns:



489
490
491
 
# File 'sam/cfn_function.rb', line 489

def policies()
  jsii_get_property("policies")
end

#policies=(value) ⇒ Object 



493
494
495
496
497
 
# File 'sam/cfn_function.rb', line 493

def policies=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::IAMPolicyDocumentProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5JUmVzb2x2YWJsZSJ9LHsiZnFuIjoiYXdzLWNkay1saWIuYXdzX3NhbS5DZm5GdW5jdGlvbi5JQU1Qb2xpY3lEb2N1bWVudFByb3BlcnR5In0seyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InVuaW9uIjp7InR5cGVzIjpbeyJwcmltaXRpdmUiOiJzdHJpbmcifSx7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2FtLkNmbkZ1bmN0aW9uLklBTVBvbGljeURvY3VtZW50UHJvcGVydHkifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uU0FNUG9saWN5VGVtcGxhdGVQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "policies") unless value.nil?
  jsii_set_property("policies", value)
end

#provisioned_concurrency_config ⇒ AWSCDK::IResolvable, ...

Returns:



500
501
502
 
# File 'sam/cfn_function.rb', line 500

def provisioned_concurrency_config()
  jsii_get_property("provisionedConcurrencyConfig")
end

#provisioned_concurrency_config=(value) ⇒ Object 



504
505
506
507
508
 
# File 'sam/cfn_function.rb', line 504

def provisioned_concurrency_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::ProvisionedConcurrencyConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uUHJvdmlzaW9uZWRDb25jdXJyZW5jeUNvbmZpZ1Byb3BlcnR5In1dfX0=")), "provisionedConcurrencyConfig") unless value.nil?
  jsii_set_property("provisionedConcurrencyConfig", 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) 


151
152
153
 
# File 'sam/cfn_function.rb', line 151

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:



836
837
838
839
 
# File 'sam/cfn_function.rb', line 836

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


843
844
845
846
 
# File 'sam/cfn_function.rb', line 843

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:



853
854
855
856
857
 
# File 'sam/cfn_function.rb', line 853

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

#reserved_concurrent_executions ⇒ Numeric?

Returns:

  • (Numeric, nil) 


511
512
513
 
# File 'sam/cfn_function.rb', line 511

def reserved_concurrent_executions()
  jsii_get_property("reservedConcurrentExecutions")
end

#reserved_concurrent_executions=(value) ⇒ Object 



515
516
517
518
 
# File 'sam/cfn_function.rb', line 515

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

#role ⇒ String?

Returns:

  • (String, nil) 


521
522
523
 
# File 'sam/cfn_function.rb', line 521

def role()
  jsii_get_property("role")
end

#role=(value) ⇒ Object 



525
526
527
528
 
# File 'sam/cfn_function.rb', line 525

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

#runtime ⇒ String?

Returns:

  • (String, nil) 


531
532
533
 
# File 'sam/cfn_function.rb', line 531

def runtime()
  jsii_get_property("runtime")
end

#runtime=(value) ⇒ Object 



535
536
537
538
 
# File 'sam/cfn_function.rb', line 535

def runtime=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "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.



862
863
864
 
# File 'sam/cfn_function.rb', line 862

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:



141
142
143
 
# File 'sam/cfn_function.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



226
227
228
 
# File 'sam/cfn_function.rb', line 226

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Hash{String => String}?

Returns:

  • (Hash{String => String}, nil) 


541
542
543
 
# File 'sam/cfn_function.rb', line 541

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



545
546
547
548
 
# File 'sam/cfn_function.rb', line 545

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

#timeout ⇒ Numeric?

Returns:

  • (Numeric, nil) 


551
552
553
 
# File 'sam/cfn_function.rb', line 551

def timeout()
  jsii_get_property("timeout")
end

#timeout=(value) ⇒ Object 



555
556
557
558
 
# File 'sam/cfn_function.rb', line 555

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

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



594
595
596
 
# File 'sam/cfn_function.rb', line 594

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

#tracing ⇒ String?

Returns:

  • (String, nil) 


561
562
563
 
# File 'sam/cfn_function.rb', line 561

def tracing()
  jsii_get_property("tracing")
end

#tracing=(value) ⇒ Object 



565
566
567
568
 
# File 'sam/cfn_function.rb', line 565

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


188
189
190
 
# File 'sam/cfn_function.rb', line 188

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


198
199
200
 
# File 'sam/cfn_function.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


868
869
870
871
 
# File 'sam/cfn_function.rb', line 868

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

#version_description ⇒ String?

Returns:

  • (String, nil) 


571
572
573
 
# File 'sam/cfn_function.rb', line 571

def version_description()
  jsii_get_property("versionDescription")
end

#version_description=(value) ⇒ Object 



575
576
577
578
 
# File 'sam/cfn_function.rb', line 575

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

#vpc_config ⇒ AWSCDK::IResolvable, ...

Returns:



581
582
583
 
# File 'sam/cfn_function.rb', line 581

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



585
586
587
588
589
 
# File 'sam/cfn_function.rb', line 585

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::SAM::CfnFunction::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19zYW0uQ2ZuRnVuY3Rpb24uVnBjQ29uZmlnUHJvcGVydHkifV19fQ==")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", value)
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) 


607
608
609
610
611
612
 
# File 'sam/cfn_function.rb', line 607

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