1. Packages
  2. AWS Native
  3. API Docs
  4. pinpoint
  5. InAppTemplate

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

aws-native.pinpoint.InAppTemplate

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi

    Resource Type definition for AWS::Pinpoint::InAppTemplate

    Create InAppTemplate Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new InAppTemplate(name: string, args?: InAppTemplateArgs, opts?: CustomResourceOptions);
    @overload
    def InAppTemplate(resource_name: str,
                      args: Optional[InAppTemplateArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def InAppTemplate(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      content: Optional[Sequence[InAppTemplateInAppMessageContentArgs]] = None,
                      custom_config: Optional[Any] = None,
                      layout: Optional[InAppTemplateLayout] = None,
                      tags: Optional[Any] = None,
                      template_description: Optional[str] = None,
                      template_name: Optional[str] = None)
    func NewInAppTemplate(ctx *Context, name string, args *InAppTemplateArgs, opts ...ResourceOption) (*InAppTemplate, error)
    public InAppTemplate(string name, InAppTemplateArgs? args = null, CustomResourceOptions? opts = null)
    public InAppTemplate(String name, InAppTemplateArgs args)
    public InAppTemplate(String name, InAppTemplateArgs args, CustomResourceOptions options)
    
    type: aws-native:pinpoint:InAppTemplate
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args InAppTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args InAppTemplateArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args InAppTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args InAppTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args InAppTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    InAppTemplate Resource Properties

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

    Inputs

    The InAppTemplate resource accepts the following input properties:

    Content List<Pulumi.AwsNative.Pinpoint.Inputs.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.
    TemplateName string
    The name of the in-app message template.
    Content []InAppTemplateInAppMessageContentArgs
    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.
    TemplateName string
    The name of the in-app 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.
    templateName String
    The name of the in-app 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.
    templateName string
    The name of the in-app message template.
    content Sequence[InAppTemplateInAppMessageContentArgs]
    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.
    template_name str
    The name of the in-app 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.

    layout "BOTTOM_BANNER" | "TOP_BANNER" | "OVERLAYS" | "MOBILE_FEED" | "MIDDLE_BANNER" | "CAROUSEL"
    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.
    templateName String
    The name of the in-app message template.

    Outputs

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

    Arn string
    The Amazon Resource Name (ARN) of the message template.
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    The Amazon Resource Name (ARN) of the message template.
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the message template.
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    The Amazon Resource Name (ARN) of the message template.
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    The Amazon Resource Name (ARN) of the message template.
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    The Amazon Resource Name (ARN) of the message template.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    InAppTemplateAlignment, InAppTemplateAlignmentArgs

    Left
    LEFT
    Center
    CENTER
    Right
    RIGHT
    InAppTemplateAlignmentLeft
    LEFT
    InAppTemplateAlignmentCenter
    CENTER
    InAppTemplateAlignmentRight
    RIGHT
    Left
    LEFT
    Center
    CENTER
    Right
    RIGHT
    Left
    LEFT
    Center
    CENTER
    Right
    RIGHT
    LEFT
    LEFT
    CENTER
    CENTER
    RIGHT
    RIGHT
    "LEFT"
    LEFT
    "CENTER"
    CENTER
    "RIGHT"
    RIGHT

    InAppTemplateBodyConfig, InAppTemplateBodyConfigArgs

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

    Link
    LINK
    DeepLink
    DEEP_LINK
    Close
    CLOSE
    InAppTemplateButtonActionLink
    LINK
    InAppTemplateButtonActionDeepLink
    DEEP_LINK
    InAppTemplateButtonActionClose
    CLOSE
    Link
    LINK
    DeepLink
    DEEP_LINK
    Close
    CLOSE
    Link
    LINK
    DeepLink
    DEEP_LINK
    Close
    CLOSE
    LINK
    LINK
    DEEP_LINK
    DEEP_LINK
    CLOSE
    CLOSE
    "LINK"
    LINK
    "DEEP_LINK"
    DEEP_LINK
    "CLOSE"
    CLOSE

    InAppTemplateButtonConfig, InAppTemplateButtonConfigArgs

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

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

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

    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.

    InAppTemplateLayout, InAppTemplateLayoutArgs

    BottomBanner
    BOTTOM_BANNER
    TopBanner
    TOP_BANNER
    Overlays
    OVERLAYS
    MobileFeed
    MOBILE_FEED
    MiddleBanner
    MIDDLE_BANNER
    Carousel
    CAROUSEL
    InAppTemplateLayoutBottomBanner
    BOTTOM_BANNER
    InAppTemplateLayoutTopBanner
    TOP_BANNER
    InAppTemplateLayoutOverlays
    OVERLAYS
    InAppTemplateLayoutMobileFeed
    MOBILE_FEED
    InAppTemplateLayoutMiddleBanner
    MIDDLE_BANNER
    InAppTemplateLayoutCarousel
    CAROUSEL
    BottomBanner
    BOTTOM_BANNER
    TopBanner
    TOP_BANNER
    Overlays
    OVERLAYS
    MobileFeed
    MOBILE_FEED
    MiddleBanner
    MIDDLE_BANNER
    Carousel
    CAROUSEL
    BottomBanner
    BOTTOM_BANNER
    TopBanner
    TOP_BANNER
    Overlays
    OVERLAYS
    MobileFeed
    MOBILE_FEED
    MiddleBanner
    MIDDLE_BANNER
    Carousel
    CAROUSEL
    BOTTOM_BANNER
    BOTTOM_BANNER
    TOP_BANNER
    TOP_BANNER
    OVERLAYS
    OVERLAYS
    MOBILE_FEED
    MOBILE_FEED
    MIDDLE_BANNER
    MIDDLE_BANNER
    CAROUSEL
    CAROUSEL
    "BOTTOM_BANNER"
    BOTTOM_BANNER
    "TOP_BANNER"
    TOP_BANNER
    "OVERLAYS"
    OVERLAYS
    "MOBILE_FEED"
    MOBILE_FEED
    "MIDDLE_BANNER"
    MIDDLE_BANNER
    "CAROUSEL"
    CAROUSEL

    InAppTemplateOverrideButtonConfiguration, InAppTemplateOverrideButtonConfigurationArgs

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

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi