How-to guides

• 1: Configure Trigger
• 2: Blueprint Detailed Guide
• 3: Integrate PrivateLink Service
• 4: Resource-based Policy Guide

1 - Configure Trigger

Configure Trigger

Setting up Cronjob trigger

To set up a Cronjob trigger, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function list page.
3. Function List page, click the resource for which you want to set a trigger. You will be taken to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. Set it. The Add Trigger popup window opens.
5. Add Trigger In the popup, select Cronjob from Trigger Type. A required information input area appears at the bottom.

   Category	Detailed description
   Cronjob configuration	Set the trigger’s repeat frequency Can be set in minutes, hours, days, months, weekdays
   Timezone setting	Set the trigger’s reference time zone

   Table. Cronjob Trigger Required Information Items
6. After entering the required information, click the Confirm button.
7. When the popup notifying an addition opens, click the Confirm button.

Configure API Gateway Trigger

To set up an API Gateway trigger, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Click the resource to set the trigger on the Function List page. Go to the Function Details page.
4. Click the Trigger tab, then click the Add Trigger button. Set it. The Add Trigger popup opens.
5. In the Add Trigger popup, select API Gateway under Trigger Type. A required information input area appears at the bottom.

   Category	Detailed description
   API name	Select API You can select an existing API or create a new one
   Stage	Select deployment target You can select an existing stage or create a new one

   Table. API Gateway Trigger Required Information Items
6. After entering the required information, click the Confirm button.
7. When the popup notifying the addition opens, click the Confirm button.

Configure Multi-Trigger

You can attach multiple triggers to a single function.

Modify Trigger

To modify the added trigger, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function list page.
3. On the Function List page, click the resource to edit the trigger. You will be taken to the Function Details page.
4. Click the Trigger tab, then in the trigger list, click the Edit button of the trigger whose settings you want to modify. The Edit Trigger popup window opens.
5. Edit Trigger After modifying the settings in the popup window, click the Confirm button.
   • The configuration values differ depending on the trigger type (refer to Cronjob Trigger, API Gateway Trigger).
6. When the edit notification popup appears, click Confirm.

Delete Trigger

To delete a trigger, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Function List page, click the resource for which you want to set a trigger. You will be taken to the Function Details page.
4. In the Trigger tab’s trigger list, select the trigger you want to delete, then click the Delete button.
5. When the popup notifying you of trigger deletion opens, click the Confirm button.

2 - Blueprint Detailed Guide

Blueprint Overview

When creating Cloud Functions, you can set a Blueprint to utilize the Runtime source code provided by Cloud Functions. Refer to the following for the Blueprint items provided by Cloud Functions.

Hello World

Hello World Explains the response-receiving configuration and a function call example (using the function URL).

Hello World Setup

To set up Hello World, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Go to the Service Home page of Cloud Functions.

2. On the Service Home page, click the Function menu. You will be taken to the Function List page.

3. Function List page, click the resource to be called via URL. You will be taken to the Function Detail page.

4. After clicking the Configuration tab, click the Edit button for the Function URL item. The Edit Function URL popup window opens.

5. In the Function URL Edit popup, set Activation status to Enabled, then click the Confirm button.

   Category	Detailed description
   Enable status	Configure the use of the function URL
   Authentication type	Select whether to use IAM authentication for requests to the function URL
   Access control	Add accessible IPs to enable management Set to Use, then you can input and add a public access IP

   Table. Required input fields when adding a trigger

6. After navigating to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.

