Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. AWS
  4. API Docs
  5. pinpoint
  6. App
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

aws.pinpoint.App

aws logo
Viewing docs for AWS v7.32.0
published on Friday, May 29, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws

    Provides an End User Messaging App resource.

    NOTE: The campaignHook, limits, and quietTime attributes are deprecated. AWS End User Messaging engagement features, including the Settings API that backs these attributes, are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.pinpoint.App("example", {
    name: "test-app",
    limits: {
        maximumDuration: 600,
    },
    quietTime: {
        start: "00:00",
        end: "06:00",
    },
});

    import pulumi
import pulumi_aws as aws

example = aws.pinpoint.App("example",
    name="test-app",
    limits={
        "maximum_duration": 600,
    },
    quiet_time={
        "start": "00:00",
        "end": "06:00",
    })

    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 {
		_, err := pinpoint.NewApp(ctx, "example", &pinpoint.AppArgs{
			Name: pulumi.String("test-app"),
			Limits: &pinpoint.AppLimitsArgs{
				MaximumDuration: pulumi.Int(600),
			},
			QuietTime: &pinpoint.AppQuietTimeArgs{
				Start: pulumi.String("00:00"),
				End:   pulumi.String("06:00"),
			},
		})
		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.Pinpoint.App("example", new()
    {
        Name = "test-app",
        Limits = new Aws.Pinpoint.Inputs.AppLimitsArgs
        {
            MaximumDuration = 600,
        },
        QuietTime = new Aws.Pinpoint.Inputs.AppQuietTimeArgs
        {
            Start = "00:00",
            End = "06:00",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.pinpoint.App;
import com.pulumi.aws.pinpoint.AppArgs;
import com.pulumi.aws.pinpoint.inputs.AppLimitsArgs;
import com.pulumi.aws.pinpoint.inputs.AppQuietTimeArgs;
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 App("example", AppArgs.builder()
            .name("test-app")
            .limits(AppLimitsArgs.builder()
                .maximumDuration(600)
                .build())
            .quietTime(AppQuietTimeArgs.builder()
                .start("00:00")
                .end("06:00")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:pinpoint:App
    properties:
      name: test-app
      limits:
        maximumDuration: 600
      quietTime:
        start: 00:00
        end: 06:00

    pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_app" "example" {
  name = "test-app"
  limits = {
    maximum_duration = 600
  }
  quiet_time = {
    start = "00:00"
    end   = "06:00"
  }
}

    Create App Resource

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

    Constructor syntax

    new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
    @overload
def App(resource_name: str,
        args: Optional[AppArgs] = None,
        opts: Optional[ResourceOptions] = None)

@overload
def App(resource_name: str,
        opts: Optional[ResourceOptions] = None,
        campaign_hook: Optional[AppCampaignHookArgs] = None,
        limits: Optional[AppLimitsArgs] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        quiet_time: Optional[AppQuietTimeArgs] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None)
    func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)
    public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)
    public App(String name, AppArgs args)
public App(String name, AppArgs args, CustomResourceOptions options)

    type: aws:pinpoint:App
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "aws_pinpoint_app" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args AppArgs
    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 AppArgs
    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 AppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AppArgs
    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 awsAppResource = new Aws.Pinpoint.App("awsAppResource", new()
{
    Name = "string",
    NamePrefix = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := pinpoint.NewApp(ctx, "awsAppResource", &pinpoint.AppArgs{
	Name:       pulumi.String("string"),
	NamePrefix: pulumi.String("string"),
	Region:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    resource "aws_pinpoint_app" "awsAppResource" {
  name        = "string"
  name_prefix = "string"
  region      = "string"
  tags = {
    "string" = "string"
  }
}

    var awsAppResource = new com.pulumi.aws.pinpoint.App("awsAppResource", com.pulumi.aws.pinpoint.AppArgs.builder()
    .name("string")
    .namePrefix("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .build());

    aws_app_resource = aws.pinpoint.App("awsAppResource",
    name="string",
    name_prefix="string",
    region="string",
    tags={
        "string": "string",
    })

    const awsAppResource = new aws.pinpoint.App("awsAppResource", {
    name: "string",
    namePrefix: "string",
    region: "string",
    tags: {
        string: "string",
    },
});

    type: aws:pinpoint:App
properties:
    name: string
    namePrefix: string
    region: string
    tags:
        string: string

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

    CampaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Name string
    Application name. By default generated by Pulumi.
    NamePrefix string
    Name of the End User Messaging application. Conflicts with name.
    QuietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    CampaignHook AppCampaignHookArgs
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Limits AppLimitsArgs
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Name string
    Application name. By default generated by Pulumi.
    NamePrefix string
    Name of the End User Messaging application. Conflicts with name.
    QuietTime AppQuietTimeArgs
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    campaign_hook object
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits object
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name string
    Application name. By default generated by Pulumi.
    name_prefix string
    Name of the End User Messaging application. Conflicts with name.
    quiet_time object
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    campaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name String
    Application name. By default generated by Pulumi.
    namePrefix String
    Name of the End User Messaging application. Conflicts with name.
    quietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    campaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name string
    Application name. By default generated by Pulumi.
    namePrefix string
    Name of the End User Messaging application. Conflicts with name.
    quietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    campaign_hook AppCampaignHookArgs
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimitsArgs
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name str
    Application name. By default generated by Pulumi.
    name_prefix str
    Name of the End User Messaging application. Conflicts with name.
    quiet_time AppQuietTimeArgs
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    campaignHook Property Map
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits Property Map
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name String
    Application name. By default generated by Pulumi.
    namePrefix String
    Name of the End User Messaging application. Conflicts with name.
    quietTime Property Map
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags 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 App resource produces the following output properties:

    ApplicationId string
    Application ID of the End User Messaging App.
    Arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    ApplicationId string
    Application ID of the End User Messaging App.
    Arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    application_id string
    Application ID of the End User Messaging App.
    arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId String
    Application ID of the End User Messaging App.
    arn String
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId string
    Application ID of the End User Messaging App.
    arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    application_id str
    Application ID of the End User Messaging App.
    arn str
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId String
    Application ID of the End User Messaging App.
    arn String
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Look up Existing App Resource

    Get an existing App 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?: AppState, opts?: CustomResourceOptions): App
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        application_id: Optional[str] = None,
        arn: Optional[str] = None,
        campaign_hook: Optional[AppCampaignHookArgs] = None,
        limits: Optional[AppLimitsArgs] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        quiet_time: Optional[AppQuietTimeArgs] = None,
        region: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> App
    func GetApp(ctx *Context, name string, id IDInput, state *AppState, opts ...ResourceOption) (*App, error)
    public static App Get(string name, Input<string> id, AppState? state, CustomResourceOptions? opts = null)
    public static App get(String name, Output<String> id, AppState state, CustomResourceOptions options)
    resources:  _:    type: aws:pinpoint:App    get:      id: ${id}
    import {
  to = aws_pinpoint_app.example
  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:
    ApplicationId string
    Application ID of the End User Messaging App.
    Arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    CampaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Name string
    Application name. By default generated by Pulumi.
    NamePrefix string
    Name of the End User Messaging application. Conflicts with name.
    QuietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags Dictionary<string, string>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    ApplicationId string
    Application ID of the End User Messaging App.
    Arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    CampaignHook AppCampaignHookArgs
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Limits AppLimitsArgs
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Name string
    Application name. By default generated by Pulumi.
    NamePrefix string
    Name of the End User Messaging application. Conflicts with name.
    QuietTime AppQuietTimeArgs
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    Region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    Tags map[string]string
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    application_id string
    Application ID of the End User Messaging App.
    arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    campaign_hook object
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits object
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name string
    Application name. By default generated by Pulumi.
    name_prefix string
    Name of the End User Messaging application. Conflicts with name.
    quiet_time object
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags map(string)
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all map(string)
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId String
    Application ID of the End User Messaging App.
    arn String
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    campaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name String
    Application name. By default generated by Pulumi.
    namePrefix String
    Name of the End User Messaging application. Conflicts with name.
    quietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String,String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId string
    Application ID of the End User Messaging App.
    arn string
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    campaignHook AppCampaignHook
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimits
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name string
    Application name. By default generated by Pulumi.
    namePrefix string
    Name of the End User Messaging application. Conflicts with name.
    quietTime AppQuietTime
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region string
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags {[key: string]: string}
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    application_id str
    Application ID of the End User Messaging App.
    arn str
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    campaign_hook AppCampaignHookArgs
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits AppLimitsArgs
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name str
    Application name. By default generated by Pulumi.
    name_prefix str
    Name of the End User Messaging application. Conflicts with name.
    quiet_time AppQuietTimeArgs
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region str
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Mapping[str, str]
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
    applicationId String
    Application ID of the End User Messaging App.
    arn String
    Amazon Resource Name (ARN) of the PinPoint Application.

    • campaign_hook[0].lambda_function_name - Lambda function name or ARN to be called for delivery.
    • campaign_hook[0].mode - What mode Lambda should be invoked in.
    • campaign_hook[0].web_url - Web URL to call for hook.
    • limits[0].daily - Maximum number of messages that the campaign can send daily.
    • limits[0].maximum_duration - Length of time (in seconds) that the campaign can run before it ends and message deliveries stop.
    • limits[0].messages_per_second - Number of messages that the campaign can send per second.
    • limits[0].total - Maximum total number of messages that the campaign can send.
    • quiet_time[0].end - Default end time for quiet time in ISO 8601 format.
    • quiet_time[0].start - Default start time for quiet time in ISO 8601 format.
    campaignHook Property Map
    Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.

    Deprecated: campaign_hook is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    limits Property Map
    Default campaign limits for the app. These limits apply to each campaign for the app, unless the campaign overrides the default with limits of its own. See below.

    Deprecated: limits is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    name String
    Application name. By default generated by Pulumi.
    namePrefix String
    Name of the End User Messaging application. Conflicts with name.
    quietTime Property Map
    Default quiet time for the app. Each campaign for this app sends no messages during this time unless the campaign overrides the default with a quiet time of its own. See below.

    Deprecated: quiet_time is deprecated. AWS End User Messaging engagement features are being discontinued on October 30, 2026. See the AWS End User Messaging migration guide for details.

    region String
    Region where this resource will be managed. Defaults to the Region set in the provider configuration.
    tags Map<String>
    Key-value map of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.

    Supporting Types

    AppCampaignHook, AppCampaignHookArgs

    LambdaFunctionName string
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    Mode string
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    WebUrl string
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    LambdaFunctionName string
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    Mode string
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    WebUrl string
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    lambda_function_name string
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    mode string
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    web_url string
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    lambdaFunctionName String
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    mode String
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    webUrl String
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    lambdaFunctionName string
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    mode string
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    webUrl string
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    lambda_function_name str
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    mode str
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    web_url str
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.
    lambdaFunctionName String
    Lambda function name or ARN to be called for delivery. Conflicts with webUrl.
    mode String
    What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
    webUrl String
    Web URL to call for hook. If the URL has authentication specified it will be added as authentication to the request. Conflicts with lambdaFunctionName.

    AppLimits, AppLimitsArgs

    Daily int
    Maximum number of messages that the campaign can send daily.
    MaximumDuration int
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    MessagesPerSecond int
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    Total int
    Maximum total number of messages that the campaign can send.
    Daily int
    Maximum number of messages that the campaign can send daily.
    MaximumDuration int
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    MessagesPerSecond int
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    Total int
    Maximum total number of messages that the campaign can send.
    daily number
    Maximum number of messages that the campaign can send daily.
    maximum_duration number
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    messages_per_second number
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    total number
    Maximum total number of messages that the campaign can send.
    daily Integer
    Maximum number of messages that the campaign can send daily.
    maximumDuration Integer
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    messagesPerSecond Integer
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    total Integer
    Maximum total number of messages that the campaign can send.
    daily number
    Maximum number of messages that the campaign can send daily.
    maximumDuration number
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    messagesPerSecond number
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    total number
    Maximum total number of messages that the campaign can send.
    daily int
    Maximum number of messages that the campaign can send daily.
    maximum_duration int
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    messages_per_second int
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    total int
    Maximum total number of messages that the campaign can send.
    daily Number
    Maximum number of messages that the campaign can send daily.
    maximumDuration Number
    Length of time (in seconds) that the campaign can run before it ends and message deliveries stop. This duration begins at the scheduled start time for the campaign. Minimum value is 60.
    messagesPerSecond Number
    Number of messages that the campaign can send per second. Minimum value is 50, and the maximum is 20000.
    total Number
    Maximum total number of messages that the campaign can send.

    AppQuietTime, AppQuietTimeArgs

    End string
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    Start string
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    End string
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    Start string
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    end string
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    start string
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    end String
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    start String
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    end string
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    start string
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    end str
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    start str
    Default start time for quiet time in ISO 8601 format. Required if end is set.
    end String
    Default end time for quiet time in ISO 8601 format. Required if start is set.
    start String
    Default start time for quiet time in ISO 8601 format. Required if end is set.

    Import

    Using pulumi import, import End User Messaging App using the application-id. For example:

    $ pulumi import aws:pinpoint/app:App name application-id

    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
    Viewing docs for AWS v7.32.0
    published on Friday, May 29, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial