aws.notifications.NotificationConfiguration
Explore with Pulumi AI
Resource for managing an AWS User Notifications Notification Configuration.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.notifications.NotificationConfiguration("example", {
name: "example",
description: "Example notification configuration",
tags: {
Environment: "production",
Project: "example",
},
});
import pulumi
import pulumi_aws as aws
example = aws.notifications.NotificationConfiguration("example",
name="example",
description="Example notification configuration",
tags={
"Environment": "production",
"Project": "example",
})
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.NewNotificationConfiguration(ctx, "example", ¬ifications.NotificationConfigurationArgs{
Name: pulumi.String("example"),
Description: pulumi.String("Example notification configuration"),
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
"Project": pulumi.String("example"),
},
})
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.NotificationConfiguration("example", new()
{
Name = "example",
Description = "Example notification configuration",
Tags =
{
{ "Environment", "production" },
{ "Project", "example" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.notifications.NotificationConfiguration;
import com.pulumi.aws.notifications.NotificationConfigurationArgs;
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 NotificationConfiguration("example", NotificationConfigurationArgs.builder()
.name("example")
.description("Example notification configuration")
.tags(Map.ofEntries(
Map.entry("Environment", "production"),
Map.entry("Project", "example")
))
.build());
}
}
resources:
example:
type: aws:notifications:NotificationConfiguration
properties:
name: example
description: Example notification configuration
tags:
Environment: production
Project: example
With Aggregation Duration
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.notifications.NotificationConfiguration("example", {
name: "example-aggregation",
description: "Example notification configuration with aggregation",
aggregationDuration: "SHORT",
tags: {
Environment: "production",
Project: "example",
},
});
import pulumi
import pulumi_aws as aws
example = aws.notifications.NotificationConfiguration("example",
name="example-aggregation",
description="Example notification configuration with aggregation",
aggregation_duration="SHORT",
tags={
"Environment": "production",
"Project": "example",
})
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.NewNotificationConfiguration(ctx, "example", ¬ifications.NotificationConfigurationArgs{
Name: pulumi.String("example-aggregation"),
Description: pulumi.String("Example notification configuration with aggregation"),
AggregationDuration: pulumi.String("SHORT"),
Tags: pulumi.StringMap{
"Environment": pulumi.String("production"),
"Project": pulumi.String("example"),
},
})
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.NotificationConfiguration("example", new()
{
Name = "example-aggregation",
Description = "Example notification configuration with aggregation",
AggregationDuration = "SHORT",
Tags =
{
{ "Environment", "production" },
{ "Project", "example" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.notifications.NotificationConfiguration;
import com.pulumi.aws.notifications.NotificationConfigurationArgs;
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 NotificationConfiguration("example", NotificationConfigurationArgs.builder()
.name("example-aggregation")
.description("Example notification configuration with aggregation")
.aggregationDuration("SHORT")
.tags(Map.ofEntries(
Map.entry("Environment", "production"),
Map.entry("Project", "example")
))
.build());
}
}
resources:
example:
type: aws:notifications:NotificationConfiguration
properties:
name: example-aggregation
description: Example notification configuration with aggregation
aggregationDuration: SHORT
tags:
Environment: production
Project: example
Create NotificationConfiguration Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NotificationConfiguration(name: string, args: NotificationConfigurationArgs, opts?: CustomResourceOptions);
@overload
def NotificationConfiguration(resource_name: str,
args: NotificationConfigurationArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NotificationConfiguration(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
aggregation_duration: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewNotificationConfiguration(ctx *Context, name string, args NotificationConfigurationArgs, opts ...ResourceOption) (*NotificationConfiguration, error)
public NotificationConfiguration(string name, NotificationConfigurationArgs args, CustomResourceOptions? opts = null)
public NotificationConfiguration(String name, NotificationConfigurationArgs args)
public NotificationConfiguration(String name, NotificationConfigurationArgs args, CustomResourceOptions options)
type: aws:notifications:NotificationConfiguration
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 NotificationConfigurationArgs
- 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 NotificationConfigurationArgs
- 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 NotificationConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NotificationConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NotificationConfigurationArgs
- 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 notificationConfigurationResource = new Aws.Notifications.NotificationConfiguration("notificationConfigurationResource", new()
{
Description = "string",
AggregationDuration = "string",
Name = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := notifications.NewNotificationConfiguration(ctx, "notificationConfigurationResource", ¬ifications.NotificationConfigurationArgs{
Description: pulumi.String("string"),
AggregationDuration: pulumi.String("string"),
Name: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var notificationConfigurationResource = new NotificationConfiguration("notificationConfigurationResource", NotificationConfigurationArgs.builder()
.description("string")
.aggregationDuration("string")
.name("string")
.tags(Map.of("string", "string"))
.build());
notification_configuration_resource = aws.notifications.NotificationConfiguration("notificationConfigurationResource",
description="string",
aggregation_duration="string",
name="string",
tags={
"string": "string",
})
const notificationConfigurationResource = new aws.notifications.NotificationConfiguration("notificationConfigurationResource", {
description: "string",
aggregationDuration: "string",
name: "string",
tags: {
string: "string",
},
});
type: aws:notifications:NotificationConfiguration
properties:
aggregationDuration: string
description: string
name: string
tags:
string: string
NotificationConfiguration 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 NotificationConfiguration resource accepts the following input properties:
- Description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- Aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - Name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Dictionary<string, string>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- Description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- Aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - Name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- map[string]string
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- description String
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- aggregation
Duration String - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - name String
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Map<String,String>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- {[key: string]: string}
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- description str
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- aggregation_
duration str - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - name str
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Mapping[str, str]
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
- description String
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- aggregation
Duration String - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - name String
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Map<String>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Outputs
All input properties are implicitly available as output properties. Additionally, the NotificationConfiguration resource produces the following output properties:
Look up Existing NotificationConfiguration Resource
Get an existing NotificationConfiguration 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?: NotificationConfigurationState, opts?: CustomResourceOptions): NotificationConfiguration
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
aggregation_duration: Optional[str] = None,
arn: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None) -> NotificationConfiguration
func GetNotificationConfiguration(ctx *Context, name string, id IDInput, state *NotificationConfigurationState, opts ...ResourceOption) (*NotificationConfiguration, error)
public static NotificationConfiguration Get(string name, Input<string> id, NotificationConfigurationState? state, CustomResourceOptions? opts = null)
public static NotificationConfiguration get(String name, Output<String> id, NotificationConfigurationState state, CustomResourceOptions options)
resources: _: type: aws:notifications:NotificationConfiguration 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.
- Aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - Arn string
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- Description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- Name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Dictionary<string, string>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- Aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - Arn string
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- Description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- Name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- map[string]string
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- aggregation
Duration String - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - arn String
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- description String
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- name String
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Map<String,String>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- aggregation
Duration string - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - arn string
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- description string
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- name string
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- {[key: string]: string}
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- aggregation_
duration str - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - arn str
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- description str
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- name str
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Mapping[str, str]
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
- aggregation
Duration String - Aggregation preference of the NotificationConfiguration. Valid values:
LONG
( aggregate notifications for 12 hours),SHORT
(aggregate notifications for 5 minutes),NONE
(don't aggregate notifications). Default:NONE
. - arn String
- Amazon Resource Name (ARN) of the NotificationConfiguration.
- description String
- Description of the NotificationConfiguration. Length constraints: Minimum length of 0, maximum length of 256.
- name String
Name of the NotificationConfiguration. Supports RFC 3986's unreserved characters. Length constraints: Minimum length of 1, maximum length of 64. Pattern:
[A-Za-z0-9_\-]+
.The following arguments are optional:
- Map<String>
- Map of tags to assign to the resource. A tag is a string-to-string map of key-value pairs. If
configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- Map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.
Import
Using pulumi import
, import User Notifications Notification Configuration using the arn
. For example:
$ pulumi import aws:notifications/notificationConfiguration:NotificationConfiguration example arn:aws:notifications::123456789012:configuration/abcdef1234567890abcdef1234567890
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.