Module pinpoint

This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

Others

Resources

Resource AdmChannel

class AdmChannel extends CustomResource

Provides a Pinpoint ADM (Amazon Device Messaging) Channel resource.

Note: All arguments including the Client ID and Client Secret will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const channel = new aws.pinpoint.AdmChannel("channel", {
    applicationId: app.applicationId,
    clientId: "",
    clientSecret: "",
    enabled: true,
});

constructor

new AdmChannel(name: string, args: AdmChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a AdmChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AdmChannelState, opts?: pulumi.CustomResourceOptions): AdmChannel

Get an existing AdmChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is AdmChannel

Returns true if the given object is an instance of AdmChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property clientId

public clientId: pulumi.Output<string>;

Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.

property clientSecret

public clientSecret: pulumi.Output<string>;

Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Specifies whether to enable the channel. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApnsChannel

class ApnsChannel extends CustomResource

Provides a Pinpoint APNs Channel resource.

Note: All arguments, including certificates and tokens, will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const apns = new aws.pinpoint.ApnsChannel("apns", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem", "utf-8"),
    privateKey: fs.readFileSync("./private_key.key", "utf-8"),
});

constructor

new ApnsChannel(name: string, args: ApnsChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a ApnsChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApnsChannelState, opts?: pulumi.CustomResourceOptions): ApnsChannel

Get an existing ApnsChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApnsChannel

Returns true if the given object is an instance of ApnsChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property bundleId

public bundleId: pulumi.Output<string | undefined>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

public certificate: pulumi.Output<string | undefined>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

public defaultAuthenticationMethod: pulumi.Output<string | undefined>;

The default authentication method used for APNs. NOTE: Amazon Pinpoint uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn’t attempt to use the other authentication type.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property privateKey

public privateKey: pulumi.Output<string | undefined>;

The Certificate Private Key file (ie. .key file).

property teamId

public teamId: pulumi.Output<string | undefined>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

public tokenKey: pulumi.Output<string | undefined>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

public tokenKeyId: pulumi.Output<string | undefined>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApnsSandboxChannel

class ApnsSandboxChannel extends CustomResource

Provides a Pinpoint APNs Sandbox Channel resource.

Note: All arguments, including certificates and tokens, will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const apnsSandbox = new aws.pinpoint.ApnsSandboxChannel("apns_sandbox", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem", "utf-8"),
    privateKey: fs.readFileSync("./private_key.key", "utf-8"),
});

constructor

new ApnsSandboxChannel(name: string, args: ApnsSandboxChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a ApnsSandboxChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApnsSandboxChannelState, opts?: pulumi.CustomResourceOptions): ApnsSandboxChannel

Get an existing ApnsSandboxChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApnsSandboxChannel

Returns true if the given object is an instance of ApnsSandboxChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property bundleId

public bundleId: pulumi.Output<string | undefined>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

public certificate: pulumi.Output<string | undefined>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

public defaultAuthenticationMethod: pulumi.Output<string | undefined>;

The default authentication method used for APNs Sandbox. NOTE: Amazon Pinpoint uses this default for every APNs push notification that you send using the console. You can override the default when you send a message programmatically using the Amazon Pinpoint API, the AWS CLI, or an AWS SDK. If your default authentication type fails, Amazon Pinpoint doesn’t attempt to use the other authentication type.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property privateKey

public privateKey: pulumi.Output<string | undefined>;

The Certificate Private Key file (ie. .key file).

property teamId

public teamId: pulumi.Output<string | undefined>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

public tokenKey: pulumi.Output<string | undefined>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

public tokenKeyId: pulumi.Output<string | undefined>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApnsVoipChannel

class ApnsVoipChannel extends CustomResource

Provides a Pinpoint APNs VoIP Channel resource.

Note: All arguments, including certificates and tokens, will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const apnsVoip = new aws.pinpoint.ApnsVoipChannel("apns_voip", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem", "utf-8"),
    privateKey: fs.readFileSync("./private_key.key", "utf-8"),
});

