AWS Native is in preview. AWS Classic is fully supported.
aws-native.pinpoint.InAppTemplate
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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.
Aws Native. Pinpoint. Inputs. In App Template In App Message Content> - Custom
Config object - Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - Layout
Pulumi.
Aws Native. Pinpoint. In App Template Layout - object
- Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - Template
Description string - Template
Name string
- Content
[]In
App Template In App Message Content Args - Custom
Config interface{} - Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - Layout
In
App Template Layout - interface{}
- Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - Template
Description string - Template
Name string
- content
List<In
App Template In App Message Content> - custom
Config Object - Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - layout
In
App Template Layout - Object
- Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - template
Description String - template
Name String
- content
In
App Template In App Message Content[] - custom
Config any - Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - layout
In
App Template Layout - any
- Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - template
Description string - template
Name string
- content
Sequence[In
App Template In App Message Content Args] - custom_
config Any - Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - layout
In
App Template Layout - 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>
- custom
Config 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"
- Any
- Search the CloudFormation User Guide for
AWS::Pinpoint::InAppTemplate
for more information about the expected schema for this property. - template
Description String - template
Name String
Outputs
All input properties are implicitly available as output properties. Additionally, the InAppTemplate resource produces the following output properties:
Supporting Types
InAppTemplateAlignment, InAppTemplateAlignmentArgs
- Left
- LEFT
- Center
- CENTER
- Right
- RIGHT
- In
App Template Alignment Left - LEFT
- In
App Template Alignment Center - CENTER
- In
App Template Alignment Right - 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
In
App Template Alignment - Body string
- Text
Color string
- alignment
In
App Template Alignment - body String
- text
Color String
- alignment
In
App Template Alignment - body string
- text
Color string
- alignment "LEFT" | "CENTER" | "RIGHT"
- body String
- text
Color String
InAppTemplateButtonAction, InAppTemplateButtonActionArgs
- Link
- LINK
- Deep
Link - DEEP_LINK
- Close
- CLOSE
- In
App Template Button Action Link - LINK
- In
App Template Button Action Deep Link - DEEP_LINK
- In
App Template Button Action Close - CLOSE
- Link
- LINK
- Deep
Link - DEEP_LINK
- Close
- CLOSE
- Link
- LINK
- Deep
Link - DEEP_LINK
- Close
- CLOSE
- LINK
- LINK
- DEEP_LINK
- DEEP_LINK
- CLOSE
- CLOSE
- "LINK"
- LINK
- "DEEP_LINK"
- DEEP_LINK
- "CLOSE"
- CLOSE
InAppTemplateButtonConfig, InAppTemplateButtonConfigArgs
- Android
Pulumi.
Aws Native. Pinpoint. Inputs. In App Template Override Button Configuration - Default
Config Pulumi.Aws Native. Pinpoint. Inputs. In App Template Default Button Configuration - Ios
Pulumi.
Aws Native. Pinpoint. Inputs. In App Template Override Button Configuration - Web
Pulumi.
Aws Native. Pinpoint. Inputs. In App Template Override Button Configuration
InAppTemplateDefaultButtonConfiguration, InAppTemplateDefaultButtonConfigurationArgs
- Background
Color string - Border
Radius int - Pulumi.
Aws Native. Pinpoint. In App Template Button Action - Link string
- Text string
- Text
Color string
- Background
Color string - Border
Radius int - In
App Template Button Action - Link string
- Text string
- Text
Color string
- background
Color String - border
Radius Integer - In
App Template Button Action - link String
- text String
- text
Color String
- background
Color string - border
Radius number - In
App Template Button Action - link string
- text string
- text
Color string
- background_
color str - border_
radius int - In
App Template Button Action - link str
- text str
- text_
color str
- background
Color String - border
Radius Number - "LINK" | "DEEP_LINK" | "CLOSE"
- link String
- text String
- text
Color String
InAppTemplateHeaderConfig, InAppTemplateHeaderConfigArgs
- Alignment
In
App Template Alignment - Header string
- Text
Color string
- alignment
In
App Template Alignment - header String
- text
Color String
- alignment
In
App Template Alignment - header string
- text
Color string
- alignment "LEFT" | "CENTER" | "RIGHT"
- header String
- text
Color String
InAppTemplateInAppMessageContent, InAppTemplateInAppMessageContentArgs
- Background
Color string - Body
Config Pulumi.Aws Native. Pinpoint. Inputs. In App Template Body Config - Header
Config Pulumi.Aws Native. Pinpoint. Inputs. In App Template Header Config - Image
Url string - Primary
Btn Pulumi.Aws Native. Pinpoint. Inputs. In App Template Button Config - Secondary
Btn Pulumi.Aws Native. Pinpoint. Inputs. In App Template Button Config
InAppTemplateLayout, InAppTemplateLayoutArgs
- Bottom
Banner - BOTTOM_BANNER
- Top
Banner - TOP_BANNER
- Overlays
- OVERLAYS
- Mobile
Feed - MOBILE_FEED
- Middle
Banner - MIDDLE_BANNER
- Carousel
- CAROUSEL
- In
App Template Layout Bottom Banner - BOTTOM_BANNER
- In
App Template Layout Top Banner - TOP_BANNER
- In
App Template Layout Overlays - OVERLAYS
- In
App Template Layout Mobile Feed - MOBILE_FEED
- In
App Template Layout Middle Banner - MIDDLE_BANNER
- In
App Template Layout 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
- 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
- In
App Template Button Action - Link string
- In
App Template Button Action - link String
- In
App Template Button Action - link string
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.