Class: MintPress::Aws::Lambda::Function

Inherits:
Object
  • Object
show all
Includes:
MintLogger, AwsCommon, Mixins::Properties
Defined in:
src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb

Properties (Read/Write)

  • #function_name ⇒ [String] (Default Value: Proc.new { self.name })
    'The name of the Lambda function, version, or alias. Name formats Function name - my-function (name-only), my-function:v1 (with alias). Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function. Partial ARN - 123456789012:function:my-function. You can append a version number or alias to any of the formats. The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.'
    Property Attributes
    • create_function_prop ⇒ 'function_name'
    • read_only ⇒ false
    • source ⇒ "get_function"
    • delete_function_prop ⇒ 'function_name'
    • get_function_prop ⇒ 'function_name'
    • default ⇒ Proc.new { self.name }
    

28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 28

property :function_name, create_function_prop: 'function_name', type: [String], read_only: false, source: "get_function", description: 'The name of the Lambda function, version, or alias.

Name formats


Function name - my-function (name-only), my-function:v1
(with alias).
Function ARN -
arn:aws:lambda:us-west-2:123456789012:function:my-function.
Partial ARN - 123456789012:function:my-function.



You can append a version number or alias to any of the formats. The
length constraint applies only to the full ARN. If you specify only
the function name, it is limited to 64 characters in length.', delete_function_prop: 'function_name', get_function_prop: 'function_name', default: Proc.new { self.name }
  • #runtime ⇒ [String]
    'The identifier of the function"s runtime.'
    Property Attributes
    • create_function_prop ⇒ 'runtime'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

44
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 44

property :runtime, create_function_prop: 'runtime', type: [String], read_only: false, source: "create_function", description: 'The identifier of the function"s runtime.'
  • #role ⇒ [String]
    'The Amazon Resource Name (ARN) of the function"s execution role.'
    Property Attributes
    • create_function_prop ⇒ 'role'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

45
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 45

property :role, create_function_prop: 'role', type: [String], read_only: false, source: "create_function", description: 'The Amazon Resource Name (ARN) of the function"s execution role.'
  • #handler ⇒ [String]
    'The name of the method within your code that Lambda calls to execute your function. The format includes the file name. It can also include namespaces and other qualifiers, depending on the runtime. For more information, see Programming Model.'
    Property Attributes
    • create_function_prop ⇒ 'handler'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

46
47
48
49
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 46

property :handler, create_function_prop: 'handler', type: [String], read_only: false, source: "create_function", description: 'The name of the method within your code that Lambda calls to execute
your function. The format includes the file name. It can also include
namespaces and other qualifiers, depending on the runtime. For more
information, see Programming Model.'
  • #code ⇒ [MintPress::Aws::Lambda::FunctionCode] (Default Value: MintPress::Aws::Lambda::FunctionCode.new)
    'The code for the function.'
    Property Attributes
    • create_function_prop ⇒ 'code'
    • default ⇒ MintPress::Aws::Lambda::FunctionCode.new
    • read_only ⇒ false
    • source ⇒ "create_function"
    

50
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 50

property :code, create_function_prop: 'code', type: [MintPress::Aws::Lambda::FunctionCode], default: MintPress::Aws::Lambda::FunctionCode.new, read_only: false, source: "create_function", description: 'The code for the function.'
  • #description ⇒ [String]
    'A description of the function.'
    Property Attributes
    • create_function_prop ⇒ 'description'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

51
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 51

property :description, create_function_prop: 'description', type: [String], read_only: false, source: "create_function", description: 'A description of the function.'
  • #timeout ⇒ [Integer]
    'The amount of time that Lambda allows a function to run before stopping it. The default is 3 seconds. The maximum allowed value is 900 seconds.'
    Property Attributes
    • create_function_prop ⇒ 'timeout'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

52
53
54
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 52

property :timeout, create_function_prop: 'timeout', type: [Integer], read_only: false, source: "create_function", description: 'The amount of time that Lambda allows a function to run before
stopping it. The default is 3 seconds. The maximum allowed value is
900 seconds.'
  • #memory_size ⇒ [Integer]
    'The amount of memory available to the function at runtime. Increasing the function"s memory also increases its CPU allocation. The default value is 128 MB. The value can be any multiple of 1 MB.'
    Property Attributes
    • create_function_prop ⇒ 'memory_size'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