constructor

new ApnsVoipChannel(name: string, args: ApnsVoipChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a ApnsVoipChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApnsVoipChannelState, opts?: pulumi.CustomResourceOptions): ApnsVoipChannel

Get an existing ApnsVoipChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApnsVoipChannel

Returns true if the given object is an instance of ApnsVoipChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property bundleId

public bundleId: pulumi.Output<string | undefined>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

public certificate: pulumi.Output<string | undefined>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

public defaultAuthenticationMethod: pulumi.Output<string | undefined>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property privateKey

public privateKey: pulumi.Output<string | undefined>;

The Certificate Private Key file (ie. .key file).

property teamId

public teamId: pulumi.Output<string | undefined>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

public tokenKey: pulumi.Output<string | undefined>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

public tokenKeyId: pulumi.Output<string | undefined>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ApnsVoipSandboxChannel

class ApnsVoipSandboxChannel extends CustomResource

Provides a Pinpoint APNs VoIP Sandbox Channel resource.

Note: All arguments, including certificates and tokens, will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const apnsVoipSandbox = new aws.pinpoint.ApnsVoipSandboxChannel("apns_voip_sandbox", {
    applicationId: app.applicationId,
    certificate: fs.readFileSync("./certificate.pem", "utf-8"),
    privateKey: fs.readFileSync("./private_key.key", "utf-8"),
});

constructor

new ApnsVoipSandboxChannel(name: string, args: ApnsVoipSandboxChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a ApnsVoipSandboxChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ApnsVoipSandboxChannelState, opts?: pulumi.CustomResourceOptions): ApnsVoipSandboxChannel

Get an existing ApnsVoipSandboxChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ApnsVoipSandboxChannel

Returns true if the given object is an instance of ApnsVoipSandboxChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property bundleId

public bundleId: pulumi.Output<string | undefined>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

public certificate: pulumi.Output<string | undefined>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

public defaultAuthenticationMethod: pulumi.Output<string | undefined>;

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property privateKey

public privateKey: pulumi.Output<string | undefined>;

The Certificate Private Key file (ie. .key file).

property teamId

public teamId: pulumi.Output<string | undefined>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

public tokenKey: pulumi.Output<string | undefined>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

public tokenKeyId: pulumi.Output<string | undefined>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource App

class App extends CustomResource

Provides a Pinpoint App resource.

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: {
        end: "06:00",
        start: "00:00",
    },
});

constructor

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

Create a App resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AppState, opts?: pulumi.CustomResourceOptions): App

Get an existing App resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is App

Returns true if the given object is an instance of App. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The Application ID of the Pinpoint App.

property arn

public arn: pulumi.Output<string>;

Amazon Resource Name (ARN) of the PinPoint Application

property campaignHook

public campaignHook: pulumi.Output<AppCampaignHook | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property limits

public limits: pulumi.Output<AppLimits | undefined>;

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

property name

public name: pulumi.Output<string>;

The application name. By default generated by this provider

property namePrefix

public namePrefix: pulumi.Output<string | undefined>;

The name of the Pinpoint application. Conflicts with name

property quietTime

public quietTime: pulumi.Output<AppQuietTime | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: any} | undefined>;

Key-value map of resource tags

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource BaiduChannel

class BaiduChannel extends CustomResource

Provides a Pinpoint Baidu Channel resource.

Note: All arguments including the Api Key and Secret Key will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const channel = new aws.pinpoint.BaiduChannel("channel", {
    apiKey: "",
    applicationId: app.applicationId,
    secretKey: "",
});

constructor

new BaiduChannel(name: string, args: BaiduChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a BaiduChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: BaiduChannelState, opts?: pulumi.CustomResourceOptions): BaiduChannel

Get an existing BaiduChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is BaiduChannel

Returns true if the given object is an instance of BaiduChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiKey

public apiKey: pulumi.Output<string>;

Platform credential API key from Baidu.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Specifies whether to enable the channel. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property secretKey