7. After adding the handling logic for success and failure cases, click the Save button.

   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
         statusCode: 200,
         body: JSON.stringify('Hello Serverless World!'),
         };
         return response;
     };

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
         statusCode: 200,
         body: JSON.stringify('Hello Serverless World!'),
         };
         return response;
     };

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return {
         'statusCode': 200,
         'body': json.dumps('Hello Serverless World!')
         }

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return {
         'statusCode': 200,
         'body': json.dumps('Hello Serverless World!')
         }

   • PHP source code
     • PHP

     Sample Code Download

     Copy Code

     Color mode

     <?php
     function handle_request() {
         # User writing area (Function details)
         $res = array(
             'statusCode' => 200,
             'body' => 'Hello Serverless World!',
         );
         return $res;
     }
     ?>
     

     <?php
     function handle_request() {
         # User writing area (Function details)
         $res = array(
             'statusCode' => 200,
             'body' => 'Hello Serverless World!',
         );
         return $res;
     }
     ?>
     

Check function call

On the Function Details page, in the Configuration tab, invoke the function URL and then verify the response.

Hello Serverless World!

Execution after timeout

Describes configuring execution after timeout (Execution after timeout) and provides an example of invoking the function (using the function URL).

Configure execution after timeout

To set Execution after timeout, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. On the Function List page, click the resource for which you want to set a trigger. You will be taken to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. Add Trigger In the popup window, after selecting the Trigger Type item, enter the required information displayed at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency(minute, hour, day, month, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input fields when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     exports.handleRequest = async function (params) {
         /**
          * @description User writing area (Function details)
          */
         console.log("Hello world 3");
         await delay(3000);
     
         const response = {
             statusCode: 200,
             body: JSON.stringify('Hello Serverless World!'),
         };
         return response;
     };
     
     const delay = (ms) => {
         return new Promise(resolve=>{
             setTimeout(resolve,ms)
         })
     }

     exports.handleRequest = async function (params) {
         /**
          * @description User writing area (Function details)
          */
         console.log("Hello world 3");
         await delay(3000);
     
         const response = {
             statusCode: 200,
             body: JSON.stringify('Hello Serverless World!'),
         };
         return response;
     };
     
     const delay = (ms) => {
         return new Promise(resolve=>{
             setTimeout(resolve,ms)
         })
     }

Check function call

On the Function Detail page’s Configuration tab, invoke the function URL and, after a brief period, check the response.

Hello Serverless World!

HTTP request body

Explains the configuration for parsing the Request Body and an example of calling the function (using the function URL).

Setting HTTP request body

To set the HTTP request body, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Function List page, click the resource to set the trigger. You will be taken to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. Add Trigger In the popup window, select the Trigger Type option, then fill in the required information shown at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency (minutes, hours, day, month, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input fields when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
         statusCode: 200,
         body: JSON.stringify(params.body),
         };
         return response;
     };

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
         statusCode: 200,
         body: JSON.stringify(params.body),
         };
         return response;
     };

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return {
             'statusCode': 200,
             'body': json.dumps(params.json)
     }

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return {
             'statusCode': 200,
             'body': json.dumps(params.json)
     }

Check function call

In the Configuration tab of the Function Details page, after calling the Function URL, check the Body data, request Body value, and response Body value.

• Request Body value

  Sample Code Download

  Copy Code

  Color mode

  {
      "testKey" :"cloud-001",
      "testNames": [
          {
              "name": "Son"
          },
          {
              "name": "Kim"
          }
      ],
      "testCode":"test"
  }

  {
      "testKey" :"cloud-001",
      "testNames": [
          {
              "name": "Son"
          },
          {
              "name": "Kim"
          }
      ],
      "testCode":"test"
  }

• Response Body value

  Sample Code Download

  Copy Code

  Color mode

  {
      "testKey" :"cloud-001",
      "testNames": [
          {
              "name": "Son"
          },
          {
              "name": "Kim"
          }
      ],
      "testCode":"test"
  }

  {
      "testKey" :"cloud-001",
      "testNames": [
          {
              "name": "Son"
          },
          {
              "name": "Kim"
          }
      ],
      "testCode":"test"
  }

Send HTTP requests

Explains the HTTP request configuration and an example of calling a function (using the function URL).

Send HTTP requests Configure

