How to guides
Create Queue Service
You can create and use a Queue Service from the Samsung Cloud Platform Console.
To create a Queue Service, follow these steps.
All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
On the Service Home page, click the Create Queue button. 2. Go to the Create Queue page.
Queue Creation page, enter the information required to create the service, and select detailed options.
- Enter or select the required information in the service information input area.
Category Required statusDetailed description type Essential Select service type - Basic: Message order not preserved
- FIFO: First-in-first-out message delivery and message retention
Queue name required Enter the queue name - Enter a name that starts with a lowercase English letter and includes lowercase English letters, numbers, and the special character (-) within 3 ~ 64 characters
- Standard type: The ‘.fifo’ suffix cannot be used in the name
- FIFO type: Enter a name that includes the .fifo suffix
Duplicate removal scope required Select duplicate removal scope - Messages in queue: Remove duplicate items among messages in the queue
- Group-level messages: Remove duplicate items within group-level messages
- Configurable only when FIFO type is selected
Content-based duplicate removal Selection Hash the message body content to remove duplicate messages - Can be configured only when the FIFO type is selected
Explanation Selection Enter the service description within 100 characters. Table. Queue creation - Service information input items - Enter or select the required information in the message settings area.
Category Required statusDetailed description Message size required Enter the message size value (KB) between 1 and 256 - Up to 50 can be added per resource
Message retention period required Enter the message retention period - After selecting the unit period, enter the desired value
- seconds: 60 ~ 1,209,600
- minutes: 1 ~ 20,160
- hours: 1 ~ 336
- days: 1 ~ 14
Transmission latency required Enter the delay time when sending a message - After selecting the unit of time, enter the desired value
- seconds: 0 ~ 900
- minutes: 0 ~ 15
- If FIFO type is selected, configuration is not allowed
Display timeout required Enter the waiting time until the message is displayed - After selecting the unit of time, enter the desired value
- seconds: 0 ~ 43,200
- minutes: 0 ~ 720
- hours: 0 ~ 12
Message reception waiting time required Enter the message polling timeout duration (seconds) between 0 and 20. Table. Queue creation - message configuration items - Enter or select the required information in the message settings area.
Category RequiredDetailed description Encryption required Select encryption usage - New creation: Go to the KMS page to create a new KMS encryption
- Do not use: Do not use encryption
- KMS encryption: Select when using KMS
- Data Key reuse period: After selecting a unit period, enter the desired value
- Minutes: 5 ~ 1,440
- Hours: 1 ~ 24
- KMS-Managed-Key: Select when using KMS-Managed-Key
- Data Key reuse period: After selecting a unit period, enter the desired value
Table. Queue creation - encryption settings items - Enter or select the required information in the lead drive settings area.
Category Required statusDetailed description Allow read drive required Select read drive permission method - Block All: Do not allow read drive
- Allow All: Queues can use the read drive for all Queue resources
- Maximum Receive Attempt Count: Enter the maximum number of receive attempts between 1 and 10
- Specific Queue: Only specific Queue resources can use the read drive
- Read Drive Allowed Queue: Click the Add button to add up to 10 read drive allowed Queue resources
- Maximum Receive Attempt Count: Enter the maximum number of receive attempts between 1 and 10
Read drive target Queue Required Select the lead drive Queue target for the resource to be created - Not used: Lead drive target Queue not selected
- Resend count When selecting the lead drive target Queue resource, input a value between 1 and 10
Table. Queue creation - lead drive configuration items - Enter or select the required information in the additional information input area.
Category RequiredDetailed description tag Select Add tag - Up to 50 can be added per resource
- After clicking the Add Tag button, enter or select Key, Value values
Table. Queue creation - additional information input fields
- Enter or select the required information in the service information input area.
Summary Check the detailed information and estimated charges generated in the panel, and click the Create button.
- When creation is complete, check the resources you created on the page.
- When using a FIFO type Queue, up to 100 message groups are supported.
- If the maximum number of message groups is exceeded, message delivery may fail.
Check detailed information of Queue Service
You can view detailed information and messages about the Queue Service.
To view detailed information about the Queue Service, follow these steps.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue list page, click the resource to view detailed information. 3. Queue Details Navigate to the page.
- Queue Details page displays status information and additional feature information, and consists of Details, Message Management, Tags, Job History tabs.
Category Detailed description Queue Service status Queue Service status representation - Creating: In creation
- Available: Created, server connection available
- Deleting: Service termination in progress
- Error Deleting: Abnormal state during deletion
- Inactive: Abnormal state
- Error: Abnormal state during creation
Service cancellation Service cancellation button Table. Queue Service status information and additional feature items
- Queue Details page displays status information and additional feature information, and consists of Details, Message Management, Tags, Job History tabs.
Detailed Information
On the Queue list page, you can view detailed information of the selected resource and, if necessary, edit the information.
| Category | Detailed description |
|---|---|
| service | Service name |
| Resource Type | Resource Type |
| SRN | Unique resource ID in Samsung Cloud Platform
|
| Resource name | Resource name
|
| Resource ID | Service’s unique resource ID |
| constructor | User who created the service |
| Creation timestamp | Service creation date and time |
| Editor | User who modified the service |
| Modification date and time | Service modification date and time |
| type | Queue type |
| Duplicate removal scope | Duplicate removal scope
|
| Content-based duplicate removal | Whether to use content-based duplicate removal feature
|
| Message Settings | Message configuration information
|
| Encryption Settings | Encryption usage
|
| Lead drive configuration | Redrive enablement and target Queue
|
| PrivateLink Service ID | PrivateLink service ID |
| Explanation | Queue description
|
| IP Access Allow List | List of IPs allowed to access the Queue service
|
Message Management
Queue list page lets you view and manage the message list of the selected resource.
- Messages are displayed up to a maximum of 10.
- If there are no messages in the list, you can click the Message Polling button to retrieve messages.
- Refer to Manage messages for how to manage messages.
| Category | Detailed description |
|---|---|
| Message polling | After polling messages from the Queue to the Console, refresh the message list. |
| More | You can send, delete, and remove messages
|
| Message List | Message ID, message transmission timestamp, message reception timestamp, and message size (byte) can be viewed
|
Tag
Queue List page lets you view the tag information of the selected resource, and you can add, modify, or delete it.
| Category | Detailed description |
|---|---|
| Tag List | Tag list
|
Operation History
On the Queue List page, you can view the operation history of the selected resource.
| Category | Detailed description |
|---|---|
| Task History List | Resource Change History
|
Managing Queue Service Resources
You can modify the configuration information such as message settings, encryption, and IP access control of the created Queue Service resource.
Edit Message Settings
You can modify the message settings.
To modify the message settings, follow the steps below.
- Click the All Services > Application > Queue Service menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
- On the Queue List page, click the resource to edit the message settings. 3. Go to the Queue Details page.
- Click the Edit button of the Message Settings item. 4. Message Settings Edit The popup window opens.
- Edit Message Settings After modifying the configuration information in the popup window, click the Confirm button.
Category Required statusDetailed description Message size Required Enter the message size value (KB) between 1 and 256 - Up to 50 can be added per resource
Message retention period Required Enter the message retention period - After selecting the unit period, enter the desired value
- seconds: 60 ~ 1,209,600
- minutes: 1 ~ 20,160
- hours: 1 ~ 336
- days: 1 ~ 14
Transmission latency Required Enter the delay time when sending a message - After selecting the unit time, enter the desired value
- seconds: 0 ~ 900
- minutes: 0 ~ 15
- If FIFO type is selected, configuration is not allowed
Display timeout Required Enter the waiting time until the message is displayed - After selecting the unit of time, enter the desired value
- seconds: 0 ~ 43,200
- minutes: 0 ~ 720
- hours: 0 ~ 12
Message reception wait time Required Enter the message polling timeout (seconds) between 0 and 20. Table. Message setting edit input items
- Message retention period applies starting after transmission delay time. * Please refer to the following example.
- Message retention period is 60 seconds, Transmission delay is 3 seconds: the message is deleted after 63 seconds.
- message retention period is 3 seconds, and transmission delay is 30 seconds: delete the message after 33 seconds.
- Messages with Transmission delay applied attempt to be sent for up to 15 minutes depending on the state of the user’s Queue resources.
Modify Encryption Settings
You can modify the encryption settings.
To modify the encryption settings, follow these steps.
- Click the All Services > Application > Queue Service menu. 1. Navigate to the Service Home page of Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue list page, click the resource to modify the encryption settings. 3. Navigate to the Queue Details page.
- Click the Edit button for the Encryption item. 4. Edit Encryption Settings A popup window opens.
- Modify Encryption Settings In the popup window, edit the settings, then click the Confirm button.
Category RequiredDetailed description Encryption Required Select encryption usage and type - Create new: Navigate to the KMS page to create a new KMS encryption
- Do not use: Do not use encryption
- KMS encryption: Select when using KMS
- KMS-Managed-Key: Select when using KMS-Managed-Key
Data Key reuse period Required After selecting the unit period, enter the desired value - minutes: 5 ~ 1,440
- hours: 1 ~ 24
- KMS encryption must be configured when used
Table. Encryption Settings Modification Input Items
Modify Redrive Settings
You can modify the lead drive settings.
To modify the lead drive settings, follow the steps below.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
- Click the Queue menu on the Service Home page. 2. Go to the Queue list page.
- Queue list page, click the resource to modify the read drive settings. 3. Go to the Queue details page.
- Click the Edit button of the Lead drive settings item. 4. Edit Read Drive Permission A popup window opens.
- Edit Lead Drive Permission After modifying the settings in the popup window, click the Confirm button.
Category RequiredDetailed description Allow read drive Required Select read drive permission method - Block All: Do not allow read drive
- Allow All: Queues can be used with read drive for all Queue resources
- Specific Queue: Only specific Queue resources can use read drive
- In the Read Drive Allowed Queue list, click the Add button to add up to 10 Queue resources as read drive targets
Lead drive target queue required Select the lead drive Queue target for the resource to be created - Not used: Lead drive target Queue not selected
- Resend count When selecting the lead drive target Queue resource, input a value between 1 and 10
Table. Read drive allow edit items
Managing IP Access Permissions
You can manage IPs that can access the Queue Service.
Add allowed IP
To add an allowed IP, follow these steps.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue list page, click the resource to add an allowed IP address. 3. Go to the Queue Details page.
- Click the Add IP Address button in the IP Access Allow List item. 4. Add IP Address popup opens.
- After entering the IP to add to the IP Access Allow List, click the Confirm button.
- Click the + button to add multiple IPs simultaneously (up to 10).
- When the popup notifying the addition of an IP opens, click the Confirm button.
Exclude accessible IP
To exclude the IPs registered in the IP Access Allow List, follow the steps below.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue list page, click the resource to exclude the accessible IP. 3. Navigate to the Queue Details page.
- After checking the IPs to exclude in the IP Access Allow List item, click the Delete button at the top of the list.
- From the IP Access Allow List, you can also individually exclude an IP by clicking its Delete button.
- When the pop-up notifying IP deletion opens, click the Confirm button.
Manage Messages
You can send or manage queue messages.
Send Message
To send a Queue message, follow the steps below.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of Queue Service.
- On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
- On the Queue List page, click the resource to send a Queue message. 3. Navigate to the Queue Details page.
- Click the Message Management tab on the Queue Details page.
- Click the More > Send Message button at the top of the message list. 5. Message Sending A popup window opens.
- Message Sending After entering the message information to be sent in the popup window, click the Confirm button.
Category Required statusDetailed description Message body required Enter the message to send - Up to 262,244 bytes can be entered
Message Group ID required Enter using letters, numbers, and special characters within 128 characters - FIFO only displayed when using this type
Message deduplication ID Required/Optional Enter up to 128 characters using letters, numbers, and special characters - Displayed only when using the FIFO type
- If the content-based deduplication feature is used, you can choose whether to input
Meta information Selection Select whether to use meta information to add to the message - When used, you can enter up to 10 Key, Value entries
Encryption required Select encryption usage - New creation: Go to the KMS page to create a new KMS encryption
- Do not use: Do not use encryption
- KMS encryption: Select when using KMS
- Data Key reuse period: After selecting a unit period, enter the desired value
- Minutes: 5 ~ 1,440
- Hours: 1 ~ 24
- Data Key reuse period: After selecting a unit period, enter the desired value
Table. Message sending input items
Check message details
You can view the content and detailed information of the Queue message. To view the detailed message information, follow these steps.
- Click the All Services > Application > Queue Service menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue List page, click the resource to view the Queue messages. 3. Go to the Queue Details page.
- Click the Message Management tab on the Queue Details page.
- Click the message ID in the message list to view its details. 5. Message Details The popup window opens.
Category Detailed description Message ID Message unique ID Message size Message size Message sent date and time Message transmission date and time Message receipt date and time Message receipt date and time Message Group ID Message group ID - displayed only when using the FIFO type
Message deduplication ID Deduplication ID set in the message - displayed only when using the FIFO type
message body Message content Meta information Message meta information (Key, Value) values Table. Message detail information items
Delete individual messages
Queue messages can be deleted individually. To delete a message, follow these steps.
- Click the All Services > Application > Queue Service menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Navigate to the Queue list page.
- On the Queue List page, click the resource to delete the Queue message. 3. Go to the Queue Details page.
- Click the Message Management tab on the Queue Details page.
- After selecting all messages to delete from the message list, click the More > Delete button at the top of the list.
- You can also delete individually by clicking the Delete button at the far right of the message you want to remove in the message list.
- When the popup notifying message deletion opens, click the Confirm button.
Empty all messages in the queue
You can delete all messages in the Queue by emptying the Queue.
- Messages deleted via Empty Queue cannot be recovered.
- If the same request is already in progress, it will not be deleted. * In a moment, please clear the queue again.
To delete all messages, follow these steps.
- Click the All Services > Application > Queue Service menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
- Queue List page, click the resource to remove the Queue message. 3. Go to the Queue Details page.
- Click the Message Management tab on the Queue Details page.
- Click the More > Clear Queue button at the top of the message list.
- When the popup notifying message deletion opens, click the Confirm button.
Cancel Queue Service
You can cancel the unused Queue Service to reduce operating costs.
However, if you terminate the service, the currently operating service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may arise from the service interruption.
To cancel the Queue Service, follow the steps below.
- All Services > Application > Queue Service Click the menu. 1. Navigate to the Service Home page of the Queue Service.
- On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
- On the Queue List page, after selecting the resource to cancel, click the Cancel Service button.
- After navigating to the Queue Details page of the resource to be terminated, you can also terminate it individually by clicking the Terminate Service button.
- When the pop-up notifying service termination opens, click the Confirm button.
Integrate PrivateLink Service
The Queue Service can communicate directly with the PrivateLink Service without using internet communication. When integrated with PrivateLink Service, communication with the Queue Service occurs directly from the user’s VPC, enhancing security.
Creating and Connecting a PrivateLink Endpoint
Follow the steps below to integrate the Queue Service with the PrivateLink Service.
- Check the PrivateLink Service ID of the Queue Service for creating a PrivateLink Endpoint.
- The PrivateLink Service ID of the Queue Service can be found on the Queue Details page’s PrivateLink Service ID.
- Create a PrivateLink Endpoint.
- Refer to PrivateLink Endpoint 생성하기 for instructions on creating a PrivateLink Endpoint.
- When connecting a PrivateLink Service, usage approval is processed automatically.
- Check the Security Group of the PrivateLink Endpoint to verify whether the target VM IP is registered.