App

Provides a Pinpoint App resource.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Pinpoint.App("example", new Aws.Pinpoint.AppArgs
        {
            Limits = new Aws.Pinpoint.Inputs.AppLimitsArgs
            {
                MaximumDuration = 600,
            },
            QuietTime = new Aws.Pinpoint.Inputs.AppQuietTimeArgs
            {
                End = "06:00",
                Start = "00:00",
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/pinpoint"
    "github.com/pulumi/pulumi/sdk/v2/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{
                End:   pulumi.String("06:00"),
                Start: pulumi.String("00:00"),
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.pinpoint.App("example",
    limits={
        "maximumDuration": 600,
    },
    quiet_time={
        "end": "06:00",
        "start": "00:00",
    })

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

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

Create a App Resource

new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);

def App(resource_name, opts=None, campaign_hook=None, limits=None, name=None, name_prefix=None, quiet_time=None, tags=None, __props__=None);

func NewApp(ctx *Context, name string, args *AppArgs, opts ...ResourceOption) (*App, error)

public App(string name, AppArgs? args = null, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

App Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The App resource accepts the following input properties:

CampaignHook AppCampaignHookArgs: The 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
Limits AppLimitsArgs: The 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
Name string: The application name. By default generated by this provider
NamePrefix string: The name of the Pinpoint application. Conflicts with name
QuietTime AppQuietTimeArgs: The 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
Tags Dictionary<string, string>: Key-value map of resource tags

CampaignHook AppCampaignHook: The 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
Limits AppLimits: The 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
Name string: The application name. By default generated by this provider
NamePrefix string: The name of the Pinpoint application. Conflicts with name
QuietTime AppQuietTime: The 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
Tags map[string]string: Key-value map of resource tags

campaignHook AppCampaignHook: The 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
limits AppLimits: The 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
name string: The application name. By default generated by this provider
namePrefix string: The name of the Pinpoint application. Conflicts with name
quietTime AppQuietTime: The 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
tags {[key: string]: string}: Key-value map of resource tags

campaign_hook Dict[AppCampaignHook]: The 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
limits Dict[AppLimits]: The 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
name str: The application name. By default generated by this provider
name_prefix str: The name of the Pinpoint application. Conflicts with name
quiet_time Dict[AppQuietTime]: The 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
tags Dict[str, str]: Key-value map of resource tags

Outputs

All input properties are implicitly available as output properties. Additionally, the App resource produces the following output properties:

ApplicationId string: The Application ID of the Pinpoint App.
Arn string: Amazon Resource Name (ARN) of the PinPoint Application
Id string: The provider-assigned unique ID for this managed resource.

ApplicationId string: The Application ID of the Pinpoint App.
Arn string: Amazon Resource Name (ARN) of the PinPoint Application
Id string: The provider-assigned unique ID for this managed resource.

applicationId string: The Application ID of the Pinpoint App.
arn string: Amazon Resource Name (ARN) of the PinPoint Application
id string: The provider-assigned unique ID for this managed resource.

application_id str: The Application ID of the Pinpoint App.
arn str: Amazon Resource Name (ARN) of the PinPoint Application
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, application_id=None, arn=None, campaign_hook=None, limits=None, name=None, name_prefix=None, quiet_time=None, tags=None, __props__=None);

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)

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.

The following state arguments are supported:

ApplicationId string: The Application ID of the Pinpoint App.
Arn string: Amazon Resource Name (ARN) of the PinPoint Application
CampaignHook AppCampaignHookArgs: The 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
Limits AppLimitsArgs: The 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
Name string: The application name. By default generated by this provider
NamePrefix string: The name of the Pinpoint application. Conflicts with name
QuietTime AppQuietTimeArgs: The 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
Tags Dictionary<string, string>: Key-value map of resource tags

ApplicationId string: The Application ID of the Pinpoint App.
Arn string: Amazon Resource Name (ARN) of the PinPoint Application
CampaignHook AppCampaignHook: The 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
Limits AppLimits: The 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
Name string: The application name. By default generated by this provider
NamePrefix string: The name of the Pinpoint application. Conflicts with name
QuietTime AppQuietTime: The 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
Tags map[string]string: Key-value map of resource tags

applicationId string: The Application ID of the Pinpoint App.
arn string: Amazon Resource Name (ARN) of the PinPoint Application
campaignHook AppCampaignHook: The 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
limits AppLimits: The 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
name string: The application name. By default generated by this provider
namePrefix string: The name of the Pinpoint application. Conflicts with name
quietTime AppQuietTime: The 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
tags {[key: string]: string}: Key-value map of resource tags

application_id str: The Application ID of the Pinpoint App.
arn str: Amazon Resource Name (ARN) of the PinPoint Application
campaign_hook Dict[AppCampaignHook]: The 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
limits Dict[AppLimits]: The 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
name str: The application name. By default generated by this provider
name_prefix str: The name of the Pinpoint application. Conflicts with name
quiet_time Dict[AppQuietTime]: The 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
tags Dict[str, str]: Key-value map of resource tags

Supporting Types

AppCampaignHook

See the input and output API doc for this type.

LambdaFunctionName string: Lambda function name or ARN to be called for delivery. Conflicts with web_url
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 lambda_function_name

LambdaFunctionName string: Lambda function name or ARN to be called for delivery. Conflicts with web_url
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 lambda_function_name

lambdaFunctionName string: Lambda function name or ARN to be called for delivery. Conflicts with web_url
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 lambda_function_name

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

AppLimits

See the input and output API doc for this type.

Daily int: The maximum number of messages that the campaign can send daily.
MaximumDuration int: The 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. The minimum value is 60.
MessagesPerSecond int: The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total int: The maximum total number of messages that the campaign can send.

Daily int: The maximum number of messages that the campaign can send daily.
MaximumDuration int: The 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. The minimum value is 60.
MessagesPerSecond int: The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
Total int: The maximum total number of messages that the campaign can send.

daily number: The maximum number of messages that the campaign can send daily.
maximumDuration number: The 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. The minimum value is 60.
messagesPerSecond number: The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
total number: The maximum total number of messages that the campaign can send.

daily float: The maximum number of messages that the campaign can send daily.
maximumDuration float: The 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. The minimum value is 60.
messages_per_second float: The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
total float: The maximum total number of messages that the campaign can send.

AppQuietTime

See the input and output API doc for this type.

End string: The default end time for quiet time in ISO 8601 format. Required if start is set
Start string: The default start time for quiet time in ISO 8601 format. Required if end is set

End string: The default end time for quiet time in ISO 8601 format. Required if start is set
Start string: The default start time for quiet time in ISO 8601 format. Required if end is set

end string: The default end time for quiet time in ISO 8601 format. Required if start is set
start string: The default start time for quiet time in ISO 8601 format. Required if end is set

end str: The default end time for quiet time in ISO 8601 format. Required if start is set
start str: The default start time for quiet time in ISO 8601 format. Required if end is set

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

App

Example Usage

Create a App Resource

App Resource Properties

Inputs

Outputs

Look up an Existing App Resource

Supporting Types

AppCampaignHook

AppLimits

AppQuietTime

Package Details

On This Page