55
56
57
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 55

property :memory_size, create_function_prop: 'memory_size', type: [Integer], read_only: false, source: "create_function", description: 'The amount of memory available to the function at runtime. Increasing
the function"s memory also increases its CPU allocation. The default
value is 128 MB. The value can be any multiple of 1 MB.'
  • #publish ⇒ [TrueClass,FalseClass]
    'Set to true to publish the first version of the function during creation.'
    Property Attributes
    • create_function_prop ⇒ 'publish'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

58
59
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 58

property :publish, create_function_prop: 'publish', type: [TrueClass,FalseClass], read_only: false, source: "create_function", description: 'Set to true to publish the first version of the function during
creation.'
  • #vpc_config ⇒ [MintPress::Aws::Lambda::VpcConfig] (Default Value: MintPress::Aws::Lambda::VpcConfig.new)
    'For network connectivity to AWS resources in a VPC, specify a list of security groups and subnets in the VPC. When you connect a function to a VPC, it can only access resources and the internet through that VPC. For more information, see VPC Settings.'
    Property Attributes
    • create_function_prop ⇒ 'vpc_config'
    • default ⇒ MintPress::Aws::Lambda::VpcConfig.new
    • read_only ⇒ false
    • source ⇒ "create_function"
    

60
61
62
63
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 60

property :vpc_config, create_function_prop: 'vpc_config', type: [MintPress::Aws::Lambda::VpcConfig], default: MintPress::Aws::Lambda::VpcConfig.new, read_only: false, source: "create_function", description: 'For network connectivity to AWS resources in a VPC, specify a list of
security groups and subnets in the VPC. When you connect a function to
a VPC, it can only access resources and the internet through that VPC.
For more information, see VPC Settings.'
  • #package_type ⇒ [String]
    'The type of deployment package. Set to Image for container image and set Zip for ZIP archive.'
    Property Attributes
    • create_function_prop ⇒ 'package_type'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

64
65
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 64

property :package_type, create_function_prop: 'package_type', type: [String], read_only: false, source: "create_function", description: 'The type of deployment package. Set to Image for container image and
set Zip for ZIP archive.'
  • #dead_letter_config ⇒ [String]
    'A dead letter queue configuration that specifies the queue or topic where Lambda sends asynchronous events when they fail processing. For more information, see Dead Letter Queues.'
    Property Attributes
    • create_function_prop ⇒ "dead_letter_config.target_arn"
    • read_only ⇒ false
    • source ⇒ "create_function"
    

66
67
68
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 66

property :dead_letter_config, create_function_prop: "dead_letter_config.target_arn", type: [String], read_only: false, source: "create_function", description: 'A dead letter queue configuration that specifies the queue or topic
where Lambda sends asynchronous events when they fail processing. For
more information, see Dead Letter Queues.'
  • #environment ⇒ [MintPress::Aws::Lambda::Environment] (Default Value: MintPress::Aws::Lambda::Environment.new)
    'Environment variables that are accessible from function code during execution.'
    Property Attributes
    • create_function_prop ⇒ 'environment'
    • default ⇒ MintPress::Aws::Lambda::Environment.new
    • read_only ⇒ false
    • source ⇒ "create_function"
    

69
70
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 69

property :environment, create_function_prop: 'environment', type: [MintPress::Aws::Lambda::Environment], default: MintPress::Aws::Lambda::Environment.new, read_only: false, source: "create_function", description: 'Environment variables that are accessible from function code during
execution.'
  • #kms_key_arn ⇒ [String]
    'The ARN of the AWS Key Management Service (AWS KMS) key that"s used to encrypt your function"s environment variables. If it"s not provided, AWS Lambda uses a default service key.'
    Property Attributes
    • create_function_prop ⇒ 'kms_key_arn'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

71
72
73
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 71

property :kms_key_arn, create_function_prop: 'kms_key_arn', type: [String], read_only: false, source: "create_function", description: 'The ARN of the AWS Key Management Service (AWS KMS) key that"s used
to encrypt your function"s environment variables. If it"s not
provided, AWS Lambda uses a default service key.'
  • #tracing_config ⇒ [String]
    'Set Mode to Active to sample and trace a subset of incoming requests with AWS X-Ray.'
    Property Attributes
    • create_function_prop ⇒ "tracing_config.mode"
    • read_only ⇒ false
    • source ⇒ "create_function"
    

