aws-native.pinpoint.InAppTemplate

Explore with Pulumi AI

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

AWS Native v0.103.0 published on Monday, Apr 22, 2024 by Pulumi

pulumi/pulumi-aws-native

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.