To configure Send HTTP requests, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Click the resource to set the trigger on the Function List page. Go to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. Add Trigger In the popup window, after selecting the Trigger Type item, enter the required information displayed at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency (minutes, hours, day, month, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input items when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     const request = require('request');
     
     /**
     * @description User writing area (Function details)
     */
     exports.handleRequest = async function (params) {
     return await sendRequest(params);
     };
     
     async function sendRequest(req) {
         return new Promise((resolve, reject) => {
             // Port 80 and Port 443 are available
             url = "https://example.com"; // Destination URL
     
                 const options = {
                 uri: url,
                 method:'GET',
                 json: true,
                 strictSSL: false,
                 rejectUnauthorized: false
             }
             request(options, (error, response, body) => {
                 if (error) {
                     reject(error);
                 } else {
                     resolve({
                         statusCode: response.statusCode,
                         body: JSON.stringify(body)
                     });
                 }
             });
         });
     }

     const request = require('request');
     
     /**
     * @description User writing area (Function details)
     */
     exports.handleRequest = async function (params) {
     return await sendRequest(params);
     };
     
     async function sendRequest(req) {
         return new Promise((resolve, reject) => {
             // Port 80 and Port 443 are available
             url = "https://example.com"; // Destination URL
     
                 const options = {
                 uri: url,
                 method:'GET',
                 json: true,
                 strictSSL: false,
                 rejectUnauthorized: false
             }
             request(options, (error, response, body) => {
                 if (error) {
                     reject(error);
                 } else {
                     resolve({
                         statusCode: response.statusCode,
                         body: JSON.stringify(body)
                     });
                 }
             });
         });
     }

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     import json
     import requests
     
     def handle_request(params):
         # User writing area (Function details)
         
         # Port 80 and Port 443 are available
         url = "https://example.com" # Destination URL
     
         try:
             response = requests.get(url, verify=True)
             return {
                 'statusCode': response.status_code,
                 'body': json.dumps(response.text)
             }
         except requests.exceptions.RequestException as e:
             return str(e)

     import json
     import requests
     
     def handle_request(params):
         # User writing area (Function details)
         
         # Port 80 and Port 443 are available
         url = "https://example.com" # Destination URL
     
         try:
             response = requests.get(url, verify=True)
             return {
                 'statusCode': response.status_code,
                 'body': json.dumps(response.text)
             }
         except requests.exceptions.RequestException as e:
             return str(e)

Check Function Call

On the Function Details page, after invoking the function URL in the Configuration tab, verify the response.

<!doctype html>
<html>
<head>
    <title>Example Domain</title>

    <meta charset="utf-8" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <style type="text/css">
    body {
        background-color: #f0f0f2;
        margin: 0;
        padding: 0;
        font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
    }
    div {
        width: 600px;
        margin: 5em auto;
        padding: 2em;
        background-color: #fdfdff;
        border-radius: 0.5em;
        box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);
    }
    a:link, a:visited {
        color: #38488f;
        text-decoration: none;
    }
    @media (max-width: 700px) {
        div {
            margin: 0 auto;
            width: auto;
        }
    }
    </style>
</head>

<body>
<div>
    <h1>Example Domain</h1>

    <p>This domain is for use in illustrative examples in documents. You may use this
    domain in literature without prior coordination or asking for permission.</p>
    <p><a href="https://www.iana.org/domains/example">More information...</a></p>
</div>
</body>
</html>

<!doctype html>
<html>
<head>
    <title>Example Domain</title>

    <meta charset="utf-8" />
    <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <style type="text/css">
    body {
        background-color: #f0f0f2;
        margin: 0;
        padding: 0;
        font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
    }
    div {
        width: 600px;
        margin: 5em auto;
        padding: 2em;
        background-color: #fdfdff;
        border-radius: 0.5em;
        box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);
    }
    a:link, a:visited {
        color: #38488f;
        text-decoration: none;
    }
    @media (max-width: 700px) {
        div {
            margin: 0 auto;
            width: auto;
        }
    }
    </style>