74
75
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 74

property :tracing_config, create_function_prop: "tracing_config.mode", type: [String], read_only: false, source: "create_function", description: 'Set Mode to Active to sample and trace a subset of incoming
requests with AWS X-Ray.'
  • #tags ⇒ []
    'A list of tags to apply to the function.'
    Property Attributes
    • create_function_prop ⇒ 'tags'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

76
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 76

property :tags, create_function_prop: 'tags', type: [], read_only: false, source: "create_function", description: 'A list of tags to apply to the function.'
  • #layers ⇒ Array of ⇒ [String]
    'A list of function layers to add to the function"s execution environment. Specify each layer by its ARN, including the version.'
    Property Attributes
    • create_function_prop ⇒ 'layers'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

77
78
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 77

property :layers, create_function_prop: 'layers', type: [String], array: true, read_only: false, source: "create_function", description: 'A list of function layers to add to the function"s execution
environment. Specify each layer by its ARN, including the version.'
  • #file_system_configs ⇒ Array of ⇒ [MintPress::Aws::Lambda::FileSystemConfig]
    'Connection settings for an Amazon EFS file system.'
    Property Attributes
    • create_function_prop ⇒ 'file_system_configs'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

79
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 79

property :file_system_configs, create_function_prop: 'file_system_configs', type: [MintPress::Aws::Lambda::FileSystemConfig], array: true, read_only: false, source: "create_function", description: 'Connection settings for an Amazon EFS file system.'
  • #image_config ⇒ [MintPress::Aws::Lambda::ImageConfig] (Default Value: MintPress::Aws::Lambda::ImageConfig.new)
    'Configuration values that override the container image Dockerfile.'
    Property Attributes
    • create_function_prop ⇒ 'image_config'
    • default ⇒ MintPress::Aws::Lambda::ImageConfig.new
    • read_only ⇒ false
    • source ⇒ "create_function"
    

80
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 80

property :image_config, create_function_prop: 'image_config', type: [MintPress::Aws::Lambda::ImageConfig], default: MintPress::Aws::Lambda::ImageConfig.new, read_only: false, source: "create_function", description: 'Configuration values that override the container image Dockerfile.'
  • #code_signing_config_arn ⇒ [String]
    'To enable code signing for this function, specify the ARN of a code-signing configuration. A code-signing configuration includes a set of signing profiles, which define the trusted publishers for this function.'
    Property Attributes
    • create_function_prop ⇒ 'code_signing_config_arn'
    • read_only ⇒ false
    • source ⇒ "create_function"
    

81
82
83
84
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 81

property :code_signing_config_arn, create_function_prop: 'code_signing_config_arn', type: [String], read_only: false, source: "create_function", description: 'To enable code signing for this function, specify the ARN of a
code-signing configuration. A code-signing configuration includes a
set of signing profiles, which define the trusted publishers for this
function.'
  • #qualifier ⇒ [String]
    'Specify a version or alias to get details about a published version of the function.'
    Property Attributes
    • delete_function_prop ⇒ 'qualifier'
    • read_only ⇒ false
    • source ⇒ "get_function"
    • get_function_prop ⇒ 'qualifier'
    

85
86
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 85

property :qualifier, delete_function_prop: 'qualifier', type: [String], read_only: false, source: "get_function", description: 'Specify a version or alias to get details about a published version of
the function.', get_function_prop: 'qualifier'
  • #master_region ⇒ [String]
    'For Lambda@Edge functions, the AWS Region of the master function. For example, us-east-1 filters the list of functions to only include Lambda@Edge functions replicated from a master function in US East (N. Virginia). If specified, you must set FunctionVersion to ALL.'
    Property Attributes
    • list_functions_prop ⇒ 'master_region'
    • read_only ⇒ false
    • source ⇒ "list_functions"
    

87
88
89
90
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 87

property :master_region, list_functions_prop: 'master_region', type: [String], read_only: false, source: "list_functions", description: 'For Lambda@Edge functions, the AWS Region of the master function. For
example, us-east-1 filters the list of functions to only include
Lambda@Edge functions replicated from a master function in US East (N.
Virginia). If specified, you must set FunctionVersion to ALL.'
  • #function_version ⇒ [String]
    'Set to ALL to include entries for all published versions of each function.'
    Property Attributes
    • list_functions_prop ⇒ 'function_version'
    • read_only ⇒ false
    • source ⇒ "list_functions"
    

