Smsvoicev2EventDestination class
Manages an AWS End User Messaging SMS Event Destination.
An event destination is a location where messaging events are published. Exactly one of cloudwatchLogsDestination, kinesisFirehoseDestination, or snsDestination must be configured per event destination. Changing the sink type (e.g., from snsDestination to cloudwatchLogsDestination) forces resource replacement — AWS's UpdateEventDestination rejects sink-type changes with ConflictException.
Example Usage
CloudWatch Logs Destination
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.pinpoint.Smsvoicev2ConfigurationSet("example", {name: "example-configuration-set"});
const exampleSmsvoicev2EventDestination = new aws.pinpoint.Smsvoicev2EventDestination("example", {
cloudwatchLogsDestination: {
iamRoleArn: exampleAwsIamRole.arn,
logGroupArn: exampleAwsCloudwatchLogGroup.arn,
},
configurationSetName: example.name,
eventDestinationName: "example",
matchingEventTypes: ["ALL"],
});
import pulumi
import pulumi_aws as aws
example = aws.pinpoint.Smsvoicev2ConfigurationSet("example", name="example-configuration-set")
example_smsvoicev2_event_destination = aws.pinpoint.Smsvoicev2EventDestination("example",
cloudwatch_logs_destination={
"iam_role_arn": example_aws_iam_role["arn"],
"log_group_arn": example_aws_cloudwatch_log_group["arn"],
},
configuration_set_name=example.name,
event_destination_name="example",
matching_event_types=["ALL"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Pinpoint.Smsvoicev2ConfigurationSet("example", new()
{
Name = "example-configuration-set",
});
var exampleSmsvoicev2EventDestination = new Aws.Pinpoint.Smsvoicev2EventDestination("example", new()
{
CloudwatchLogsDestination = new Aws.Pinpoint.Inputs.Smsvoicev2EventDestinationCloudwatchLogsDestinationArgs
{
IamRoleArn = exampleAwsIamRole.Arn,
LogGroupArn = exampleAwsCloudwatchLogGroup.Arn,
},
ConfigurationSetName = example.Name,
EventDestinationName = "example",
MatchingEventTypes = new[]
{
"ALL",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := pinpoint.NewSmsvoicev2ConfigurationSet(ctx, "example", &pinpoint.Smsvoicev2ConfigurationSetArgs{
Name: pulumi.String("example-configuration-set"),
})
if err != nil {
return err
}
_, err = pinpoint.NewSmsvoicev2EventDestination(ctx, "example", &pinpoint.Smsvoicev2EventDestinationArgs{
CloudwatchLogsDestination: &pinpoint.Smsvoicev2EventDestinationCloudwatchLogsDestinationArgs{
IamRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
LogGroupArn: pulumi.Any(exampleAwsCloudwatchLogGroup.Arn),
},
ConfigurationSetName: example.Name,
EventDestinationName: pulumi.String("example"),
MatchingEventTypes: pulumi.StringArray{
pulumi.String("ALL"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_pinpoint_smsvoicev2configurationset" "example" {
name = "example-configuration-set"
}
resource "aws_pinpoint_smsvoicev2eventdestination" "example" {
cloudwatch_logs_destination = {
iam_role_arn = exampleAwsIamRole.arn
log_group_arn = exampleAwsCloudwatchLogGroup.arn
}
configuration_set_name = aws_pinpoint_smsvoicev2configurationset.example.name
event_destination_name = "example"
matching_event_types = ["ALL"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSet;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSetArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestination;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestinationArgs;
import com.pulumi.aws.pinpoint.inputs.Smsvoicev2EventDestinationCloudwatchLogsDestinationArgs;
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 Smsvoicev2ConfigurationSet("example", Smsvoicev2ConfigurationSetArgs.builder()
.name("example-configuration-set")
.build());
var exampleSmsvoicev2EventDestination = new Smsvoicev2EventDestination("exampleSmsvoicev2EventDestination", Smsvoicev2EventDestinationArgs.builder()
.cloudwatchLogsDestination(Smsvoicev2EventDestinationCloudwatchLogsDestinationArgs.builder()
.iamRoleArn(exampleAwsIamRole.arn())
.logGroupArn(exampleAwsCloudwatchLogGroup.arn())
.build())
.configurationSetName(example.name())
.eventDestinationName("example")
.matchingEventTypes("ALL")
.build());
}
}
resources:
example:
type: aws:pinpoint:Smsvoicev2ConfigurationSet
properties:
name: example-configuration-set
exampleSmsvoicev2EventDestination:
type: aws:pinpoint:Smsvoicev2EventDestination
name: example
properties:
cloudwatchLogsDestination:
iamRoleArn: ${exampleAwsIamRole.arn}
logGroupArn: ${exampleAwsCloudwatchLogGroup.arn}
configurationSetName: ${example.name}
eventDestinationName: example
matchingEventTypes:
- ALL
Kinesis Firehose Destination
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.pinpoint.Smsvoicev2ConfigurationSet("example", {name: "example-configuration-set"});
const exampleSmsvoicev2EventDestination = new aws.pinpoint.Smsvoicev2EventDestination("example", {
kinesisFirehoseDestination: {
deliveryStreamArn: exampleAwsKinesisFirehoseDeliveryStream.arn,
iamRoleArn: exampleAwsIamRole.arn,
},
configurationSetName: example.name,
eventDestinationName: "example",
matchingEventTypes: ["ALL"],
});
import pulumi
import pulumi_aws as aws
example = aws.pinpoint.Smsvoicev2ConfigurationSet("example", name="example-configuration-set")
example_smsvoicev2_event_destination = aws.pinpoint.Smsvoicev2EventDestination("example",
kinesis_firehose_destination={
"delivery_stream_arn": example_aws_kinesis_firehose_delivery_stream["arn"],
"iam_role_arn": example_aws_iam_role["arn"],
},
configuration_set_name=example.name,
event_destination_name="example",
matching_event_types=["ALL"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Pinpoint.Smsvoicev2ConfigurationSet("example", new()
{
Name = "example-configuration-set",
});
var exampleSmsvoicev2EventDestination = new Aws.Pinpoint.Smsvoicev2EventDestination("example", new()
{
KinesisFirehoseDestination = new Aws.Pinpoint.Inputs.Smsvoicev2EventDestinationKinesisFirehoseDestinationArgs
{
DeliveryStreamArn = exampleAwsKinesisFirehoseDeliveryStream.Arn,
IamRoleArn = exampleAwsIamRole.Arn,
},
ConfigurationSetName = example.Name,
EventDestinationName = "example",
MatchingEventTypes = new[]
{
"ALL",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := pinpoint.NewSmsvoicev2ConfigurationSet(ctx, "example", &pinpoint.Smsvoicev2ConfigurationSetArgs{
Name: pulumi.String("example-configuration-set"),
})
if err != nil {
return err
}
_, err = pinpoint.NewSmsvoicev2EventDestination(ctx, "example", &pinpoint.Smsvoicev2EventDestinationArgs{
KinesisFirehoseDestination: &pinpoint.Smsvoicev2EventDestinationKinesisFirehoseDestinationArgs{
DeliveryStreamArn: pulumi.Any(exampleAwsKinesisFirehoseDeliveryStream.Arn),
IamRoleArn: pulumi.Any(exampleAwsIamRole.Arn),
},
ConfigurationSetName: example.Name,
EventDestinationName: pulumi.String("example"),
MatchingEventTypes: pulumi.StringArray{
pulumi.String("ALL"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_pinpoint_smsvoicev2configurationset" "example" {
name = "example-configuration-set"
}
resource "aws_pinpoint_smsvoicev2eventdestination" "example" {
kinesis_firehose_destination = {
delivery_stream_arn = exampleAwsKinesisFirehoseDeliveryStream.arn
iam_role_arn = exampleAwsIamRole.arn
}
configuration_set_name = aws_pinpoint_smsvoicev2configurationset.example.name
event_destination_name = "example"
matching_event_types = ["ALL"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSet;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSetArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestination;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestinationArgs;
import com.pulumi.aws.pinpoint.inputs.Smsvoicev2EventDestinationKinesisFirehoseDestinationArgs;
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 Smsvoicev2ConfigurationSet("example", Smsvoicev2ConfigurationSetArgs.builder()
.name("example-configuration-set")
.build());
var exampleSmsvoicev2EventDestination = new Smsvoicev2EventDestination("exampleSmsvoicev2EventDestination", Smsvoicev2EventDestinationArgs.builder()
.kinesisFirehoseDestination(Smsvoicev2EventDestinationKinesisFirehoseDestinationArgs.builder()
.deliveryStreamArn(exampleAwsKinesisFirehoseDeliveryStream.arn())
.iamRoleArn(exampleAwsIamRole.arn())
.build())
.configurationSetName(example.name())
.eventDestinationName("example")
.matchingEventTypes("ALL")
.build());
}
}
resources:
example:
type: aws:pinpoint:Smsvoicev2ConfigurationSet
properties:
name: example-configuration-set
exampleSmsvoicev2EventDestination:
type: aws:pinpoint:Smsvoicev2EventDestination
name: example
properties:
kinesisFirehoseDestination:
deliveryStreamArn: ${exampleAwsKinesisFirehoseDeliveryStream.arn}
iamRoleArn: ${exampleAwsIamRole.arn}
configurationSetName: ${example.name}
eventDestinationName: example
matchingEventTypes:
- ALL
SNS Destination
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.pinpoint.Smsvoicev2ConfigurationSet("example", {name: "example-configuration-set"});
const exampleSmsvoicev2EventDestination = new aws.pinpoint.Smsvoicev2EventDestination("example", {
snsDestination: {
topicArn: exampleAwsSnsTopic.arn,
},
configurationSetName: example.name,
eventDestinationName: "example",
matchingEventTypes: ["ALL"],
});
import pulumi
import pulumi_aws as aws
example = aws.pinpoint.Smsvoicev2ConfigurationSet("example", name="example-configuration-set")
example_smsvoicev2_event_destination = aws.pinpoint.Smsvoicev2EventDestination("example",
sns_destination={
"topic_arn": example_aws_sns_topic["arn"],
},
configuration_set_name=example.name,
event_destination_name="example",
matching_event_types=["ALL"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Pinpoint.Smsvoicev2ConfigurationSet("example", new()
{
Name = "example-configuration-set",
});
var exampleSmsvoicev2EventDestination = new Aws.Pinpoint.Smsvoicev2EventDestination("example", new()
{
SnsDestination = new Aws.Pinpoint.Inputs.Smsvoicev2EventDestinationSnsDestinationArgs
{
TopicArn = exampleAwsSnsTopic.Arn,
},
ConfigurationSetName = example.Name,
EventDestinationName = "example",
MatchingEventTypes = new[]
{
"ALL",
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/pinpoint"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := pinpoint.NewSmsvoicev2ConfigurationSet(ctx, "example", &pinpoint.Smsvoicev2ConfigurationSetArgs{
Name: pulumi.String("example-configuration-set"),
})
if err != nil {
return err
}
_, err = pinpoint.NewSmsvoicev2EventDestination(ctx, "example", &pinpoint.Smsvoicev2EventDestinationArgs{
SnsDestination: &pinpoint.Smsvoicev2EventDestinationSnsDestinationArgs{
TopicArn: pulumi.Any(exampleAwsSnsTopic.Arn),
},
ConfigurationSetName: example.Name,
EventDestinationName: pulumi.String("example"),
MatchingEventTypes: pulumi.StringArray{
pulumi.String("ALL"),
},
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_pinpoint_smsvoicev2configurationset" "example" {
name = "example-configuration-set"
}
resource "aws_pinpoint_smsvoicev2eventdestination" "example" {
sns_destination = {
topic_arn = exampleAwsSnsTopic.arn
}
configuration_set_name = aws_pinpoint_smsvoicev2configurationset.example.name
event_destination_name = "example"
matching_event_types = ["ALL"]
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSet;
import com.pulumi.aws.pinpoint.Smsvoicev2ConfigurationSetArgs;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestination;
import com.pulumi.aws.pinpoint.Smsvoicev2EventDestinationArgs;
import com.pulumi.aws.pinpoint.inputs.Smsvoicev2EventDestinationSnsDestinationArgs;
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 Smsvoicev2ConfigurationSet("example", Smsvoicev2ConfigurationSetArgs.builder()
.name("example-configuration-set")
.build());
var exampleSmsvoicev2EventDestination = new Smsvoicev2EventDestination("exampleSmsvoicev2EventDestination", Smsvoicev2EventDestinationArgs.builder()
.snsDestination(Smsvoicev2EventDestinationSnsDestinationArgs.builder()
.topicArn(exampleAwsSnsTopic.arn())
.build())
.configurationSetName(example.name())
.eventDestinationName("example")
.matchingEventTypes("ALL")
.build());
}
}
resources:
example:
type: aws:pinpoint:Smsvoicev2ConfigurationSet
properties:
name: example-configuration-set
exampleSmsvoicev2EventDestination:
type: aws:pinpoint:Smsvoicev2EventDestination
name: example
properties:
snsDestination:
topicArn: ${exampleAwsSnsTopic.arn}
configurationSetName: ${example.name}
eventDestinationName: example
matchingEventTypes:
- ALL
Import
Identity Schema
Required
configurationSetName(String) Name of the configuration set this event destination belongs to.eventDestinationName(String) Name of the event destination.
Optional
accountId(String) AWS Account where this resource is managed.region(String) Region where this resource is managed.
Using pulumi import, import an event destination using the configurationSetName and eventDestinationName, separated by a comma. For example:
$ pulumi import aws:pinpoint/smsvoicev2EventDestination:Smsvoicev2EventDestination example "example-configuration-set,example-event-destination"
Constructors
- Smsvoicev2EventDestination(String name, {Smsvoicev2EventDestinationArgs? args, CustomResourceOptions? options})
-
Creates a new Smsvoicev2EventDestination.
nameThe Pulumi resource name.argsArguments used to configure this Smsvoicev2EventDestination. The set of arguments for Smsvoicev2EventDestination.optionsResource options controlling this resource's behavior. - Smsvoicev2EventDestination.reference(String urn)
- Creates a typed reference to an existing Smsvoicev2EventDestination resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
cloudwatchLogsDestination
↔ Output<
Smsvoicev2EventDestinationCloudwatchLogsDestination?> -
Send events to Amazon CloudWatch Logs. Exactly one of
cloudwatchLogsDestination,kinesisFirehoseDestination, orsnsDestinationmust be configured. SeecloudwatchLogsDestinationBlock for details.latefinal -
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
configurationSetArn
↔ Output<
String> -
ARN of the parent configuration set.
latefinal
-
configurationSetName
↔ Output<
String> -
Name of the configuration set this event destination belongs to. Changing this forces a new resource.
latefinal
-
enabled
↔ Output<
bool> -
Whether the event destination is enabled. Defaults to
true.latefinal -
eventDestinationName
↔ Output<
String> -
Name of the event destination. Changing this forces a new resource.
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
-
kinesisFirehoseDestination
↔ Output<
Smsvoicev2EventDestinationKinesisFirehoseDestination?> -
Send events to Amazon Data Firehose. Exactly one of
cloudwatchLogsDestination,kinesisFirehoseDestination, orsnsDestinationmust be configured. SeekinesisFirehoseDestinationBlock for details.latefinal -
matchingEventTypes
↔ Output<
List< String> > -
Event types for which the destination receives records. See the AWS API reference for valid values.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
snsDestination
↔ Output<
Smsvoicev2EventDestinationSnsDestination?> -
Send events to Amazon SNS. Exactly one of
cloudwatchLogsDestination,kinesisFirehoseDestination, orsnsDestinationmust be configured. SeesnsDestinationBlock for details.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, {Smsvoicev2EventDestinationState? state, CustomResourceOptions? options}) → Smsvoicev2EventDestination -
Gets an existing Smsvoicev2EventDestination resource's state with the given
nameandid.