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.

pinpoint¶

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.

class pulumi_aws.pinpoint.AdmChannel(resource_name, opts=None, application_id=None, client_id=None, client_secret=None, enabled=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
channel = aws.pinpoint.AdmChannel("channel",
    application_id=app.application_id,
    client_id="",
    client_secret="",
    enabled=True)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
client_id (pulumi.Input[str]) – Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
client_secret (pulumi.Input[str]) – Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
enabled (pulumi.Input[bool]) – Specifies whether to enable the channel. Defaults to true.

application_id: pulumi.Output[str] = None¶: The application ID.

client_id: pulumi.Output[str] = None¶: Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.

client_secret: pulumi.Output[str] = None¶: Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.

enabled: pulumi.Output[bool] = None¶: Specifies whether to enable the channel. Defaults to true.

static get(resource_name, id, opts=None, application_id=None, client_id=None, client_secret=None, enabled=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
client_id (pulumi.Input[str]) – Client ID (part of OAuth Credentials) obtained via Amazon Developer Account.
client_secret (pulumi.Input[str]) – Client Secret (part of OAuth Credentials) obtained via Amazon Developer Account.
enabled (pulumi.Input[bool]) – Specifies whether to enable the channel. Defaults to true.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.ApnsChannel(resource_name, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint APNs Channel resource.

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

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
apns = aws.pinpoint.ApnsChannel("apns",
    application_id=app.application_id,
    certificate=(lambda path: open(path).read())("./certificate.pem"),
    private_key=(lambda path: open(path).read())("./private_key.key"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

application_id: pulumi.Output[str] = None¶: The application ID.

bundle_id: pulumi.Output[str] = None¶: 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.

certificate: pulumi.Output[str] = None¶: The pem encoded TLS Certificate from Apple.

default_authentication_method: pulumi.Output[str] = None¶: 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.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

private_key: pulumi.Output[str] = None¶: The Certificate Private Key file (ie. .key file).

team_id: pulumi.Output[str] = None¶: The ID assigned to your Apple developer account team. This value is provided on the Membership page.

token_key: pulumi.Output[str] = None¶: The .p8 file that you download from your Apple developer account when you create an authentication key.

token_key_id: pulumi.Output[str] = None¶: The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

static get(resource_name, id, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.ApnsSandboxChannel(resource_name, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint APNs Sandbox Channel resource.

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

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
apns_sandbox = aws.pinpoint.ApnsSandboxChannel("apnsSandbox",
    application_id=app.application_id,
    certificate=(lambda path: open(path).read())("./certificate.pem"),
    private_key=(lambda path: open(path).read())("./private_key.key"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

application_id: pulumi.Output[str] = None¶: The application ID.

bundle_id: pulumi.Output[str] = None¶: 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.

certificate: pulumi.Output[str] = None¶: The pem encoded TLS Certificate from Apple.

default_authentication_method: pulumi.Output[str] = None¶: 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.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

private_key: pulumi.Output[str] = None¶: The Certificate Private Key file (ie. .key file).

team_id: pulumi.Output[str] = None¶: The ID assigned to your Apple developer account team. This value is provided on the Membership page.

token_key: pulumi.Output[str] = None¶: The .p8 file that you download from your Apple developer account when you create an authentication key.

token_key_id: pulumi.Output[str] = None¶: The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.ApnsVoipChannel(resource_name, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint APNs VoIP Channel resource.

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

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
apns_voip = aws.pinpoint.ApnsVoipChannel("apnsVoip",
    application_id=app.application_id,
    certificate=(lambda path: open(path).read())("./certificate.pem"),
    private_key=(lambda path: open(path).read())("./private_key.key"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

application_id: pulumi.Output[str] = None¶: The application ID.

bundle_id: pulumi.Output[str] = None¶: 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.

certificate: pulumi.Output[str] = None¶: The pem encoded TLS Certificate from Apple.

default_authentication_method: pulumi.Output[str] = None¶: 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.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

private_key: pulumi.Output[str] = None¶: The Certificate Private Key file (ie. .key file).

team_id: pulumi.Output[str] = None¶: The ID assigned to your Apple developer account team. This value is provided on the Membership page.

token_key: pulumi.Output[str] = None¶: The .p8 file that you download from your Apple developer account when you create an authentication key.

token_key_id: pulumi.Output[str] = None¶: The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.ApnsVoipSandboxChannel(resource_name, opts=None, application_id=None, bundle_id=None, certificate=None, default_authentication_method=None, enabled=None, private_key=None, team_id=None, token_key=None, token_key_id=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
apns_voip_sandbox = aws.pinpoint.ApnsVoipSandboxChannel("apnsVoipSandbox",
    application_id=app.application_id,
    certificate=(lambda path: open(path).read())("./certificate.pem"),
    private_key=(lambda path: open(path).read())("./private_key.key"))

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

application_id: pulumi.Output[str] = None¶: The application ID.

bundle_id: pulumi.Output[str] = None¶: 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.

certificate: pulumi.Output[str] = None¶: The pem encoded TLS Certificate from Apple.

default_authentication_method: pulumi.Output[str] = None¶: 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.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

private_key: pulumi.Output[str] = None¶: The Certificate Private Key file (ie. .key file).

team_id: pulumi.Output[str] = None¶: The ID assigned to your Apple developer account team. This value is provided on the Membership page.

token_key: pulumi.Output[str] = None¶: The .p8 file that you download from your Apple developer account when you create an authentication key.

token_key_id: pulumi.Output[str] = None¶: The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
bundle_id (pulumi.Input[str]) – 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.
certificate (pulumi.Input[str]) – The pem encoded TLS Certificate from Apple.
default_authentication_method (pulumi.Input[str]) – 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.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
private_key (pulumi.Input[str]) – The Certificate Private Key file (ie. .key file).
team_id (pulumi.Input[str]) – The ID assigned to your Apple developer account team. This value is provided on the Membership page.
token_key (pulumi.Input[str]) – The .p8 file that you download from your Apple developer account when you create an authentication key.
token_key_id (pulumi.Input[str]) – The ID assigned to your signing key. To find this value, choose Certificates, IDs & Profiles, and choose your key in the Keys section.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.App(resource_name, opts=None, campaign_hook=None, limits=None, name=None, name_prefix=None, quiet_time=None, tags=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint App resource.

import pulumi
import pulumi_aws as aws

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

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
campaign_hook (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – 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 (pulumi.Input[str]) – The application name. By default generated by this provider
name_prefix (pulumi.Input[str]) – The name of the Pinpoint application. Conflicts with name
quiet_time (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – Key-value map of resource tags

The campaign_hook object supports the following:

lambdaFunctionName (pulumi.Input[str]) - Lambda function name or ARN to be called for delivery. Conflicts with web_url
mode (pulumi.Input[str]) - What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
webUrl (pulumi.Input[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

The limits object supports the following:

daily (pulumi.Input[float]) - The maximum number of messages that the campaign can send daily.
maximumDuration (pulumi.Input[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 (pulumi.Input[float]) - The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
total (pulumi.Input[float]) - The maximum total number of messages that the campaign can send.

The quiet_time object supports the following:

end (pulumi.Input[str]) - The default end time for quiet time in ISO 8601 format. Required if start is set
start (pulumi.Input[str]) - The default start time for quiet time in ISO 8601 format. Required if end is set

application_id: pulumi.Output[str] = None¶: The Application ID of the Pinpoint App.

arn: pulumi.Output[str] = None¶: Amazon Resource Name (ARN) of the PinPoint Application

campaign_hook: pulumi.Output[dict] = None¶

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

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

limits: pulumi.Output[dict] = None¶

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

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.

name: pulumi.Output[str] = None¶: The application name. By default generated by this provider

name_prefix: pulumi.Output[str] = None¶: The name of the Pinpoint application. Conflicts with name

quiet_time: pulumi.Output[dict] = None¶

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

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

tags: pulumi.Output[dict] = None¶: Key-value map of resource tags

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

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The Application ID of the Pinpoint App.
arn (pulumi.Input[str]) – Amazon Resource Name (ARN) of the PinPoint Application
campaign_hook (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – 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 (pulumi.Input[str]) – The application name. By default generated by this provider
name_prefix (pulumi.Input[str]) – The name of the Pinpoint application. Conflicts with name
quiet_time (pulumi.Input[dict]) – 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 (pulumi.Input[dict]) – Key-value map of resource tags

The campaign_hook object supports the following:

lambdaFunctionName (pulumi.Input[str]) - Lambda function name or ARN to be called for delivery. Conflicts with web_url
mode (pulumi.Input[str]) - What mode Lambda should be invoked in. Valid values for this parameter are DELIVERY, FILTER.
webUrl (pulumi.Input[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

The limits object supports the following:

daily (pulumi.Input[float]) - The maximum number of messages that the campaign can send daily.
maximumDuration (pulumi.Input[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 (pulumi.Input[float]) - The number of messages that the campaign can send per second. The minimum value is 50, and the maximum is 20000.
total (pulumi.Input[float]) - The maximum total number of messages that the campaign can send.

The quiet_time object supports the following:

end (pulumi.Input[str]) - The default end time for quiet time in ISO 8601 format. Required if start is set
start (pulumi.Input[str]) - The default start time for quiet time in ISO 8601 format. Required if end is set

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.BaiduChannel(resource_name, opts=None, api_key=None, application_id=None, enabled=None, secret_key=None, __props__=None, __name__=None, __opts__=None)¶

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.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
channel = aws.pinpoint.BaiduChannel("channel",
    api_key="",
    application_id=app.application_id,
    secret_key="")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
api_key (pulumi.Input[str]) – Platform credential API key from Baidu.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Specifies whether to enable the channel. Defaults to true.
secret_key (pulumi.Input[str]) – Platform credential Secret key from Baidu.

api_key: pulumi.Output[str] = None¶: Platform credential API key from Baidu.

application_id: pulumi.Output[str] = None¶: The application ID.

enabled: pulumi.Output[bool] = None¶: Specifies whether to enable the channel. Defaults to true.

secret_key: pulumi.Output[str] = None¶: Platform credential Secret key from Baidu.

static get(resource_name, id, opts=None, api_key=None, application_id=None, enabled=None, secret_key=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
api_key (pulumi.Input[str]) – Platform credential API key from Baidu.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Specifies whether to enable the channel. Defaults to true.
secret_key (pulumi.Input[str]) – Platform credential Secret key from Baidu.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.EmailChannel(resource_name, opts=None, application_id=None, enabled=None, from_address=None, identity=None, role_arn=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint Email Channel resource.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
identity = aws.ses.DomainIdentity("identity", domain="example.com")
role = aws.iam.Role("role", assume_role_policy="""{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "pinpoint.amazonaws.com"
      },
      "Effect": "Allow",
      "Sid": ""
    }
  ]
}

""")
email = aws.pinpoint.EmailChannel("email",
    application_id=app.application_id,
    from_address="user@example.com",
    identity=identity.arn,
    role_arn=role.arn)
role_policy = aws.iam.RolePolicy("rolePolicy",
    policy="""{
  "Version": "2012-10-17",
  "Statement": {
    "Action": [
      "mobileanalytics:PutEvents",
      "mobileanalytics:PutItems"
    ],
    "Effect": "Allow",
    "Resource": [
      "*"
    ]
  }
}

""",
    role=role.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
from_address (pulumi.Input[str]) – The email address used to send emails from.
identity (pulumi.Input[str]) – The ARN of an identity verified with SES.
role_arn (pulumi.Input[str]) – The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

application_id: pulumi.Output[str] = None¶: The application ID.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

from_address: pulumi.Output[str] = None¶: The email address used to send emails from.

identity: pulumi.Output[str] = None¶: The ARN of an identity verified with SES.

messages_per_second: pulumi.Output[float] = None¶: Messages per second that can be sent.

role_arn: pulumi.Output[str] = None¶: The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

static get(resource_name, id, opts=None, application_id=None, enabled=None, from_address=None, identity=None, messages_per_second=None, role_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
from_address (pulumi.Input[str]) – The email address used to send emails from.
identity (pulumi.Input[str]) – The ARN of an identity verified with SES.
messages_per_second (pulumi.Input[float]) – Messages per second that can be sent.
role_arn (pulumi.Input[str]) – The ARN of an IAM Role used to submit events to Mobile Analytics’ event ingestion service.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.EventStream(resource_name, opts=None, application_id=None, destination_stream_arn=None, role_arn=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint Event Stream resource.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
test_stream = aws.kinesis.Stream("testStream", shard_count=1)
test_role = aws.iam.Role("testRole", assume_role_policy="""{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Action": "sts:AssumeRole",
      "Principal": {
        "Service": "pinpoint.us-east-1.amazonaws.com"
      },
      "Effect": "Allow",
      "Sid": ""
    }
  ]
}

""")
stream = aws.pinpoint.EventStream("stream",
    application_id=app.application_id,
    destination_stream_arn=test_stream.arn,
    role_arn=test_role.arn)
test_role_policy = aws.iam.RolePolicy("testRolePolicy",
    policy="""{
  "Version": "2012-10-17",
  "Statement": {
    "Action": [
      "kinesis:PutRecords",
      "kinesis:DescribeStream"
    ],
    "Effect": "Allow",
    "Resource": [
      "arn:aws:kinesis:us-east-1:*:*/*"
    ]
  }
}

""",
    role=test_role.id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
destination_stream_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.
role_arn (pulumi.Input[str]) – The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

application_id: pulumi.Output[str] = None¶: The application ID.

destination_stream_arn: pulumi.Output[str] = None¶: The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.

role_arn: pulumi.Output[str] = None¶: The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

static get(resource_name, id, opts=None, application_id=None, destination_stream_arn=None, role_arn=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
destination_stream_arn (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the Amazon Kinesis stream or Firehose delivery stream to which you want to publish events.
role_arn (pulumi.Input[str]) – The IAM role that authorizes Amazon Pinpoint to publish events to the stream in your account.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.GcmChannel(resource_name, opts=None, api_key=None, application_id=None, enabled=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint GCM Channel resource.

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

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
gcm = aws.pinpoint.GcmChannel("gcm",
    api_key="api_key",
    application_id=app.application_id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
api_key (pulumi.Input[str]) – Platform credential API key from Google.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.

api_key: pulumi.Output[str] = None¶: Platform credential API key from Google.

application_id: pulumi.Output[str] = None¶: The application ID.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

static get(resource_name, id, opts=None, api_key=None, application_id=None, enabled=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
api_key (pulumi.Input[str]) – Platform credential API key from Google.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.pinpoint.SmsChannel(resource_name, opts=None, application_id=None, enabled=None, sender_id=None, short_code=None, __props__=None, __name__=None, __opts__=None)¶

Provides a Pinpoint SMS Channel resource.

import pulumi
import pulumi_aws as aws

app = aws.pinpoint.App("app")
sms = aws.pinpoint.SmsChannel("sms", application_id=app.application_id)

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
sender_id (pulumi.Input[str]) – Sender identifier of your messages.
short_code (pulumi.Input[str]) – The Short Code registered with the phone provider.

application_id: pulumi.Output[str] = None¶: The application ID.

enabled: pulumi.Output[bool] = None¶: Whether the channel is enabled or disabled. Defaults to true.

promotional_messages_per_second: pulumi.Output[float] = None¶: Promotional messages per second that can be sent.

sender_id: pulumi.Output[str] = None¶: Sender identifier of your messages.

short_code: pulumi.Output[str] = None¶: The Short Code registered with the phone provider.

transactional_messages_per_second: pulumi.Output[float] = None¶: Transactional messages per second that can be sent.

static get(resource_name, id, opts=None, application_id=None, enabled=None, promotional_messages_per_second=None, sender_id=None, short_code=None, transactional_messages_per_second=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
application_id (pulumi.Input[str]) – The application ID.
enabled (pulumi.Input[bool]) – Whether the channel is enabled or disabled. Defaults to true.
promotional_messages_per_second (pulumi.Input[float]) – Promotional messages per second that can be sent.
sender_id (pulumi.Input[str]) – Sender identifier of your messages.
short_code (pulumi.Input[str]) – The Short Code registered with the phone provider.
transactional_messages_per_second (pulumi.Input[float]) – Transactional messages per second that can be sent.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

pinpoint¶

On This Page