public secretKey: pulumi.Output<string>;

Platform credential Secret key from Baidu.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EmailChannel

class EmailChannel extends CustomResource

Provides a Pinpoint Email Channel resource.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const identity = new aws.ses.DomainIdentity("identity", {
    domain: "example.com",
});
const role = new aws.iam.Role("role", {
    assumeRolePolicy: `{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "pinpoint.amazonaws.com"
      },
      "Effect": "Allow",
      "Sid": ""
    }
  ]
}
`,
});
const email = new aws.pinpoint.EmailChannel("email", {
    applicationId: app.applicationId,
    fromAddress: "user@example.com",
    identity: identity.arn,
    roleArn: role.arn,
});
const rolePolicy = new aws.iam.RolePolicy("role_policy", {
    policy: `{
  "Version": "2012-10-17",
  "Statement": {
    "Action": [
      "mobileanalytics:PutEvents",
      "mobileanalytics:PutItems"
    ],
    "Effect": "Allow",
    "Resource": [
      "*"
    ]
  }
}
`,
    role: role.id,
});

constructor

new EmailChannel(name: string, args: EmailChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a EmailChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EmailChannelState, opts?: pulumi.CustomResourceOptions): EmailChannel

Get an existing EmailChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EmailChannel

Returns true if the given object is an instance of EmailChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property fromAddress

public fromAddress: pulumi.Output<string>;

The email address used to send emails from.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<string>;

The ARN of an identity verified with SES.

property messagesPerSecond

public messagesPerSecond: pulumi.Output<number>;

Messages per second that can be sent.

property roleArn

public roleArn: pulumi.Output<string>;

The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource EventStream

class EventStream extends CustomResource

Provides a Pinpoint Event Stream resource.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const testStream = new aws.kinesis.Stream("test_stream", {
    shardCount: 1,
});
const testRole = new aws.iam.Role("test_role", {
    assumeRolePolicy: `{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "pinpoint.us-east-1.amazonaws.com"
      },
      "Effect": "Allow",
      "Sid": ""
    }
  ]
}
`,
});
const stream = new aws.pinpoint.EventStream("stream", {
    applicationId: app.applicationId,
    destinationStreamArn: testStream.arn,
    roleArn: testRole.arn,
});
const testRolePolicy = new aws.iam.RolePolicy("test_role_policy", {
    policy: `{
  "Version": "2012-10-17",
  "Statement": {
    "Action": [
      "kinesis:PutRecords",
      "kinesis:DescribeStream"
    ],
    "Effect": "Allow",
    "Resource": [
      "arn:aws:kinesis:us-east-1:*:*&#47;*"
    ]
  }
}
`,
    role: testRole.id,
});

constructor

new EventStream(name: string, args: EventStreamArgs, opts?: pulumi.CustomResourceOptions)

Create a EventStream resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: EventStreamState, opts?: pulumi.CustomResourceOptions): EventStream

Get an existing EventStream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is EventStream

Returns true if the given object is an instance of EventStream. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property destinationStreamArn

public destinationStreamArn: pulumi.Output<string>;

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property roleArn

public roleArn: pulumi.Output<string>;

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource GcmChannel

class GcmChannel extends CustomResource

Provides a Pinpoint GCM Channel resource.

Note: Api Key argument will be stored in the raw state as plain-text.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const gcm = new aws.pinpoint.GcmChannel("gcm", {
    apiKey: "api_key",
    applicationId: app.applicationId,
});

constructor

new GcmChannel(name: string, args: GcmChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a GcmChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GcmChannelState, opts?: pulumi.CustomResourceOptions): GcmChannel

Get an existing GcmChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is GcmChannel

Returns true if the given object is an instance of GcmChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiKey

public apiKey: pulumi.Output<string>;

Platform credential API key from Google.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource SmsChannel

class SmsChannel extends CustomResource

Provides a Pinpoint SMS Channel resource.

Example Usage

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

const app = new aws.pinpoint.App("app", {});
const sms = new aws.pinpoint.SmsChannel("sms", {
    applicationId: app.applicationId,
});

