ChannelAssociation class
Resource for managing an AWS User Notifications Channel Association. This resource associates a channel (such as an email contact) with a 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-notification-config",
description: "Example notification configuration",
});
const exampleContactsEmailContact = new aws.notifications.ContactsEmailContact("example", {
name: "example-contact",
emailAddress: "example@example.com",
});
const exampleChannelAssociation = new aws.notifications.ChannelAssociation("example", {
arn: exampleContactsEmailContact.arn,
notificationConfigurationArn: example.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.notifications.NotificationConfiguration("example",
name="example-notification-config",
description="Example notification configuration")
example_contacts_email_contact = aws.notifications.ContactsEmailContact("example",
name="example-contact",
email_address="example@example.com")
example_channel_association = aws.notifications.ChannelAssociation("example",
arn=example_contacts_email_contact.arn,
notification_configuration_arn=example.arn)
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-notification-config",
Description = "Example notification configuration",
});
var exampleContactsEmailContact = new Aws.Notifications.ContactsEmailContact("example", new()
{
Name = "example-contact",
EmailAddress = "example@example.com",
});
var exampleChannelAssociation = new Aws.Notifications.ChannelAssociation("example", new()
{
Arn = exampleContactsEmailContact.Arn,
NotificationConfigurationArn = example.Arn,
});
});
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 {
example, err := notifications.NewNotificationConfiguration(ctx, "example", ¬ifications.NotificationConfigurationArgs{
Name: pulumi.String("example-notification-config"),
Description: pulumi.String("Example notification configuration"),
})
if err != nil {
return err
}
exampleContactsEmailContact, err := notifications.NewContactsEmailContact(ctx, "example", ¬ifications.ContactsEmailContactArgs{
Name: pulumi.String("example-contact"),
EmailAddress: pulumi.String("example@example.com"),
})
if err != nil {
return err
}
_, err = notifications.NewChannelAssociation(ctx, "example", ¬ifications.ChannelAssociationArgs{
Arn: exampleContactsEmailContact.Arn,
NotificationConfigurationArn: example.Arn,
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_notifications_notificationconfiguration" "example" {
name = "example-notification-config"
description = "Example notification configuration"
}
resource "aws_notifications_contactsemailcontact" "example" {
name = "example-contact"
email_address = "example@example.com"
}
resource "aws_notifications_channelassociation" "example" {
arn = aws_notifications_contactsemailcontact.example.arn
notification_configuration_arn = aws_notifications_notificationconfiguration.example.arn
}
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 com.pulumi.aws.notifications.ContactsEmailContact;
import com.pulumi.aws.notifications.ContactsEmailContactArgs;
import com.pulumi.aws.notifications.ChannelAssociation;
import com.pulumi.aws.notifications.ChannelAssociationArgs;
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-notification-config")
.description("Example notification configuration")
.build());
var exampleContactsEmailContact = new ContactsEmailContact("exampleContactsEmailContact", ContactsEmailContactArgs.builder()
.name("example-contact")
.emailAddress("example@example.com")
.build());
var exampleChannelAssociation = new ChannelAssociation("exampleChannelAssociation", ChannelAssociationArgs.builder()
.arn(exampleContactsEmailContact.arn())
.notificationConfigurationArn(example.arn())
.build());
}
}
resources:
example:
type: aws:notifications:NotificationConfiguration
properties:
name: example-notification-config
description: Example notification configuration
exampleContactsEmailContact:
type: aws:notifications:ContactsEmailContact
name: example
properties:
name: example-contact
emailAddress: example@example.com
exampleChannelAssociation:
type: aws:notifications:ChannelAssociation
name: example
properties:
arn: ${exampleContactsEmailContact.arn}
notificationConfigurationArn: ${example.arn}
Import
Using pulumi import, import User Notifications Channel Association using the notification_configuration_arn,channel_arn format. For example:
$ pulumi import aws:notifications/channelAssociation:ChannelAssociation example arn:aws:notifications:us-west-2:123456789012:configuration:example-notification-config,arn:aws:notificationscontacts:us-west-2:123456789012:emailcontact:example-contact
Constructors
- ChannelAssociation(String name, {ChannelAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new ChannelAssociation.
nameThe Pulumi resource name.argsArguments used to configure this ChannelAssociation. The set of arguments for ChannelAssociation.optionsResource options controlling this resource's behavior. - ChannelAssociation.reference(String urn)
- Creates a typed reference to an existing ChannelAssociation resource.
Properties
-
arn
↔ Output<
String> -
ARN of the channel to associate with the notification configuration. Must match pattern
^arn:aws:(chatbot|consoleapp|notifications-contacts):[a-zA-Z0-9-]*:[0-9]{12}:[a-zA-Z0-9-_.@]+/[a-zA-Z0-9/_.@:-]+$.latefinal -
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- 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
-
notificationConfigurationArn
↔ Output<
String> -
ARN of the notification configuration to associate the channel with.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
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, {ChannelAssociationState? state, CustomResourceOptions? options}) → ChannelAssociation -
Gets an existing ChannelAssociation resource's state with the given
nameandid.