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

hsdp.NotificationSubscription

Explore with Pulumi AI

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

    Create and manage HSDP Notification subscription resources

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as hsdp from "@pulumi/hsdp";
    
    const subscription = new hsdp.NotificationSubscription("subscription", {
        subscriberId: "4e2546a3-b162-47d1-8014-c89148def43f",
        subscriptionEndpoint: "https://ns-client-logdev.cloud.pcftest.com/core/notification/Message",
        topicId: "ca1e3aa4-1409-4b1b-95e5-8795ecdecea7",
    });
    
    import pulumi
    import pulumi_hsdp as hsdp
    
    subscription = hsdp.NotificationSubscription("subscription",
        subscriber_id="4e2546a3-b162-47d1-8014-c89148def43f",
        subscription_endpoint="https://ns-client-logdev.cloud.pcftest.com/core/notification/Message",
        topic_id="ca1e3aa4-1409-4b1b-95e5-8795ecdecea7")
    
    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.NewNotificationSubscription(ctx, "subscription", &hsdp.NotificationSubscriptionArgs{
    			SubscriberId:         pulumi.String("4e2546a3-b162-47d1-8014-c89148def43f"),
    			SubscriptionEndpoint: pulumi.String("https://ns-client-logdev.cloud.pcftest.com/core/notification/Message"),
    			TopicId:              pulumi.String("ca1e3aa4-1409-4b1b-95e5-8795ecdecea7"),
    		})
    		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 subscription = new Hsdp.NotificationSubscription("subscription", new()
        {
            SubscriberId = "4e2546a3-b162-47d1-8014-c89148def43f",
            SubscriptionEndpoint = "https://ns-client-logdev.cloud.pcftest.com/core/notification/Message",
            TopicId = "ca1e3aa4-1409-4b1b-95e5-8795ecdecea7",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.hsdp.NotificationSubscription;
    import com.pulumi.hsdp.NotificationSubscriptionArgs;
    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 subscription = new NotificationSubscription("subscription", NotificationSubscriptionArgs.builder()
                .subscriberId("4e2546a3-b162-47d1-8014-c89148def43f")
                .subscriptionEndpoint("https://ns-client-logdev.cloud.pcftest.com/core/notification/Message")
                .topicId("ca1e3aa4-1409-4b1b-95e5-8795ecdecea7")
                .build());
    
        }
    }
    
    resources:
      subscription:
        type: hsdp:NotificationSubscription
        properties:
          subscriberId: 4e2546a3-b162-47d1-8014-c89148def43f
          subscriptionEndpoint: https://ns-client-logdev.cloud.pcftest.com/core/notification/Message
          topicId: ca1e3aa4-1409-4b1b-95e5-8795ecdecea7
    

    Create NotificationSubscription Resource

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

    Constructor syntax

    new NotificationSubscription(name: string, args: NotificationSubscriptionArgs, opts?: CustomResourceOptions);
    @overload
    def NotificationSubscription(resource_name: str,
                                 args: NotificationSubscriptionArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def NotificationSubscription(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 subscriber_id: Optional[str] = None,
                                 topic_id: Optional[str] = None,
                                 notification_subscription_id: Optional[str] = None,
                                 principal: Optional[NotificationSubscriptionPrincipalArgs] = None,
                                 soft_delete: Optional[bool] = None,
                                 subscription_endpoint: Optional[str] = None)
    func NewNotificationSubscription(ctx *Context, name string, args NotificationSubscriptionArgs, opts ...ResourceOption) (*NotificationSubscription, error)
    public NotificationSubscription(string name, NotificationSubscriptionArgs args, CustomResourceOptions? opts = null)
    public NotificationSubscription(String name, NotificationSubscriptionArgs args)
    public NotificationSubscription(String name, NotificationSubscriptionArgs args, CustomResourceOptions options)
    
    type: hsdp:NotificationSubscription
    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 NotificationSubscriptionArgs
    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 NotificationSubscriptionArgs
    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 NotificationSubscriptionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationSubscriptionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationSubscriptionArgs
    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 notificationSubscriptionResource = new Hsdp.NotificationSubscription("notificationSubscriptionResource", new()
    {
        SubscriberId = "string",
        TopicId = "string",
        NotificationSubscriptionId = "string",
        Principal = new Hsdp.Inputs.NotificationSubscriptionPrincipalArgs
        {
            Endpoint = "string",
            Environment = "string",
            Oauth2ClientId = "string",
            Oauth2Password = "string",
            Password = "string",
            Region = "string",
            ServiceId = "string",
            ServicePrivateKey = "string",
            UaaPassword = "string",
            UaaUsername = "string",
            Username = "string",
        },
        SoftDelete = false,
        SubscriptionEndpoint = "string",
    });
    
    example, err := hsdp.NewNotificationSubscription(ctx, "notificationSubscriptionResource", &hsdp.NotificationSubscriptionArgs{
    	SubscriberId:               pulumi.String("string"),
    	TopicId:                    pulumi.String("string"),
    	NotificationSubscriptionId: pulumi.String("string"),
    	Principal: &hsdp.NotificationSubscriptionPrincipalArgs{
    		Endpoint:          pulumi.String("string"),
    		Environment:       pulumi.String("string"),
    		Oauth2ClientId:    pulumi.String("string"),
    		Oauth2Password:    pulumi.String("string"),
    		Password:          pulumi.String("string"),
    		Region:            pulumi.String("string"),
    		ServiceId:         pulumi.String("string"),
    		ServicePrivateKey: pulumi.String("string"),
    		UaaPassword:       pulumi.String("string"),
    		UaaUsername:       pulumi.String("string"),
    		Username:          pulumi.String("string"),
    	},
    	SoftDelete:           pulumi.Bool(false),
    	SubscriptionEndpoint: pulumi.String("string"),
    })
    
    var notificationSubscriptionResource = new NotificationSubscription("notificationSubscriptionResource", NotificationSubscriptionArgs.builder()
        .subscriberId("string")
        .topicId("string")
        .notificationSubscriptionId("string")
        .principal(NotificationSubscriptionPrincipalArgs.builder()
            .endpoint("string")
            .environment("string")
            .oauth2ClientId("string")
            .oauth2Password("string")
            .password("string")
            .region("string")
            .serviceId("string")
            .servicePrivateKey("string")
            .uaaPassword("string")
            .uaaUsername("string")
            .username("string")
            .build())
        .softDelete(false)
        .subscriptionEndpoint("string")
        .build());
    
    notification_subscription_resource = hsdp.NotificationSubscription("notificationSubscriptionResource",
        subscriber_id="string",
        topic_id="string",
        notification_subscription_id="string",
        principal={
            "endpoint": "string",
            "environment": "string",
            "oauth2_client_id": "string",
            "oauth2_password": "string",
            "password": "string",
            "region": "string",
            "service_id": "string",
            "service_private_key": "string",
            "uaa_password": "string",
            "uaa_username": "string",
            "username": "string",
        },
        soft_delete=False,
        subscription_endpoint="string")
    
    const notificationSubscriptionResource = new hsdp.NotificationSubscription("notificationSubscriptionResource", {
        subscriberId: "string",
        topicId: "string",
        notificationSubscriptionId: "string",
        principal: {
            endpoint: "string",
            environment: "string",
            oauth2ClientId: "string",
            oauth2Password: "string",
            password: "string",
            region: "string",
            serviceId: "string",
            servicePrivateKey: "string",
            uaaPassword: "string",
            uaaUsername: "string",
            username: "string",
        },
        softDelete: false,
        subscriptionEndpoint: "string",
    });
    
    type: hsdp:NotificationSubscription
    properties:
        notificationSubscriptionId: string
        principal:
            endpoint: string
            environment: string
            oauth2ClientId: string
            oauth2Password: string
            password: string
            region: string
            serviceId: string
            servicePrivateKey: string
            uaaPassword: string
            uaaUsername: string
            username: string
        softDelete: false
        subscriberId: string
        subscriptionEndpoint: string
        topicId: string
    

    NotificationSubscription 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 NotificationSubscription resource accepts the following input properties:

    SubscriberId string
    The UUID of the subscriber
    TopicId string
    The UUID of the topic
    NotificationSubscriptionId string
    The subscription ID
    Principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    SoftDelete bool
    SubscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    SubscriberId string
    The UUID of the subscriber
    TopicId string
    The UUID of the topic
    NotificationSubscriptionId string
    The subscription ID
    Principal NotificationSubscriptionPrincipalArgs
    The optional principal to use for this resource
    SoftDelete bool
    SubscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    subscriberId String
    The UUID of the subscriber
    topicId String
    The UUID of the topic
    notificationSubscriptionId String
    The subscription ID
    principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    softDelete Boolean
    subscriptionEndpoint String
    The subscription endpoint. Only https protocol is allowed
    subscriberId string
    The UUID of the subscriber
    topicId string
    The UUID of the topic
    notificationSubscriptionId string
    The subscription ID
    principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    softDelete boolean
    subscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    subscriber_id str
    The UUID of the subscriber
    topic_id str
    The UUID of the topic
    notification_subscription_id str
    The subscription ID
    principal NotificationSubscriptionPrincipalArgs
    The optional principal to use for this resource
    soft_delete bool
    subscription_endpoint str
    The subscription endpoint. Only https protocol is allowed
    subscriberId String
    The UUID of the subscriber
    topicId String
    The UUID of the topic
    notificationSubscriptionId String
    The subscription ID
    principal Property Map
    The optional principal to use for this resource
    softDelete Boolean
    subscriptionEndpoint String
    The subscription endpoint. Only https protocol is allowed

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing NotificationSubscription Resource

    Get an existing NotificationSubscription 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?: NotificationSubscriptionState, opts?: CustomResourceOptions): NotificationSubscription
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            notification_subscription_id: Optional[str] = None,
            principal: Optional[NotificationSubscriptionPrincipalArgs] = None,
            soft_delete: Optional[bool] = None,
            subscriber_id: Optional[str] = None,
            subscription_endpoint: Optional[str] = None,
            topic_id: Optional[str] = None) -> NotificationSubscription
    func GetNotificationSubscription(ctx *Context, name string, id IDInput, state *NotificationSubscriptionState, opts ...ResourceOption) (*NotificationSubscription, error)
    public static NotificationSubscription Get(string name, Input<string> id, NotificationSubscriptionState? state, CustomResourceOptions? opts = null)
    public static NotificationSubscription get(String name, Output<String> id, NotificationSubscriptionState state, CustomResourceOptions options)
    resources:  _:    type: hsdp:NotificationSubscription    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:
    NotificationSubscriptionId string
    The subscription ID
    Principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    SoftDelete bool
    SubscriberId string
    The UUID of the subscriber
    SubscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    TopicId string
    The UUID of the topic
    NotificationSubscriptionId string
    The subscription ID
    Principal NotificationSubscriptionPrincipalArgs
    The optional principal to use for this resource
    SoftDelete bool
    SubscriberId string
    The UUID of the subscriber
    SubscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    TopicId string
    The UUID of the topic
    notificationSubscriptionId String
    The subscription ID
    principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    softDelete Boolean
    subscriberId String
    The UUID of the subscriber
    subscriptionEndpoint String
    The subscription endpoint. Only https protocol is allowed
    topicId String
    The UUID of the topic
    notificationSubscriptionId string
    The subscription ID
    principal NotificationSubscriptionPrincipal
    The optional principal to use for this resource
    softDelete boolean
    subscriberId string
    The UUID of the subscriber
    subscriptionEndpoint string
    The subscription endpoint. Only https protocol is allowed
    topicId string
    The UUID of the topic
    notification_subscription_id str
    The subscription ID
    principal NotificationSubscriptionPrincipalArgs
    The optional principal to use for this resource
    soft_delete bool
    subscriber_id str
    The UUID of the subscriber
    subscription_endpoint str
    The subscription endpoint. Only https protocol is allowed
    topic_id str
    The UUID of the topic
    notificationSubscriptionId String
    The subscription ID
    principal Property Map
    The optional principal to use for this resource
    softDelete Boolean
    subscriberId String
    The UUID of the subscriber
    subscriptionEndpoint String
    The subscription endpoint. Only https protocol is allowed
    topicId String
    The UUID of the topic

    Supporting Types

    NotificationSubscriptionPrincipal, NotificationSubscriptionPrincipalArgs

    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Environment to use. When not set, the provider config is used
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    The IAM service ID
    ServicePrivateKey string
    The IAM service private key to use
    UaaPassword string
    UaaUsername string
    Username string
    Endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    Environment string
    Environment to use. When not set, the provider config is used
    Oauth2ClientId string
    Oauth2Password string
    Password string
    Region string
    Region to use. When not set, the provider config is used
    ServiceId string
    The IAM service ID
    ServicePrivateKey string
    The IAM service private key to use
    UaaPassword string
    UaaUsername string
    Username string
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    Environment to use. When not set, the provider config is used
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    The IAM service ID
    servicePrivateKey String
    The IAM service private key to use
    uaaPassword String
    uaaUsername String
    username String
    endpoint string
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment string
    Environment to use. When not set, the provider config is used
    oauth2ClientId string
    oauth2Password string
    password string
    region string
    Region to use. When not set, the provider config is used
    serviceId string
    The IAM service ID
    servicePrivateKey string
    The IAM service private key to use
    uaaPassword string
    uaaUsername string
    username string
    endpoint str
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment str
    Environment to use. When not set, the provider config is used
    oauth2_client_id str
    oauth2_password str
    password str
    region str
    Region to use. When not set, the provider config is used
    service_id str
    The IAM service ID
    service_private_key str
    The IAM service private key to use
    uaa_password str
    uaa_username str
    username str
    endpoint String
    The endpoint URL to use if applicable. When not set, the provider config is used
    environment String
    Environment to use. When not set, the provider config is used
    oauth2ClientId String
    oauth2Password String
    password String
    region String
    Region to use. When not set, the provider config is used
    serviceId String
    The IAM service ID
    servicePrivateKey String
    The IAM service private key to use
    uaaPassword String
    uaaUsername String
    username String

    Import

    ing

    Importing a HSDP Notification subscription is supported.

    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