</head>

<body>
<div>
    <h1>Example Domain</h1>

    <p>This domain is for use in illustrative examples in documents. You may use this
    domain in literature without prior coordination or asking for permission.</p>
    <p><a href="https://www.iana.org/domains/example">More information...</a></p>
</div>
</body>
</html>

Print logs

This explains how to configure log output and an example of calling a function (using the function URL).

Configure Print logs

Print logs To set up response receiving, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Function List page, click the resource to set the trigger. Function Details page will be displayed.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. In the Add Trigger popup, select the Trigger Type item, then enter the required information displayed at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency(minutes, hours, day, month, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input fields when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     const winston = require('winston');
     
     // Log module setting
     const logger = winston.createLogger({
         format: winston.format.combine(
             winston.format.timestamp(),
             winston.format.printf(info => info.timestamp + ' ' + info.level + ': ' + info.message)
             ),
             transports: [
                 new winston.transports.Console()
                 ]
     });
     
     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
             statusCode: 200,
             body: JSON.stringify(params.body),
         };
     
         logger.info(JSON.stringify(response, null, 2));
     
         return response;
     };

     const winston = require('winston');
     
     // Log module setting
     const logger = winston.createLogger({
         format: winston.format.combine(
             winston.format.timestamp(),
             winston.format.printf(info => info.timestamp + ' ' + info.level + ': ' + info.message)
             ),
             transports: [
                 new winston.transports.Console()
                 ]
     });
     
     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         const response = {
             statusCode: 200,
             body: JSON.stringify(params.body),
         };
     
         logger.info(JSON.stringify(response, null, 2));
     
         return response;
     };

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     import json
     import logging
     
     # Log module setting
     logging.basicConfig(level=logging.INFO)
     
     def handle_request(params):
         # User writing area (Function details)
         response = {
             'statusCode': 200,
             'body': json.dumps(params.json)
         }
     
         logging.info(response)
     
         return response

     import json
     import logging
     
     # Log module setting
     logging.basicConfig(level=logging.INFO)
     
     def handle_request(params):
         # User writing area (Function details)
         response = {
             'statusCode': 200,
             'body': json.dumps(params.json)
         }
     
         logging.info(response)
     
         return response

Check Function Call

After calling the function URL in the Configuration tab of the Function Details page, check the log in the Log tab.

[2023-09-07] 12:06:23] "host": "scf-xxxxxxxxxxxxxxxxxxxxx",
[2023-09-07] 12:06:23] "ce-id": "xxxxxxxxxxxxxxxxxxxxx",
[2023-09-07] 12:06:23] "ce-source": "xxxxxxxxxxxxxxxxxxxxx",

[2023-09-07] 12:06:23] "host": "scf-xxxxxxxxxxxxxxxxxxxxx",
[2023-09-07] 12:06:23] "ce-id": "xxxxxxxxxxxxxxxxxxxxx",
[2023-09-07] 12:06:23] "ce-source": "xxxxxxxxxxxxxxxxxxxxx",

Throw a custom error

Explains setting up a custom error (Throw a custom error) and an example of calling a function (using a function URL).

Configure Throw a custom error