constructor

new SmsChannel(name: string, args: SmsChannelArgs, opts?: pulumi.CustomResourceOptions)

Create a SmsChannel resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: SmsChannelState, opts?: pulumi.CustomResourceOptions): SmsChannel

Get an existing SmsChannel resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is SmsChannel

Returns true if the given object is an instance of SmsChannel. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property applicationId

public applicationId: pulumi.Output<string>;

The application ID.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

Whether the channel is enabled or disabled. Defaults to true.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property promotionalMessagesPerSecond

public promotionalMessagesPerSecond: pulumi.Output<number>;

Promotional messages per second that can be sent.

property senderId

public senderId: pulumi.Output<string | undefined>;

Sender identifier of your messages.

property shortCode

public shortCode: pulumi.Output<string | undefined>;

The Short Code registered with the phone provider.

property transactionalMessagesPerSecond

public transactionalMessagesPerSecond: pulumi.Output<number>;

Transactional messages per second that can be sent.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface AdmChannelArgs

interface AdmChannelArgs

The set of arguments for constructing a AdmChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property clientId

clientId: pulumi.Input<string>;

Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.

property clientSecret

clientSecret: pulumi.Input<string>;

Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether to enable the channel. Defaults to true.

interface AdmChannelState

interface AdmChannelState

Input properties used for looking up and filtering AdmChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property clientId

clientId?: pulumi.Input<string>;

Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.

property clientSecret

clientSecret?: pulumi.Input<string>;

Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether to enable the channel. Defaults to true.

interface ApnsChannelArgs

interface ApnsChannelArgs

The set of arguments for constructing a ApnsChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsChannelState

interface ApnsChannelState

Input properties used for looking up and filtering ApnsChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsSandboxChannelArgs

interface ApnsSandboxChannelArgs

The set of arguments for constructing a ApnsSandboxChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsSandboxChannelState

interface ApnsSandboxChannelState

Input properties used for looking up and filtering ApnsSandboxChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsVoipChannelArgs

interface ApnsVoipChannelArgs

The set of arguments for constructing a ApnsVoipChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsVoipChannelState

interface ApnsVoipChannelState

Input properties used for looking up and filtering ApnsVoipChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsVoipSandboxChannelArgs

interface ApnsVoipSandboxChannelArgs

The set of arguments for constructing a ApnsVoipSandboxChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface ApnsVoipSandboxChannelState

interface ApnsVoipSandboxChannelState

Input properties used for looking up and filtering ApnsVoipSandboxChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property bundleId

bundleId?: pulumi.Input<string>;

The ID assigned to your iOS app. To find this value, choose Certificates, IDs & Profiles, choose App IDs in the Identifiers section, and choose your app.

property certificate

certificate?: pulumi.Input<string>;

The pem encoded TLS Certificate from Apple.

property defaultAuthenticationMethod

defaultAuthenticationMethod?: pulumi.Input<string>;

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property privateKey

privateKey?: pulumi.Input<string>;

The Certificate Private Key file (ie. .key file).

property teamId

teamId?: pulumi.Input<string>;

The ID assigned to your Apple developer account team. This value is provided on the Membership page.

property tokenKey

tokenKey?: pulumi.Input<string>;

The .p8 file that you download from your Apple developer account when you create an authentication key.

property tokenKeyId

tokenKeyId?: pulumi.Input<string>;

The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

interface AppArgs

interface AppArgs

The set of arguments for constructing a App resource.

property campaignHook

campaignHook?: pulumi.Input<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

property limits

limits?: pulumi.Input<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

property name

name?: pulumi.Input<string>;

The application name. By default generated by this provider

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the Pinpoint application. Conflicts with name

property quietTime

quietTime?: pulumi.Input<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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface AppState

interface AppState

Input properties used for looking up and filtering App resources.

property applicationId

applicationId?: pulumi.Input<string>;

The Application ID of the Pinpoint App.

property arn

arn?: pulumi.Input<string>;

