NotificationConfiguration class
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",
})
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_notifications_notificationconfiguration" "example" {
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.ArrayList;
import java.util.Arrays;
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",
})
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 main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/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
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_notifications_notificationconfiguration" "example" {
name = "example-aggregation"
description = "Example notification configuration with aggregation"
aggregation_duration = "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.ArrayList;
import java.util.Arrays;
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
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
Constructors
- NotificationConfiguration(String name, {NotificationConfigurationArgs? args, CustomResourceOptions? options})
-
Creates a new NotificationConfiguration.
nameThe Pulumi resource name.argsArguments used to configure this NotificationConfiguration. The set of arguments for NotificationConfiguration.optionsResource options controlling this resource's behavior. - NotificationConfiguration.reference(String urn)
- Creates a typed reference to an existing NotificationConfiguration resource.
Properties
-
aggregationDuration
↔ Output<
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.latefinal -
arn
↔ Output<
String> -
ARN of the NotificationConfiguration.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
description
↔ Output<
String> -
Description of the NotificationConfiguration. Length constraints: Minimum length of 0,
maximum length of 256.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
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_\-]+.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
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
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {NotificationConfigurationState? state, CustomResourceOptions? options}) → NotificationConfiguration -
Gets an existing NotificationConfiguration resource's state with the given
nameandid.