To configure Throw a custom error, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Click the resource to set the trigger on the Function List page. Go to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. Add Trigger In the popup window, after selecting the Trigger Type item, enter the required information displayed at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency (minutes, hours, day, month, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input fields when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     class CustomError extends Error {
         constructor(message) {
             super(message);
             this.name = 'CustomError';
         }
     }
     
     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         throw new CustomError('This is a custom error!');
     };

     class CustomError extends Error {
         constructor(message) {
             super(message);
             this.name = 'CustomError';
         }
     }
     
     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         throw new CustomError('This is a custom error!');
     };

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     class CustomError(Exception):
         def __init__(self, message):
         self.message = message
     
     def handle_request(parmas):
         raise CustomError('This is a custom error!')

     class CustomError(Exception):
         def __init__(self, message):
         self.message = message
     
     def handle_request(parmas):
         raise CustomError('This is a custom error!')

   • PHP source code
     • PHP

     Sample Code Download

     Copy Code

     Color mode

     <?php
         class CustomError extends Exception {
             public function __construct($message) {
                 parent::__construct($message);
                 $this->message = $message;
             }
         }
     
         function handle_request() {
             throw new CustomError('This is a custom error!');
         }
     ?>
     

     <?php
         class CustomError extends Exception {
             public function __construct($message) {
                 parent::__construct($message);
                 $this->message = $message;
             }
         }
     
         function handle_request() {
             throw new CustomError('This is a custom error!');
         }
     ?>
     

Check Function Call

On the Function Details page, after calling the Function URL in the Configuration tab, verify whether an error occurred in the Log tab.

Using Environment Variable

Explains the use of environment variables (Using Environment Variable) settings and a function call example (using function URL).

Using Environment Variable Configure

To configure Using Environment Variable, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function List page.
3. Click the resource to set the trigger on the Function List page. Go to the Function Details page.
4. After clicking the Trigger tab, click the Add Trigger button. The Add Trigger popup window opens.
5. In the Add Trigger popup, select the Trigger Type item, then enter the required information displayed at the bottom and click the OK button.
   • Required information varies depending on the trigger type.

     Trigger Types	Input field
     API Gateway	API name: Select an existing API or create a new one Stage: Select an existing stage or create a new one
     Cronjob	Refer to the example and enter the trigger’s repeat frequency(minutes, hours, days, months, day of week) Timezone setting: select the reference time zone to apply

     Table. Required input fields when adding a trigger
6. After moving to the Code tab, click the Edit button. You will be taken to the Function Code Edit page.
7. After adding the handling logic for success and failure cases, click the Save button.
   • Node.js source code
     • Node.js

     Sample Code Download

     Copy Code

     Color mode

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         return process.env.test;
     };

     exports.handleRequest = async function (params) {
         /**
         * @description User writing area (Function details)
         */
         return process.env.test;
     };

   • Python source code
     • Python

     Sample Code Download

     Copy Code

     Color mode

     import json
     
     import os
     
     def handle_request(params):
         # User writing area (Function details)
         return os.environ.get("test")

     import json
     
     import os
     
     def handle_request(params):
         # User writing area (Function details)
         return os.environ.get("test")

   • PHP source code
     • PHP

     Sample Code Download

     Copy Code

     Color mode

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return os.environ.get("test")

     import json
     
     def handle_request(params):
         # User writing area (Function details)
         return os.environ.get("test")

8. After moving to the Configuration tab, click the Edit button in the Environment Variables area. The Edit Environment Variables popup will open.
9. After entering the environment variable information, click the Confirm button.

   Category	Detailed description
   Name	Enter the key value
   value	Enter the value

   Table. Environment Variable Input Items

Check function call

On the Function Details page, after calling the function URL in the Configuration tab, check the environment variable value in the Log tab.

3 - Integrate PrivateLink Service

By integrating Cloud Functions with the PrivateLink service, you can connect VPCs within the Samsung Cloud Platform to other VPCs, and VPCs to services, without using the external internet.
The data uses only the internal network, providing high security, and does not require public IP, NAT, VPN, or an internet gateway.

Enable PrivateLink Service

To connect the PrivateLink Service, you must first enable the service.

To enable the PrivateLink service, follow these steps.

1. All Services > Compute > Cloud Functions Click the menu. 1. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. 2. Go to the Function list page.
3. On the Function List page, click the resource to associate with PrivateLink. 3. Function Details page.
4. On the Function Details page, click the Configuration tab.
5. In Private connection configuration, click the Edit button of PrivateLink Service. 5. PrivateLink Service Edit The popup window opens.
6. PrivateLink Service Edit In the popup window, after checking the Use item of Activation Status, click the Confirm button. 6. Configuration tab’s Private connection configuration displays PrivateLink Service information.

