1. Packages
  2. Hsdp Provider
  3. API Docs
  4. DbsSqsSubscriber
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

hsdp.DbsSqsSubscriber

Explore with Pulumi AI

hsdp logo
hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software

    Manages Connect DBS SQS Subscriber configurations

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const my_subscriber = new hsdp.DbsSqsSubscriber("my-subscriber", {
        deliveryDelaySeconds: 0,
        description: "My subscriber",
        messageRetentionPeriodSeconds: 0,
        nameInfix: "my-subscriber",
        queueType: "Standard",
        receiveWaitTimeSeconds: 0,
        serverSideEncryption: true,
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    my_subscriber = hsdp.DbsSqsSubscriber("my-subscriber",
        delivery_delay_seconds=0,
        description="My subscriber",
        message_retention_period_seconds=0,
        name_infix="my-subscriber",
        queue_type="Standard",
        receive_wait_time_seconds=0,
        server_side_encryption=True)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/hsdp/hsdp"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := hsdp.NewDbsSqsSubscriber(ctx, "my-subscriber", &hsdp.DbsSqsSubscriberArgs{
    			DeliveryDelaySeconds:          pulumi.Float64(0),
    			Description:                   pulumi.String("My subscriber"),
    			MessageRetentionPeriodSeconds: pulumi.Float64(0),
    			NameInfix:                     pulumi.String("my-subscriber"),
    			QueueType:                     pulumi.String("Standard"),
    			ReceiveWaitTimeSeconds:        pulumi.Float64(0),
    			ServerSideEncryption:          pulumi.Bool(true),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Hsdp = Pulumi.Hsdp;
    
    return await Deployment.RunAsync(() => 
    {
        var my_subscriber = new Hsdp.DbsSqsSubscriber("my-subscriber", new()
        {
            DeliveryDelaySeconds = 0,
            Description = "My subscriber",
            MessageRetentionPeriodSeconds = 0,
            NameInfix = "my-subscriber",
            QueueType = "Standard",
            ReceiveWaitTimeSeconds = 0,
            ServerSideEncryption = true,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.DbsSqsSubscriber;
    import com.pulumi.hsdp.DbsSqsSubscriberArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var my_subscriber = new DbsSqsSubscriber("my-subscriber", DbsSqsSubscriberArgs.builder()
                .deliveryDelaySeconds(0)
                .description("My subscriber")
                .messageRetentionPeriodSeconds(0)
                .nameInfix("my-subscriber")
                .queueType("Standard")
                .receiveWaitTimeSeconds(0)
                .serverSideEncryption(true)
                .build());
    
        }
    }
    
    resources:
      my-subscriber:
        type: hsdp:DbsSqsSubscriber
        properties:
          deliveryDelaySeconds: 0
          description: My subscriber
          messageRetentionPeriodSeconds: 0
          nameInfix: my-subscriber
          queueType: Standard
          receiveWaitTimeSeconds: 0
          serverSideEncryption: true
    

    Attributes reference

    In addition to all arguments above, the following attributes are exported:

    • id - The ID reference of the subscriber (format: ${GUID})
    • name - The name of the subscriber
    • status - The status of the subscriber
    • queue_name - The name of the SQS queue

    Create DbsSqsSubscriber Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DbsSqsSubscriber(name: string, args: DbsSqsSubscriberArgs, opts?: CustomResourceOptions);
    @overload
    def DbsSqsSubscriber(resource_name: str,
                         args: DbsSqsSubscriberArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def DbsSqsSubscriber(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         description: Optional[str] = None,
                         name_infix: Optional[str] = None,
                         queue_type: Optional[str] = None,
                         dbs_sqs_subscriber_id: Optional[str] = None,
                         delivery_delay_seconds: Optional[float] = None,
                         message_retention_period_seconds: Optional[float] = None,
                         receive_wait_time_seconds: Optional[float] = None,
                         server_side_encryption: Optional[bool] = None)
    func NewDbsSqsSubscriber(ctx *Context, name string, args DbsSqsSubscriberArgs, opts ...ResourceOption) (*DbsSqsSubscriber, error)
    public DbsSqsSubscriber(string name, DbsSqsSubscriberArgs args, CustomResourceOptions? opts = null)
    public DbsSqsSubscriber(String name, DbsSqsSubscriberArgs args)
    public DbsSqsSubscriber(String name, DbsSqsSubscriberArgs args, CustomResourceOptions options)
    
    type: hsdp:DbsSqsSubscriber
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DbsSqsSubscriberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DbsSqsSubscriberArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DbsSqsSubscriberArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DbsSqsSubscriberArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DbsSqsSubscriberArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dbsSqsSubscriberResource = new Hsdp.DbsSqsSubscriber("dbsSqsSubscriberResource", new()
    {
        Description = "string",
        NameInfix = "string",
        QueueType = "string",
        DbsSqsSubscriberId = "string",
        DeliveryDelaySeconds = 0,
        MessageRetentionPeriodSeconds = 0,
        ReceiveWaitTimeSeconds = 0,
        ServerSideEncryption = false,
    });
    
    example, err := hsdp.NewDbsSqsSubscriber(ctx, "dbsSqsSubscriberResource", &hsdp.DbsSqsSubscriberArgs{
    	Description:                   pulumi.String("string"),
    	NameInfix:                     pulumi.String("string"),
    	QueueType:                     pulumi.String("string"),
    	DbsSqsSubscriberId:            pulumi.String("string"),
    	DeliveryDelaySeconds:          pulumi.Float64(0),
    	MessageRetentionPeriodSeconds: pulumi.Float64(0),
    	ReceiveWaitTimeSeconds:        pulumi.Float64(0),
    	ServerSideEncryption:          pulumi.Bool(false),
    })
    
    var dbsSqsSubscriberResource = new DbsSqsSubscriber("dbsSqsSubscriberResource", DbsSqsSubscriberArgs.builder()
        .description("string")
        .nameInfix("string")
        .queueType("string")
        .dbsSqsSubscriberId("string")
        .deliveryDelaySeconds(0)
        .messageRetentionPeriodSeconds(0)
        .receiveWaitTimeSeconds(0)
        .serverSideEncryption(false)
        .build());
    
    dbs_sqs_subscriber_resource = hsdp.DbsSqsSubscriber("dbsSqsSubscriberResource",
        description="string",
        name_infix="string",
        queue_type="string",
        dbs_sqs_subscriber_id="string",
        delivery_delay_seconds=0,
        message_retention_period_seconds=0,
        receive_wait_time_seconds=0,
        server_side_encryption=False)
    
    const dbsSqsSubscriberResource = new hsdp.DbsSqsSubscriber("dbsSqsSubscriberResource", {
        description: "string",
        nameInfix: "string",
        queueType: "string",
        dbsSqsSubscriberId: "string",
        deliveryDelaySeconds: 0,
        messageRetentionPeriodSeconds: 0,
        receiveWaitTimeSeconds: 0,
        serverSideEncryption: false,
    });
    
    type: hsdp:DbsSqsSubscriber
    properties:
        dbsSqsSubscriberId: string
        deliveryDelaySeconds: 0
        description: string
        messageRetentionPeriodSeconds: 0
        nameInfix: string
        queueType: string
        receiveWaitTimeSeconds: 0
        serverSideEncryption: false
    

    DbsSqsSubscriber Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The DbsSqsSubscriber resource accepts the following input properties:

    Description string
    A short description of the subscriber
    NameInfix string
    The name infix of the subscriber
    QueueType string
    The type of queue to create [Standard | FIFO]
    DbsSqsSubscriberId string
    DeliveryDelaySeconds double
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    MessageRetentionPeriodSeconds double
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    ReceiveWaitTimeSeconds double
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    ServerSideEncryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    Description string
    A short description of the subscriber
    NameInfix string
    The name infix of the subscriber
    QueueType string
    The type of queue to create [Standard | FIFO]
    DbsSqsSubscriberId string
    DeliveryDelaySeconds float64
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    MessageRetentionPeriodSeconds float64
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    ReceiveWaitTimeSeconds float64
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    ServerSideEncryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    description String
    A short description of the subscriber
    nameInfix String
    The name infix of the subscriber
    queueType String
    The type of queue to create [Standard | FIFO]
    dbsSqsSubscriberId String
    deliveryDelaySeconds Double
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    messageRetentionPeriodSeconds Double
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    receiveWaitTimeSeconds Double
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption Boolean
    Boolean designating whether to enable server-side encryption. Default is true
    description string
    A short description of the subscriber
    nameInfix string
    The name infix of the subscriber
    queueType string
    The type of queue to create [Standard | FIFO]
    dbsSqsSubscriberId string
    deliveryDelaySeconds number
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    messageRetentionPeriodSeconds number
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    receiveWaitTimeSeconds number
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption boolean
    Boolean designating whether to enable server-side encryption. Default is true
    description str
    A short description of the subscriber
    name_infix str
    The name infix of the subscriber
    queue_type str
    The type of queue to create [Standard | FIFO]
    dbs_sqs_subscriber_id str
    delivery_delay_seconds float
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    message_retention_period_seconds float
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    receive_wait_time_seconds float
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    server_side_encryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    description String
    A short description of the subscriber
    nameInfix String
    The name infix of the subscriber
    queueType String
    The type of queue to create [Standard | FIFO]
    dbsSqsSubscriberId String
    deliveryDelaySeconds Number
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    messageRetentionPeriodSeconds Number
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    receiveWaitTimeSeconds Number
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption Boolean
    Boolean designating whether to enable server-side encryption. Default is true

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DbsSqsSubscriber resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    QueueName string
    Status string
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    QueueName string
    Status string
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    queueName String
    status String
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    queueName string
    status string
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    queue_name str
    status str
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    queueName String
    status String

    Look up Existing DbsSqsSubscriber Resource

    Get an existing DbsSqsSubscriber resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DbsSqsSubscriberState, opts?: CustomResourceOptions): DbsSqsSubscriber
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            dbs_sqs_subscriber_id: Optional[str] = None,
            delivery_delay_seconds: Optional[float] = None,
            description: Optional[str] = None,
            message_retention_period_seconds: Optional[float] = None,
            name: Optional[str] = None,
            name_infix: Optional[str] = None,
            queue_name: Optional[str] = None,
            queue_type: Optional[str] = None,
            receive_wait_time_seconds: Optional[float] = None,
            server_side_encryption: Optional[bool] = None,
            status: Optional[str] = None) -> DbsSqsSubscriber
    func GetDbsSqsSubscriber(ctx *Context, name string, id IDInput, state *DbsSqsSubscriberState, opts ...ResourceOption) (*DbsSqsSubscriber, error)
    public static DbsSqsSubscriber Get(string name, Input<string> id, DbsSqsSubscriberState? state, CustomResourceOptions? opts = null)
    public static DbsSqsSubscriber get(String name, Output<String> id, DbsSqsSubscriberState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:DbsSqsSubscriber    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DbsSqsSubscriberId string
    DeliveryDelaySeconds double
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    Description string
    A short description of the subscriber
    MessageRetentionPeriodSeconds double
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    Name string
    NameInfix string
    The name infix of the subscriber
    QueueName string
    QueueType string
    The type of queue to create [Standard | FIFO]
    ReceiveWaitTimeSeconds double
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    ServerSideEncryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    Status string
    DbsSqsSubscriberId string
    DeliveryDelaySeconds float64
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    Description string
    A short description of the subscriber
    MessageRetentionPeriodSeconds float64
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    Name string
    NameInfix string
    The name infix of the subscriber
    QueueName string
    QueueType string
    The type of queue to create [Standard | FIFO]
    ReceiveWaitTimeSeconds float64
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    ServerSideEncryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    Status string
    dbsSqsSubscriberId String
    deliveryDelaySeconds Double
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    description String
    A short description of the subscriber
    messageRetentionPeriodSeconds Double
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    name String
    nameInfix String
    The name infix of the subscriber
    queueName String
    queueType String
    The type of queue to create [Standard | FIFO]
    receiveWaitTimeSeconds Double
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption Boolean
    Boolean designating whether to enable server-side encryption. Default is true
    status String
    dbsSqsSubscriberId string
    deliveryDelaySeconds number
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    description string
    A short description of the subscriber
    messageRetentionPeriodSeconds number
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    name string
    nameInfix string
    The name infix of the subscriber
    queueName string
    queueType string
    The type of queue to create [Standard | FIFO]
    receiveWaitTimeSeconds number
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption boolean
    Boolean designating whether to enable server-side encryption. Default is true
    status string
    dbs_sqs_subscriber_id str
    delivery_delay_seconds float
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    description str
    A short description of the subscriber
    message_retention_period_seconds float
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    name str
    name_infix str
    The name infix of the subscriber
    queue_name str
    queue_type str
    The type of queue to create [Standard | FIFO]
    receive_wait_time_seconds float
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    server_side_encryption bool
    Boolean designating whether to enable server-side encryption. Default is true
    status str
    dbsSqsSubscriberId String
    deliveryDelaySeconds Number
    The time in seconds that the delivery of all messages in the queue will be delayed. An integer from 0 to 900 (15 minutes). The default is 0 (zero).
    description String
    A short description of the subscriber
    messageRetentionPeriodSeconds Number
    The number of seconds Amazon SQS retains a message. Integer representing seconds, from 60 (1 minute) to 1209600 (14 days). The default is 345600 (4 days).
    name String
    nameInfix String
    The name infix of the subscriber
    queueName String
    queueType String
    The type of queue to create [Standard | FIFO]
    receiveWaitTimeSeconds Number
    The time for which a ReceiveMessage call will wait for a message to arrive (long polling) before returning. An integer from 0 to 20 (seconds). The default is 0 (zero).
    serverSideEncryption Boolean
    Boolean designating whether to enable server-side encryption. Default is true
    status String

    Import

    $ pulumi import hsdp:index/dbsSqsSubscriber:DbsSqsSubscriber An existing SQS Subscriber using `hsdp_dbs_sqs_subscriber`, e.g.
    

    bash

    $ pulumi import hsdp:index/dbsSqsSubscriber:DbsSqsSubscriber target guid-of-the-subscriber-to-import
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    hsdp philips-software/terraform-provider-hsdp
    License
    Notes
    This Pulumi package is based on the hsdp Terraform Provider.
    hsdp logo
    hsdp 0.65.3 published on Tuesday, Apr 15, 2025 by philips-software