aws-native.pinpoint.getInAppTemplate

AWS Cloud Control v1.58.0, Mar 23 26

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

We recommend new projects start with resources from the AWS provider.

Viewing docs for AWS Cloud Control v1.58.0
published on Monday, Mar 23, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-aws-native

Using getInAppTemplate

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getInAppTemplate(args: GetInAppTemplateArgs, opts?: InvokeOptions): Promise<GetInAppTemplateResult>
function getInAppTemplateOutput(args: GetInAppTemplateOutputArgs, opts?: InvokeOptions): Output<GetInAppTemplateResult>

def get_in_app_template(template_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetInAppTemplateResult
def get_in_app_template_output(template_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetInAppTemplateResult]

func LookupInAppTemplate(ctx *Context, args *LookupInAppTemplateArgs, opts ...InvokeOption) (*LookupInAppTemplateResult, error)
func LookupInAppTemplateOutput(ctx *Context, args *LookupInAppTemplateOutputArgs, opts ...InvokeOption) LookupInAppTemplateResultOutput

> Note: This function is named LookupInAppTemplate in the Go SDK.

public static class GetInAppTemplate 
{
    public static Task<GetInAppTemplateResult> InvokeAsync(GetInAppTemplateArgs args, InvokeOptions? opts = null)
    public static Output<GetInAppTemplateResult> Invoke(GetInAppTemplateInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetInAppTemplateResult> getInAppTemplate(GetInAppTemplateArgs args, InvokeOptions options)
public static Output<GetInAppTemplateResult> getInAppTemplate(GetInAppTemplateArgs args, InvokeOptions options)

fn::invoke:
  function: aws-native:pinpoint:getInAppTemplate
  arguments:
    # arguments dictionary

The following arguments are supported:

TemplateName string: The name of the in-app message template.

TemplateName string: The name of the in-app message template.

templateName String: The name of the in-app message template.

templateName string: The name of the in-app message template.

template_name str: The name of the in-app message template.

templateName String: The name of the in-app message template.

getInAppTemplate Result

The following output properties are available:

Arn string

The Amazon Resource Name (ARN) of the message template.

Content List<Pulumi.AwsNative.Pinpoint.Outputs.InAppTemplateInAppMessageContent>

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

CustomConfig object

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

Layout Pulumi.AwsNative.Pinpoint.InAppTemplateLayout

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

Tags object

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

TemplateDescription string

An optional description of the in-app template.

Arn string

The Amazon Resource Name (ARN) of the message template.

Content []InAppTemplateInAppMessageContent

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

CustomConfig interface{}

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

Layout InAppTemplateLayout

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

Tags interface{}

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

TemplateDescription string

An optional description of the in-app template.

arn String

The Amazon Resource Name (ARN) of the message template.

content List<InAppTemplateInAppMessageContent>

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

customConfig Object

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

layout InAppTemplateLayout

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

tags Object

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

templateDescription String

An optional description of the in-app template.

arn string

The Amazon Resource Name (ARN) of the message template.

content InAppTemplateInAppMessageContent[]

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

customConfig any

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

layout InAppTemplateLayout

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

tags any

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

templateDescription string

An optional description of the in-app template.

arn str

The Amazon Resource Name (ARN) of the message template.

content Sequence[InAppTemplateInAppMessageContent]

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

custom_config Any

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

layout InAppTemplateLayout

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

tags Any

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

template_description str

An optional description of the in-app template.

arn String

The Amazon Resource Name (ARN) of the message template.

content List<Property Map>

An object that contains information about the content of an in-app message, including its title and body text, text colors, background colors, images, buttons, and behaviors.

customConfig Any

Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

A string that determines the appearance of the in-app message. You can specify one of the following:

BOTTOM_BANNER – a message that appears as a banner at the bottom of the page.
TOP_BANNER – a message that appears as a banner at the top of the page.
OVERLAYS – a message that covers entire screen.
MOBILE_FEED – a message that appears in a window in front of the page.
MIDDLE_BANNER – a message that appears as a banner in the middle of the page.
CAROUSEL – a scrollable layout of up to five unique messages.

tags Any

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.

templateDescription String

An optional description of the in-app template.

Supporting Types

InAppTemplateAlignment

InAppTemplateBodyConfig

Alignment Pulumi.AwsNative.Pinpoint.InAppTemplateAlignment: The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
Body string: The main body text of the message.
TextColor string: The color of the body text, expressed as a hex color code (such as #000000 for black).

Alignment InAppTemplateAlignment: The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
Body string: The main body text of the message.
TextColor string: The color of the body text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
body String: The main body text of the message.
textColor String: The color of the body text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
body string: The main body text of the message.
textColor string: The color of the body text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
body str: The main body text of the message.
text_color str: The color of the body text, expressed as a hex color code (such as #000000 for black).

alignment "LEFT" | "CENTER" | "RIGHT": The text alignment of the main body text of the message. Acceptable values: LEFT , CENTER , RIGHT .
body String: The main body text of the message.
textColor String: The color of the body text, expressed as a hex color code (such as #000000 for black).

InAppTemplateButtonAction

InAppTemplateButtonConfig

Android Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
DefaultConfig Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateDefaultButtonConfiguration: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
Ios Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
Web Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

Android InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
DefaultConfig InAppTemplateDefaultButtonConfiguration: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
Ios InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
Web InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

android InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
defaultConfig InAppTemplateDefaultButtonConfiguration: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
ios InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
web InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

android InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
defaultConfig InAppTemplateDefaultButtonConfiguration: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
ios InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
web InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

android InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
default_config InAppTemplateDefaultButtonConfiguration: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
ios InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
web InAppTemplateOverrideButtonConfiguration: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

android Property Map: Optional button configuration to use for in-app messages sent to Android devices. This button configuration overrides the default button configuration.
defaultConfig Property Map: Specifies the default behavior of a button that appears in an in-app message. You can optionally add button configurations that specifically apply to iOS, Android, or web browser users.
ios Property Map: Optional button configuration to use for in-app messages sent to iOS devices. This button configuration overrides the default button configuration.
web Property Map: Optional button configuration to use for in-app messages sent to web applications. This button configuration overrides the default button configuration.

InAppTemplateDefaultButtonConfiguration

BackgroundColor string

The background color of a button, expressed as a hex color code (such as #000000 for black).

BorderRadius int

The border radius of a button.

ButtonAction Pulumi.AwsNative.Pinpoint.InAppTemplateButtonAction

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

Link string

The destination (such as a URL) for a button.

Text string

The text that appears on a button in an in-app message.

TextColor string

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

BackgroundColor string

The background color of a button, expressed as a hex color code (such as #000000 for black).

BorderRadius int

The border radius of a button.

ButtonAction InAppTemplateButtonAction

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

Link string

The destination (such as a URL) for a button.

Text string

The text that appears on a button in an in-app message.

TextColor string

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

backgroundColor String

The background color of a button, expressed as a hex color code (such as #000000 for black).

borderRadius Integer

The border radius of a button.

buttonAction InAppTemplateButtonAction

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

link String

The destination (such as a URL) for a button.

text String

The text that appears on a button in an in-app message.

textColor String

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

backgroundColor string

The background color of a button, expressed as a hex color code (such as #000000 for black).

borderRadius number

The border radius of a button.

buttonAction InAppTemplateButtonAction

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

link string

The destination (such as a URL) for a button.

text string

The text that appears on a button in an in-app message.

textColor string

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

background_color str

The background color of a button, expressed as a hex color code (such as #000000 for black).

border_radius int

The border radius of a button.

button_action InAppTemplateButtonAction

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

link str

The destination (such as a URL) for a button.

text str

The text that appears on a button in an in-app message.

text_color str

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

backgroundColor String

The background color of a button, expressed as a hex color code (such as #000000 for black).

borderRadius Number

The border radius of a button.

buttonAction "LINK" | "DEEP_LINK" | "CLOSE"

The action that occurs when a recipient chooses a button in an in-app message. You can specify one of the following:

LINK – A link to a web destination.
DEEP_LINK – A link to a specific page in an application.
CLOSE – Dismisses the message.

link String

The destination (such as a URL) for a button.

text String

The text that appears on a button in an in-app message.

textColor String

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).

InAppTemplateHeaderConfig

Alignment Pulumi.AwsNative.Pinpoint.InAppTemplateAlignment: The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
Header string: The title text of the in-app message.
TextColor string: The color of the title text, expressed as a hex color code (such as #000000 for black).

Alignment InAppTemplateAlignment: The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
Header string: The title text of the in-app message.
TextColor string: The color of the title text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
header String: The title text of the in-app message.
textColor String: The color of the title text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
header string: The title text of the in-app message.
textColor string: The color of the title text, expressed as a hex color code (such as #000000 for black).

alignment InAppTemplateAlignment: The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
header str: The title text of the in-app message.
text_color str: The color of the title text, expressed as a hex color code (such as #000000 for black).

alignment "LEFT" | "CENTER" | "RIGHT": The text alignment of the title of the message. Acceptable values: LEFT , CENTER , RIGHT .
header String: The title text of the in-app message.
textColor String: The color of the title text, expressed as a hex color code (such as #000000 for black).

InAppTemplateInAppMessageContent

BackgroundColor string: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
BodyConfig Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateBodyConfig: An object that contains configuration information about the header or title text of the in-app message.
HeaderConfig Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateHeaderConfig: An object that contains configuration information about the header or title text of the in-app message.
ImageUrl string: The URL of the image that appears on an in-app message banner.
PrimaryBtn Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateButtonConfig: An object that contains configuration information about the primary button in an in-app message.
SecondaryBtn Pulumi.AwsNative.Pinpoint.Inputs.InAppTemplateButtonConfig: An object that contains configuration information about the secondary button in an in-app message.

BackgroundColor string: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
BodyConfig InAppTemplateBodyConfig: An object that contains configuration information about the header or title text of the in-app message.
HeaderConfig InAppTemplateHeaderConfig: An object that contains configuration information about the header or title text of the in-app message.
ImageUrl string: The URL of the image that appears on an in-app message banner.
PrimaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the primary button in an in-app message.
SecondaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the secondary button in an in-app message.

backgroundColor String: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
bodyConfig InAppTemplateBodyConfig: An object that contains configuration information about the header or title text of the in-app message.
headerConfig InAppTemplateHeaderConfig: An object that contains configuration information about the header or title text of the in-app message.
imageUrl String: The URL of the image that appears on an in-app message banner.
primaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the primary button in an in-app message.
secondaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the secondary button in an in-app message.

backgroundColor string: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
bodyConfig InAppTemplateBodyConfig: An object that contains configuration information about the header or title text of the in-app message.
headerConfig InAppTemplateHeaderConfig: An object that contains configuration information about the header or title text of the in-app message.
imageUrl string: The URL of the image that appears on an in-app message banner.
primaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the primary button in an in-app message.
secondaryBtn InAppTemplateButtonConfig: An object that contains configuration information about the secondary button in an in-app message.

background_color str: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
body_config InAppTemplateBodyConfig: An object that contains configuration information about the header or title text of the in-app message.
header_config InAppTemplateHeaderConfig: An object that contains configuration information about the header or title text of the in-app message.
image_url str: The URL of the image that appears on an in-app message banner.
primary_btn InAppTemplateButtonConfig: An object that contains configuration information about the primary button in an in-app message.
secondary_btn InAppTemplateButtonConfig: An object that contains configuration information about the secondary button in an in-app message.

backgroundColor String: The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
bodyConfig Property Map: An object that contains configuration information about the header or title text of the in-app message.
headerConfig Property Map: An object that contains configuration information about the header or title text of the in-app message.
imageUrl String: The URL of the image that appears on an in-app message banner.
primaryBtn Property Map: An object that contains configuration information about the primary button in an in-app message.
secondaryBtn Property Map: An object that contains configuration information about the secondary button in an in-app message.