Integrating PrivateLink Service

You can expose the function for private access from another VPC by integrating with PrivateLink Service.

To integrate the PrivateLink service, review the following tasks.

• Register the domain for the PrivateLink Endpoint IP address and the Private URL address to invoke the issued Private URL.

  192.168.0.13 abc123.scf.private.kr-west1.qa2.samsungsdscloud.com
  

• When invoking the PrivateLink Service, verify IAM authentication based on the credentials of the Endpoint creator required for the Endpoint.

Create PrivateLink Endpoint

Create an entry point to access the PrivateLink Service of the user VPC.

To create a PrivateLink Endpoint, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. 1. Go to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. 2. Go to the Function list page.
3. On the Function list page, click the resource to associate with PrivateLink. 3. Function Details Go to the page.
4. On the Function Details page, click the Configuration tab.
5. Click the Add button in Private connection configuration of PrivateLink Endpoint. 5. Add PrivateLink Endpoint The popup window opens.
6. Add PrivateLink Service in the popup window, after entering the PrivateLink Service ID and Alias information, click the Confirm button.
7. When the popup indicating creation opens, click the Confirm button. 7. Configuration tab’s Private connection configuration displays PrivateLink Endpoint information.

Integrating APIGW Private EPS

To connect the SCF Endpoint and the APIGW Private Endpoint, you must specify the Private URL in the SCF Endpoint Alias instead of the APIGW EPS resource path.

• Private URL example: 181b6126ef6d4e4b81370df5.apigw.private.kr-west1.s.samsungsdscloud.com/get/resourcepath

To integrate APIGW Private EPS, refer to the following code.

const request = require('request');

/**
 * @description User writing area (Function details)
*/
exports.handleRequest = async function (params) {
    return await sendRequest(params);
};
 
async function sendRequest(req) {
    return new Promise((resolve, reject) => {
        // Port 80 and Port 443 are available
        url = "https://{alias}/{resource_path}"; // Destination URL
        /**
        {alias} is the alias name entered when creating an Endpoint within the function
        {resoure_path} is the resource path (/get/resourcepath) specified in the Private URL of APIGW EPS
        */

        const options = {
            uri: url,
            method:'GET',
            json: true,
            strictSSL: false,
            rejectUnauthorized: false
        }
         
        request(options, (error, response, body) => {
            if (error) {
                reject(error);
            } else {
                resolve({
                    statusCode: response.statusCode,
                    body: JSON.stringify(body)
                });
            }
        });
    });
}

const request = require('request');

/**
 * @description User writing area (Function details)
*/
exports.handleRequest = async function (params) {
    return await sendRequest(params);
};
 
async function sendRequest(req) {
    return new Promise((resolve, reject) => {
        // Port 80 and Port 443 are available
        url = "https://{alias}/{resource_path}"; // Destination URL
        /**
        {alias} is the alias name entered when creating an Endpoint within the function
        {resoure_path} is the resource path (/get/resourcepath) specified in the Private URL of APIGW EPS
        */

        const options = {
            uri: url,
            method:'GET',
            json: true,
            strictSSL: false,
            rejectUnauthorized: false
        }
         
        request(options, (error, response, body) => {
            if (error) {
                reject(error);
            } else {
                resolve({
                    statusCode: response.statusCode,
                    body: JSON.stringify(body)
                });
            }
        });
    });
}

4 - Resource-based Policy Guide

Resource-based policy overview

The resource-based policy (Resource-based Policy) of Cloud Functions is a policy granted to a resource that can decide to allow or deny (Effect) an action (Action) on a specific resource for a principal (Principal). You can directly define the principal that can invoke a function by using resource-based policies.

You can allow function calls by defining the following in a resource-based policy.

