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.101.0 published on Thursday, Apr 11, 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.101.0 published on Thursday, Apr 11, 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.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const inAppTemplateResource = new aws_native.pinpoint.InAppTemplate("inAppTemplateResource", {
        content: [{
            backgroundColor: "string",
            bodyConfig: {
                alignment: aws_native.pinpoint.InAppTemplateAlignment.Left,
                body: "string",
                textColor: "string",
            },
            headerConfig: {
                alignment: aws_native.pinpoint.InAppTemplateAlignment.Left,
                header: "string",
                textColor: "string",
            },
            imageUrl: "string",
            primaryBtn: {
                android: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
                defaultConfig: {
                    backgroundColor: "string",
                    borderRadius: 0,
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                    text: "string",
                    textColor: "string",
                },
                ios: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
                web: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
            },
            secondaryBtn: {
                android: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
                defaultConfig: {
                    backgroundColor: "string",
                    borderRadius: 0,
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                    text: "string",
                    textColor: "string",
                },
                ios: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
                web: {
                    buttonAction: aws_native.pinpoint.InAppTemplateButtonAction.Link,
                    link: "string",
                },
            },
        }],
        customConfig: "any",
        layout: aws_native.pinpoint.InAppTemplateLayout.BottomBanner,
        tags: "any",
        templateDescription: "string",
        templateName: "string",
    });
    
    Coming soon!
    

    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>
    CustomConfig object
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    Layout Pulumi.AwsNative.Pinpoint.InAppTemplateLayout
    Tags object
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    TemplateDescription string
    TemplateName string
    Content []InAppTemplateInAppMessageContentArgs
    CustomConfig interface{}
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    Layout InAppTemplateLayout
    Tags interface{}
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    TemplateDescription string
    TemplateName string
    content List<InAppTemplateInAppMessageContent>
    customConfig Object
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    layout InAppTemplateLayout
    tags Object
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    templateDescription String
    templateName String
    content InAppTemplateInAppMessageContent[]
    customConfig any
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    layout InAppTemplateLayout
    tags any
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    templateDescription string
    templateName string
    content Sequence[InAppTemplateInAppMessageContentArgs]
    custom_config Any
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    layout InAppTemplateLayout
    tags Any
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    template_description str
    template_name str
    content List<Property Map>
    customConfig Any
    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"
    tags Any
    Search the CloudFormation User Guide for AWS::Pinpoint::InAppTemplate for more information about the expected schema for this property.
    templateDescription String
    templateName String

    Outputs

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

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    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

    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

    InAppTemplateDefaultButtonConfiguration, InAppTemplateDefaultButtonConfigurationArgs

    InAppTemplateHeaderConfig, InAppTemplateHeaderConfigArgs

    InAppTemplateInAppMessageContent, InAppTemplateInAppMessageContentArgs

    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

    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.101.0 published on Thursday, Apr 11, 2024 by Pulumi