App class

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", {
    limits: {
        maximumDuration: 600,
    },
    quietTime: {
        start: "00:00",
        end: "06:00",
    },
    name: "test-app",
});
import pulumi
import pulumi_aws as aws

example = aws.pinpoint.App("example",
    limits={
        "maximum_duration": 600,
    },
    quiet_time={
        "start": "00:00",
        "end": "06:00",
    },
    name="test-app")
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()
    {
        Limits = new Aws.Pinpoint.Inputs.AppLimitsArgs
        {
            MaximumDuration = 600,
        },
        QuietTime = new Aws.Pinpoint.Inputs.AppQuietTimeArgs
        {
            Start = "00:00",
            End = "06:00",
        },
        Name = "test-app",
    });

});
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{
			Limits: &pinpoint.AppLimitsArgs{
				MaximumDuration: pulumi.Int(600),
			},
			QuietTime: &pinpoint.AppQuietTimeArgs{
				Start: pulumi.String("00:00"),
				End:   pulumi.String("06:00"),
			},
			Name: pulumi.String("test-app"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_pinpoint_app" "example" {
  limits = {
    maximum_duration = 600
  }
  quiet_time = {
    start = "00:00"
    end   = "06:00"
  }
  name = "test-app"
}
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()
            .limits(AppLimitsArgs.builder()
                .maximumDuration(600)
                .build())
            .quietTime(AppQuietTimeArgs.builder()
                .start("00:00")
                .end("06:00")
                .build())
            .name("test-app")
            .build());

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

Import

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

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

Constructors

App(String name, {AppArgs? args, CustomResourceOptions? options})
Creates a new App. name The Pulumi resource name. args Arguments used to configure this App. The set of arguments for App. options Resource options controlling this resource's behavior.
App.reference(String urn)
Creates a typed reference to an existing App resource.

Properties

applicationId ↔ Output<String>
Application ID of the End User Messaging App.
latefinal
arn ↔ Output<String>
ARN of the PinPoint Application.
latefinal
campaignHook ↔ Output<AppCampaignHook?>
Settings for invoking an AWS Lambda function that customizes a segment for a campaign. See below.
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
limits ↔ Output<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.
latefinal
name ↔ Output<String>
Application name. By default generated by Pulumi.
latefinal
namePrefix ↔ Output<String>
Name of the End User Messaging application. Conflicts with name.
latefinal
quietTime ↔ Output<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.
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
tags ↔ Output<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.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration 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, {AppState? state, CustomResourceOptions? options}) → App
Gets an existing App resource's state with the given name and id.