1. Packages
  2. AWS
  3. API Docs
  4. notifications
  5. NotificationHub
AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi

aws.notifications.NotificationHub

Explore with Pulumi AI

aws logo
AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi

    Resource for managing an AWS User Notifications Notification Hub.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.notifications.NotificationHub("example", {notificationHubRegion: "us-west-2"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.notifications.NotificationHub("example", notification_hub_region="us-west-2")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/notifications"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := notifications.NewNotificationHub(ctx, "example", &notifications.NotificationHubArgs{
    			NotificationHubRegion: pulumi.String("us-west-2"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.Notifications.NotificationHub("example", new()
        {
            NotificationHubRegion = "us-west-2",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.notifications.NotificationHub;
    import com.pulumi.aws.notifications.NotificationHubArgs;
    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 example = new NotificationHub("example", NotificationHubArgs.builder()
                .notificationHubRegion("us-west-2")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:notifications:NotificationHub
        properties:
          notificationHubRegion: us-west-2
    

    Create NotificationHub Resource

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

    Constructor syntax

    new NotificationHub(name: string, args: NotificationHubArgs, opts?: CustomResourceOptions);
    @overload
    def NotificationHub(resource_name: str,
                        args: NotificationHubArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def NotificationHub(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        notification_hub_region: Optional[str] = None,
                        timeouts: Optional[NotificationHubTimeoutsArgs] = None)
    func NewNotificationHub(ctx *Context, name string, args NotificationHubArgs, opts ...ResourceOption) (*NotificationHub, error)
    public NotificationHub(string name, NotificationHubArgs args, CustomResourceOptions? opts = null)
    public NotificationHub(String name, NotificationHubArgs args)
    public NotificationHub(String name, NotificationHubArgs args, CustomResourceOptions options)
    
    type: aws:notifications:NotificationHub
    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 NotificationHubArgs
    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 NotificationHubArgs
    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 NotificationHubArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NotificationHubArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NotificationHubArgs
    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 notificationHubResource = new Aws.Notifications.NotificationHub("notificationHubResource", new()
    {
        NotificationHubRegion = "string",
        Timeouts = new Aws.Notifications.Inputs.NotificationHubTimeoutsArgs
        {
            Create = "string",
            Delete = "string",
        },
    });
    
    example, err := notifications.NewNotificationHub(ctx, "notificationHubResource", &notifications.NotificationHubArgs{
    	NotificationHubRegion: pulumi.String("string"),
    	Timeouts: &notifications.NotificationHubTimeoutsArgs{
    		Create: pulumi.String("string"),
    		Delete: pulumi.String("string"),
    	},
    })
    
    var notificationHubResource = new NotificationHub("notificationHubResource", NotificationHubArgs.builder()
        .notificationHubRegion("string")
        .timeouts(NotificationHubTimeoutsArgs.builder()
            .create("string")
            .delete("string")
            .build())
        .build());
    
    notification_hub_resource = aws.notifications.NotificationHub("notificationHubResource",
        notification_hub_region="string",
        timeouts={
            "create": "string",
            "delete": "string",
        })
    
    const notificationHubResource = new aws.notifications.NotificationHub("notificationHubResource", {
        notificationHubRegion: "string",
        timeouts: {
            create: "string",
            "delete": "string",
        },
    });
    
    type: aws:notifications:NotificationHub
    properties:
        notificationHubRegion: string
        timeouts:
            create: string
            delete: string
    

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

    notificationHubRegion String
    Notification Hub region.
    timeouts Property Map

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NotificationHub 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 NotificationHub Resource

    Get an existing NotificationHub 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?: NotificationHubState, opts?: CustomResourceOptions): NotificationHub
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            notification_hub_region: Optional[str] = None,
            timeouts: Optional[NotificationHubTimeoutsArgs] = None) -> NotificationHub
    func GetNotificationHub(ctx *Context, name string, id IDInput, state *NotificationHubState, opts ...ResourceOption) (*NotificationHub, error)
    public static NotificationHub Get(string name, Input<string> id, NotificationHubState? state, CustomResourceOptions? opts = null)
    public static NotificationHub get(String name, Output<String> id, NotificationHubState state, CustomResourceOptions options)
    resources:  _:    type: aws:notifications:NotificationHub    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:
    notificationHubRegion String
    Notification Hub region.
    timeouts Property Map

    Supporting Types

    NotificationHubTimeouts, NotificationHubTimeoutsArgs

    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    Create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    Delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete string
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete str
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.
    create String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours).
    delete String
    A string that can be parsed as a duration consisting of numbers and unit suffixes, such as "30s" or "2h45m". Valid time units are "s" (seconds), "m" (minutes), "h" (hours). Setting a timeout for a Delete operation is only applicable if changes are saved into state before the destroy operation occurs.

    Import

    Using pulumi import, import User Notifications Notification Hub using the notification_hub_region. For example:

    $ pulumi import aws:notifications/notificationHub:NotificationHub example us-west-2
    

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

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.82.2 published on Thursday, Jun 12, 2025 by Pulumi