• User of the specified Samsung Cloud Platform account
• Specified source IP address range or CIDR block

A source policy is defined as a JSON policy document attached to the API, which controls whether the specified security principal (typically an IAM role or group) can call the API.

Resource-based policy usage scenario

The primary use cases for resource-based policies are as follows.

Resource-based policy scenario

The resource-based policy scenarios used when a Cloud Functions function runs are as follows.

User addition usage scenario

Although it is not automatically registered as a resource-based policy for Cloud Functions, users can add and use it as needed. The scenarios that users can add and utilize are as follows.

• Cross-Account Access
  • If an IAM user in account A wants to invoke a Lambda in account B, register account A in the function policy of account B.
• Hybrid Access Control
  • It can be configured so that access is allowed only when both conditions are met—a specific user and a specific IP range—rather than merely restricting by account or IP alone.

Resource-based policy management for Cloud Functions

To view and configure resource-based policies for Cloud Functions, follow these steps.

1. Click the All Services > Compute > Cloud Functions menu. Navigate to the Service Home page of Cloud Functions.
2. On the Service Home page, click the Function menu. You will be taken to the Function list page.
3. On the Function List page, click the resource for which you want to set a policy. You will be taken to the Function Details page.
4. Click the Configuration tab on the Function Details page.
5. Click the Edit button of the Resource-based policy permission item. The Resource policy edit popup window opens.
6. In the Resource Policy edit popup, after selecting the Policy Template, write the policy.
   • For policy examples by policy template, refer to Resource-based policy examples.
7. When the writing is complete, click the Confirm button.
   • Click the Delete button to delete the registered policy.

Example of resource-based policy

Users can define additional resource-based policies as needed or modify existing policies for use.

Function URL - Authentication Type None

