This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

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.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of the Queue Service.

    2. On the Service Home page, click the Create Queue button. 2. Go to the Create Queue page.

    3. On the 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
        Detailed description
        typeRequiredSelect service type
        • Default: No message ordering
        • FIFO: First-in-first-out message delivery and message retention
        Queue nameRequiredEnter the queue name
        • Start with a lowercase English letter and enter 3 ~ 64 characters consisting of lowercase English letters, numbers, and the special character (-)
        • Standard type: The name cannot use the ‘.fifo’ suffix
        • FIFO type: Include the .fifo suffix in the name
          • Start with a lowercase English letter
          • Enter 3 ~ 64 characters using lowercase English letters and the special character (-)
        Duplicate removal rangeEssentialSelect duplicate removal scope
        • Messages in queue: Remove duplicate items among messages in the queue
        • Group-level messages: Remove duplicate items within group-level messages
        • FIFO can be set only when the FIFO type is selected
        Content-based deduplicationSelectionHash the message body content to remove duplicate messages
        • FIFO can be set only when the FIFO type is selected
        ExplanationSelectEnter the service description within 100 characters.
        Table. Create Queue – Enter Service Information
      • Enter or select the required information in the configuration settings area.
        Category
        Required status
        Detailed description
        Message sizeEssentialEnter the message size value (KB) between 1 and 256
        • Up to 50 can be added per resource
        Message retention periodEssentialEnter the message retention period
        • After selecting the unit, enter the desired value
          • seconds: 60 ~ 1,209,600
          • minutes: 1 ~ 20,160
          • hours: 1 ~ 336
          • days: 1 ~ 14
        EncryptionRequiredSelect encryption usage
        • New creation: Go to the KMS page and 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
        Table. Queue creation - configuration setting items
      • Enter or select the required information in the additional information input area.
        Category
        Required
        Detailed description
        TagSelectionAdd 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
    4. Summary Verify the detailed information and estimated charges generated in the panel, then click the Create button.

      • Once creation is complete, check the resources you created on the page.
    Caution
    Queue is billed based on usage.
    Reference
    • When using a FIFO type Queue, up to 100 message groups are supported.
    • If the maximum number of message groups is exceeded, message transmission may fail.

    View Queue Service details

    You can view detailed information and messages for the Queue Service.
    To view detailed information about the Queue Service, follow these steps.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue List page.
    3. On the Queue list page, click the resource to view detailed information. 3. Navigate to the Queue Details page.
      • Queue Details page displays status information and additional feature information, and consists of Details, Message Management, Tags, Job History tabs.
        CategoryDetailed description
        Queue Service statusQueue Service status representation
        • Creating: In progress
        • Available: Creation completed, server connection available
        • Deleting: Service termination in progress
        • Error Deleting: Abnormal state during deletion
        • Inactive: Abnormal state
        • Error: Abnormal state during creation
        Service terminationService cancellation button
        Table. Queue Service status information and additional features

    Detailed Information

    On the Queue list page, you can view detailed information of the selected resource and, if necessary, edit the information.

    CategoryDetailed description
    serviceService name
    Resource TypeResource Type
    SRNUnique resource ID in Samsung Cloud Platform
    • In Queue Service, it refers to the resource SRN
    Resource nameResource name
    • In Queue Service, it refers to the Queue name
    Resource IDService’s unique resource ID
    ConstructorUser who created the service
    Creation date and timeService creation date and time
    ModifierUser who modified the service
    Modification dateService modification date and time
    typeQueue type
    Duplicate removal rangeDeduplication Scope
    • Messages in Queue: Remove duplicate items among messages in the queue
    • Group-level Messages: Remove duplicate items within group-level messages
    • Edit button can be clicked to change the scope
    • FIFO type is displayed only when used
    Content-based duplicate removalWhether to use content-based duplicate removal feature
    • When enabled, hash the message body content to remove duplicate messages
    • Displayed only when using FIFO type
    • You can change the usage by clicking the Edit button
    Configuration SettingsQueue configuration information
    • Displays the message size, retention period, and whether encryption is used
      • When KMS encryption is used, displays Data Key reuse period
      • Click the Edit button to modify
    PrivateLink Service IDPrivateLink service ID
    ExplanationQueue description
    • Edit Click the button to edit
    IP access allowlistList of IPs allowed to access the Queue service
    • Add IP Address button can be clicked to register a new IP
    • After selecting an IP Address registered in the list, Delete button can be clicked to remove it
    • Up to 150 IP Addresses can be added
    Table. Queue Details - Detail Tab Items

    Message Management

    On the Queue list page, you can view and manage the message list of the selected resource.

    Reference
    • A maximum of 10 messages will be displayed.
    • 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.
    CategoryDetailed description
    Message pollingAfter polling messages from the Queue to the Console, refresh the message list.
    MoreMessage sending, deletion, and removal possible
    • Message Send: Send a new message
    • Delete: Delete the selected message from the message list
    • Clear Queue: Delete all messages in the Queue
    Message ListMessage ID, message send timestamp, message receive timestamp, and message size (byte) can be viewed
    • Click the Message ID to view the message body and metadata
    • Delete button can be clicked to delete the message
    Table. Queue Details – Message Management Tab Items

    Tag

    Queue List page lets you view the tag information of the selected resource, and you can add, modify, or delete it.

    CategoryDetailed description
    Tag listTag list
    • You can view the tag’s Key, Value information
    • Up to 50 tags can be added per resource
    • When entering tags, search the existing list of created Keys and Values and select
    Table. Queue Details - Tag Tab Items

    Operation History

    You can view the operation history of the selected resource on the Queuee list page.

    CategoryDetailed description
    Task History ListResource Change History
    • Operation timestamp, resource type, resource ID, resource name, operation details, event topic, operation result, operator information verification
    Table. Queue Details - Job History Tab Items

    Configure Queue

    You can reconfigure the settings you specified when creating the Queue Service.
    To reconfigure the Queue, follow these steps.

    1. All Services > Application > Queue Service Click the menu. 1. Go to the Service Home page of the Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue List page, click the resource to reconfigure the Queue. 3. Go to the Queue Details page.
    4. Click the Edit button of the Configuration Settings item. 4. Configuration Settings Edit The popup window opens.
    5. Edit Configuration Settings In the popup window, edit the configuration information, then click the OK button.
      Category
      Required status
      Detailed description
      Message sizeEssentialEnter the message size value (KB) between 1 and 256
      • Up to 50 can be added per resource
      Message retention periodEssentialEnter the message retention period
      • After selecting the unit, enter the desired value
        • seconds: 60 ~ 1,209,600
        • minutes: 1 ~ 20,160
        • hours: 1 ~ 336
        • days: 1 ~ 14
      EncryptionEssentialSelect encryption usage
      • Create new: 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: Select a unit period and then enter the desired value
          • minutes: 5 ~ 1,440
          • hours: 1 ~ 24
      Table. Queue configuration setting edit input 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.

    1. All Services > Application > Queue Service Click the menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue List page, click the resource to add an allowed IP. 3. Go to the Queue Details page.
    4. Click the Add IP Address button of the IP Access Allow List item. 4. Add IP Address The popup window opens.
    5. Enter the IP to add to the IP Access Allow List, then click the Confirm button.
      • Click the + button to add multiple IPs simultaneously (up to 10).
    6. When the popup that notifies an IP addition opens, click the Confirm button.
    Reference
    You can add up to 150 IP addresses.

    Exclude accessible IP

    To exclude the IPs registered in IP access allow list, follow these steps.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue List page.
    3. On the Queue list page, click the resource to exclude the allowed IP. 3. Go to the Queue Details page.
    4. After selecting the IPs to exclude from the IP Access Allow List, click the Delete button at the top of the list.
      • You can also individually exclude an IP from the IP Access Allow List by clicking its Delete button.
    5. 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 these steps.

    1. All Services > Application > Queue Service Click the menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue List page, click the resource to send a Queue message. 3. Queue Details Go to the page.
    4. Click the Message Management tab on the Queue Details page.
    5. Click the More > Send Message button at the top of the message list. 5. Send Message popup window opens.
    6. Send Message After entering the message information to be sent in the popup window, click the Confirm button.
      Category
      Whether required
      Detailed description
      Message bodyEssentialEnter the message to send
      • Up to 262,244 bytes can be entered
      Message Group IDRequiredEnter using letters, numbers, and special characters within 128 characters
      • FIFO displayed only when using the FIFO type
      Message deduplication IDRequired/OptionalEnter within 128 characters using letters, numbers, and special characters
      • FIFO type is displayed only when used
      • When using the Content-based deduplication feature, input is optional
      Meta informationSelectionSelect whether to use meta information to add to the message
      • When used, you can enter up to 10 Key, Value entries
      EncryptionEssentialSelect encryption usage
      • Create new: 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: Select a unit period and then enter the desired value
          • minutes: 5 ~ 1,440
          • hours: 1 ~ 24
      Table. Message sending input fields

    Check message details

    You can view the content and detailed information of the Queue message. To view the detailed message information, follow these steps.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue List page.
    3. On the Queue list page, click the resource to view the Queue messages. 3. Go to the Queue Details page.
    4. Click the Message Management tab on the Queue Details page.
    5. Click the message ID to view detailed information in the message list. 5. Message Details The popup window opens.
      CategoryDetailed description
      Message IDMessage unique ID
      Message sizeMessage size
      Message transmission timestampMessage transmission date and time
      Message Received Date/TimeMessage receipt date and time
      Message Group IDMessage group ID
      • displayed only when the FIFO type is used
      Message deduplication IDDeduplication ID set in the message
      • is displayed only when using the FIFO type
      Message bodymessage content
      Meta definitionMessage meta information (Key, Value)
      Table. Message detail information items

    Delete individual messages

    Queue messages can be deleted individually. To delete a message, follow these steps.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of the Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue List page, click the resource to delete the Queue message. 3. Queue Details page is opened.
    4. Click the Message Management tab on the Queue Details page.
    5. After selecting all messages to delete in 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 delete in the message list.
    6. When the popup notifying message deletion opens, click the Confirm button.

    Clear all messages in the queue

    You can delete all messages in the Queue by emptying the Queue.

    Caution
    • Messages deleted via Empty Queue cannot be recovered.
    • If the same request is already in progress, it will not be deleted. * In a moment, clear the queue again.

    To delete all messages, follow the steps below.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue List page, click the resource to remove the Queue message. 3. Go to the Queue Details page.
    4. Click the Message Management tab on the Queue Details page.
    5. Click the More > Clear Queue button at the top of the message list.
    6. When the popup notifying message deletion opens, click the Confirm button.

    Cancel Queue Service

    You can reduce operating costs by terminating the unused Queue Service.
    However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may occur when the service is discontinued.

    Caution
    All messages are deleted upon termination and cannot be recovered.

    To cancel the Queue Service, follow these steps.

    1. Click the All Services > Application > Queue Service menu. 1. Go to the Service Home page of Queue Service.
    2. On the Service Home page, click the Queue menu. 2. Go to the Queue list page.
    3. On the Queue list page, select the resource to cancel, then 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.
    4. When the pop-up notifying service termination opens, click the Confirm button.

    Integrating PrivateLink Service

    The Queue Service can communicate directly by integrating 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.

    Follow the steps below to integrate the Queue Service with the PrivateLink Service.

    1. 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.
    2. Create a PrivateLink Endpoint.
    Reference
    • When connecting to 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.
    Caution
    When connecting through a PrivateLink Endpoint, IAM policies and IP access control for the authentication key cannot be used.