91
92
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 91

property :function_version, list_functions_prop: 'function_version', type: [String], read_only: false, source: "list_functions", description: 'Set to ALL to include entries for all published versions of each
function.'
  • #max_items ⇒ [Integer]
    'The maximum number of functions to return.'
    Property Attributes
    • list_functions_prop ⇒ 'max_items'
    • read_only ⇒ false
    • source ⇒ "list_functions"
    

93
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 93

property :max_items, list_functions_prop: 'max_items', type: [Integer], read_only: false, source: "list_functions", description: 'The maximum number of functions to return.'
  • #name ⇒ [String]

    Property Attributes 
    

94
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 94

property :name, type: [String]
  • #region ⇒ String
    Region _specifically for this object_. If you're not doing different objects in different regions, you should not set this, but rather set the region on your AwsPlatformProvider instead
    Property Attributes 
    

98
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 98

property :region, type: String
  • #platform ⇒ MintPress::InfrastructureAws::AwsPlatform (Default Value: MintPress::InfrastructureAws::AwsPlatform.new)
    The platform details, including credentials - normally this will come via AwsPlatformProvider (see the Infrastructure Providers section of the documentation)
    Property Attributes
    • default ⇒ MintPress::InfrastructureAws::AwsPlatform.new
    

101
    		 
    # File 'src/mintpress-infrastructure-aws/lib/mintpress-infrastructure-aws/generated/lambda/function.rb', line 101

property :platform, type: MintPress::InfrastructureAws::AwsPlatform, default: MintPress::InfrastructureAws::AwsPlatform.new

Properties (Read Only)

Constant Summary

Constants included from MintLogger

MintLogger::DEBUG, MintLogger::ERROR, MintLogger::FATAL, MintLogger::INFO, MintLogger::UNKNOWN, MintLogger::VERBOSE, MintLogger::WARN

Instance Attribute Summary

Attributes included from Mixins::Properties

#autopush_set_cache, #dynamic_create, #harvest_on_access, #harvest_undefined_only, #harvested, #tree_root

Instance Method Summary collapse

Methods included from AwsCommon

#alive?, all, #attach_generic, #attached?, #available?, #build_create_hash, #by_id, #by_name, #create_generic, #delete_cascade_generic, #delete_generic, #detach_generic, #exists?, #fill_in_details, #find_by_details, #find_global_object, #get_aws_region, #get_state, #handle_singleton_object, #harvest, #perform_operation, #prop_to_hash, #register_aws_object, #resource_api, #running?, #start_generic, #started?, #stop_generic, #terminate_generic

Methods included from Mixins::Properties

#[], #[]=, #add_validate_report_result, #armour_set_property, #array_contains?, #array_is_a?, #check_autopush, #check_stack_overflow, #clone_property_object, #cloner_handle_single_property, #coerce_single, #contains_as_string?, #display_validate_report_result, #double_initialize?, #dump_to_hash, #find_parent, #find_parent_by_identity, #generate_accessor_functions, #get_canonical_renamed, #get_from_opts, #get_my_name, #get_property, #get_property_item, #has?, included, #initialize_validate_report, #inspect, #is_cloned_object?, #is_mintpress_object?, #is_probably_canonical?, #is_set?, #local_debug, #local_info, #local_verbose, #mintpress_property_definitions, #place_object_by_identity, #process_properties, #prop_set?, #property, #property_definitions, #property_details, #property_is_simple_object?, #push_root!, #require_property, #require_update, #retrieve_docstring, #sanitize, #set_map_dirty, #set_property, #set_property_item, #show_short_array, #strip_defaults!, #synchronize, #uncloned_property_definitions, #update_map, #validate, #validate_generic, #validate_properties, #validate_property, #validate_required, #version_allowed?, #weakref

Methods included from MintLogger::Utils::Common

#boolean_val, #has_value?, #no_value?, #nvl, #path_as_symbol, #ruby_level_to_send

Constructor Details

#initialize(opts = {}) ⇒ Function

Returns a new instance of Function.

Instance Method Details

#create ⇒ Object

#delete ⇒ Object

#delete_cascade ⇒ Object

#get ⇒ Object

#list ⇒ Object