Amazon Resource Name (ARN) of the PinPoint Application

property campaignHook

campaignHook?: pulumi.Input<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

property limits

limits?: pulumi.Input<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

property name

name?: pulumi.Input<string>;

The application name. By default generated by this provider

property namePrefix

namePrefix?: pulumi.Input<string>;

The name of the Pinpoint application. Conflicts with name

property quietTime

quietTime?: pulumi.Input<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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

Key-value map of resource tags

interface BaiduChannelArgs

interface BaiduChannelArgs

The set of arguments for constructing a BaiduChannel resource.

property apiKey

apiKey: pulumi.Input<string>;

Platform credential API key from Baidu.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether to enable the channel. Defaults to true.

property secretKey

secretKey: pulumi.Input<string>;

Platform credential Secret key from Baidu.

interface BaiduChannelState

interface BaiduChannelState

Input properties used for looking up and filtering BaiduChannel resources.

property apiKey

apiKey?: pulumi.Input<string>;

Platform credential API key from Baidu.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Specifies whether to enable the channel. Defaults to true.

property secretKey

secretKey?: pulumi.Input<string>;

Platform credential Secret key from Baidu.

interface EmailChannelArgs

interface EmailChannelArgs

The set of arguments for constructing a EmailChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property fromAddress

fromAddress: pulumi.Input<string>;

The email address used to send emails from.

property identity

identity: pulumi.Input<string>;

The ARN of an identity verified with SES.

property roleArn

roleArn: pulumi.Input<string>;

The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

interface EmailChannelState

interface EmailChannelState

Input properties used for looking up and filtering EmailChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property fromAddress

fromAddress?: pulumi.Input<string>;

The email address used to send emails from.

property identity

identity?: pulumi.Input<string>;

The ARN of an identity verified with SES.

property messagesPerSecond

messagesPerSecond?: pulumi.Input<number>;

Messages per second that can be sent.

property roleArn

roleArn?: pulumi.Input<string>;

The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

interface EventStreamArgs

interface EventStreamArgs

The set of arguments for constructing a EventStream resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property destinationStreamArn

destinationStreamArn: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.

property roleArn

roleArn: pulumi.Input<string>;

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

interface EventStreamState

interface EventStreamState

Input properties used for looking up and filtering EventStream resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property destinationStreamArn

destinationStreamArn?: pulumi.Input<string>;

The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.

property roleArn

roleArn?: pulumi.Input<string>;

The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

interface GcmChannelArgs

interface GcmChannelArgs

The set of arguments for constructing a GcmChannel resource.

property apiKey

apiKey: pulumi.Input<string>;

Platform credential API key from Google.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

interface GcmChannelState

interface GcmChannelState

Input properties used for looking up and filtering GcmChannel resources.

property apiKey

apiKey?: pulumi.Input<string>;

Platform credential API key from Google.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

interface SmsChannelArgs

interface SmsChannelArgs

The set of arguments for constructing a SmsChannel resource.

property applicationId

applicationId: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property senderId

senderId?: pulumi.Input<string>;

Sender identifier of your messages.

property shortCode

shortCode?: pulumi.Input<string>;

The Short Code registered with the phone provider.

interface SmsChannelState

interface SmsChannelState

Input properties used for looking up and filtering SmsChannel resources.

property applicationId

applicationId?: pulumi.Input<string>;

The application ID.

property enabled

enabled?: pulumi.Input<boolean>;

Whether the channel is enabled or disabled. Defaults to true.

property promotionalMessagesPerSecond

promotionalMessagesPerSecond?: pulumi.Input<number>;

Promotional messages per second that can be sent.

property senderId

senderId?: pulumi.Input<string>;

Sender identifier of your messages.

property shortCode

shortCode?: pulumi.Input<string>;

The Short Code registered with the phone provider.

property transactionalMessagesPerSecond

transactionalMessagesPerSecond?: pulumi.Input<number>;

Transactional messages per second that can be sent.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module pinpoint

Resources

Others

Resources

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage

Example Usage