AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.5.0 published on Wednesday, May 25, 2022 by Pulumi

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/v5/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{
				End:   pulumi.String("06:00"),
				Start: pulumi.String("00:00"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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()
                .end("06:00")
                .start("00:00")
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.pinpoint.App("example",
    limits=aws.pinpoint.AppLimitsArgs(
        maximum_duration=600,
    ),
    quiet_time=aws.pinpoint.AppQuietTimeArgs(
        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",
    },
});
resources:
  example:
    type: aws:pinpoint:App
    properties:
      limits:
        maximumDuration: 600
      quietTime:
        end: 06:00
        start: 00:00

Create a App Resource

new App(name: string, args?: AppArgs, opts?: CustomResourceOptions);
@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,
        tags: Optional[Mapping[str, str]] = None)
@overload
def App(resource_name: str,
        args: Optional[AppArgs] = None,
        opts: Optional[ResourceOptions] = 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.

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.

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

The App resource accepts the following input properties:

CampaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

CampaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 map[string]string

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

campaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 Map<String,String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

campaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 {[key: string]: string}

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

campaign_hook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 str

The application name. By default generated by this provider

name_prefix str

The name of the Pinpoint application. Conflicts with name

quiet_time 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 Mapping[str, str]

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

campaignHook Property Map

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

limits Property Map

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 Property Map

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>

Key-value map of resource tags. .If configured with a provider default_tags 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

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.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

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.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

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.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

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.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

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
@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,
        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)
Resource lookup is not supported in YAML
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

The Application ID of the Pinpoint App.

Arn string

Amazon Resource Name (ARN) of the PinPoint Application

CampaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll Dictionary<string, string>

A map of tags assigned to the resource, including those inherited from the provider .

ApplicationId string

The Application ID of the Pinpoint App.

Arn string

Amazon Resource Name (ARN) of the PinPoint Application

CampaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 map[string]string

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

TagsAll map[string]string

A map of tags assigned to the resource, including those inherited from the provider .

applicationId String

The Application ID of the Pinpoint App.

arn String

Amazon Resource Name (ARN) of the PinPoint Application

campaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 Map<String,String>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String,String>

A map of tags assigned to the resource, including those inherited from the provider .

applicationId string

The Application ID of the Pinpoint App.

arn string

Amazon Resource Name (ARN) of the PinPoint Application

campaignHook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 {[key: string]: string}

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll {[key: string]: string}

A map of tags assigned to the resource, including those inherited from the provider .

application_id str

The Application ID of the Pinpoint App.

arn str

Amazon Resource Name (ARN) of the PinPoint Application

campaign_hook AppCampaignHookArgs

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

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 str

The application name. By default generated by this provider

name_prefix str

The name of the Pinpoint application. Conflicts with name

quiet_time 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 Mapping[str, str]

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tags_all Mapping[str, str]

A map of tags assigned to the resource, including those inherited from the provider .

applicationId String

The Application ID of the Pinpoint App.

arn String

Amazon Resource Name (ARN) of the PinPoint Application

campaignHook Property Map

Specifies settings for invoking an AWS Lambda function that customizes a segment for a campaign

limits Property Map

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 Property Map

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>

Key-value map of resource tags. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

tagsAll Map<String>

A map of tags assigned to the resource, including those inherited from the provider .

Supporting Types

AppCampaignHook

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 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

lambda_function_name 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.

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 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

AppLimits

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 Integer

The maximum number of messages that the campaign can send daily.

maximumDuration Integer

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 Integer

The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.

total Integer

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 int

The maximum number of messages that the campaign can send daily.

maximum_duration 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.

messages_per_second 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.

AppQuietTime

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 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

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

Import

Pinpoint App can be imported using the application-id, e.g.,

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

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.