Principal is /* a policy that allows public calls.

Policy Template

{
    "Statement": [
        {
        	"Action": ["scf:InvokeFunctionUrl"],
        	"Condition": {
            	"StringEquals": {
                	"scf:CloudFunctionAuthType": ["NONE"]
            	}
        	},
        	"Effect": "Allow"
        	"Principal": "*"
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "InvokeFunctionURLAllowPublicAccess"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
        	"Action": ["scf:InvokeFunctionUrl"],
        	"Condition": {
            	"StringEquals": {
                	"scf:CloudFunctionAuthType": ["NONE"]
            	}
        	},
        	"Effect": "Allow"
        	"Principal": "*"
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "InvokeFunctionURLAllowPublicAccess"
        }
    ],
    "Version": "2024-07-01"
}

Policy example

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["NONE"]
                }
            },
            "Effect": "Allow"
            "Principal": "*"
            "Resource": ["srn:e::accountID:kr-west1::scf:cloud-function/functionsID"],
            "Sid": "InvokeFunctionURLAllowPublicAccess"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["NONE"]
                }
            },
            "Effect": "Allow"
            "Principal": "*"
            "Resource": ["srn:e::accountID:kr-west1::scf:cloud-function/functionsID"],
            "Sid": "InvokeFunctionURLAllowPublicAccess"
        }
    ],
    "Version": "2024-07-01"
}

Function URL - Authentication Type IAM

This policy permits a specific user to invoke a public URL.

Policy Template

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "scp": ["srn:{{Environment}}::{{AccountID}}:::iam:user/{{UserId}}"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "scp": ["srn:{{Environment}}::{{AccountID}}:::iam:user/{{UserId}}"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

Policy Example

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": "*",
            "Resource":  ["srn:e::accountID:kr-west1::scf:cloud-function/functionsID"],
            "Sid": "accountID-iam-invokefunctionurl"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunctionUrl"],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": "*",
            "Resource":  ["srn:e::accountID:kr-west1::scf:cloud-function/functionsID"],
            "Sid": "accountID-iam-invokefunctionurl"
        }
    ],
    "Version": "2024-07-01"
}

API Gateway trigger

Principal is a policy that permits public calls with a * principal.

Policy Template

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunction"],
            "Condition": {
                "SrnLike": {
                    "scp:RequestAttribute/body['x-scf-request-obj-srn']": ["{{ApiGatewayMethodSrn}}"]
                }
            },
            "Effect": "Allow",
            "Principal": {
                "Service": ["apigateway.samsungsdscloud.com"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunction"],
            "Condition": {
                "SrnLike": {
                    "scp:RequestAttribute/body['x-scf-request-obj-srn']": ["{{ApiGatewayMethodSrn}}"]
                }
            },
            "Effect": "Allow",
            "Principal": {
                "Service": ["apigateway.samsungsdscloud.com"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

Policy Example

{
    "Statement": [
        {
            "Action": [
                scf:InvokeFunction
            ],
            "Condition": {
                "SrnLike": {
                    "scp:RequestAttribute/body['x-scf-request-obj-srn']": [
                        srn:e::accountID:kr-west1::apigateway:method/MethodID/*/GET/test
                    ]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "Service": [
                    "apigateway.samsungsdscloud.com"
                ]
            },
            "Resource": [
                srn:e::accountID:kr-west1::scf:cloud-function/functionID
            ],
            "Sid": "999e9a9999de4d4683c9e10c74ee999z"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": [
                scf:InvokeFunction
            ],
            "Condition": {
                "SrnLike": {
                    "scp:RequestAttribute/body['x-scf-request-obj-srn']": [
                        srn:e::accountID:kr-west1::apigateway:method/MethodID/*/GET/test
                    ]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "Service": [
                    "apigateway.samsungsdscloud.com"
                ]
            },
            "Resource": [
                srn:e::accountID:kr-west1::scf:cloud-function/functionID
            ],
            "Sid": "999e9a9999de4d4683c9e10c74ee999z"
        }
    ],
    "Version": "2024-07-01"
}

PrivateLink connection

This is a policy that allows function calls through a Privatelink Endpoint for specific users.

Policy Template

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunction"],
            "Condition": {
                "StringEquals": {
           			"scf:CloudFunctionPrivatelinkServiceAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "scp": ["srn:{{Environment}}::{{AccountID}}:::iam:user/{{UserId}}"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": ["scf:InvokeFunction"],
            "Condition": {
                "StringEquals": {
           			"scf:CloudFunctionPrivatelinkServiceAuthType": ["SCP_IAM"]
                }
            },
            "Effect": "Allow"
            "Principal": {
                "scp": ["srn:{{Environment}}::{{AccountID}}:::iam:user/{{UserId}}"]
            },
            "Resource": ["{{CloudFunctionSrn}}"],
            "Sid": "Statement1"
        }
    ],
    "Version": "2024-07-01"
}

Policy Example

{
    "Statement": [
        {
            "Action": [
                scf:InvokeFunction
            ],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": [
                        SCP_IAM
                    ]
                }
            },
            "Effect": "Allow",
            "Principal": {
                "scp": [
                    srn:e::accountID:::iam:user/userID
                ]
            },
            "Resource": [
                srn:e::accountID:kr-west1::scf:cloud-function/functionID
            ],
"Sid": "rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr-privatelink-invokefunction"
        }
    ],
    "Version": "2024-07-01"
}

{
    "Statement": [
        {
            "Action": [
                scf:InvokeFunction
            ],
            "Condition": {
                "StringEquals": {
                    "scf:CloudFunctionAuthType": [
                        SCP_IAM
                    ]
                }
            },
            "Effect": "Allow",
            "Principal": {
                "scp": [
                    srn:e::accountID:::iam:user/userID
                ]
            },
            "Resource": [
                srn:e::accountID:kr-west1::scf:cloud-function/functionID
            ],
"Sid": "rrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrrr-privatelink-invokefunction"
        }
    ],
    "Version": "2024-07-01"
}