software.amazon.awscdk.services.pinpoint

Class CfnInAppTemplate

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.pinpoint.CfnInAppTemplate

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.46.0 (build cd08c55)",
           date="2021-11-25T20:11:07.478Z")
 @Stability(value=Stable)
public class CfnInAppTemplate
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Pinpoint::InAppTemplate`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.pinpoint.*;
 Object customConfig;
 Object tags;
 CfnInAppTemplate cfnInAppTemplate = CfnInAppTemplate.Builder.create(this, "MyCfnInAppTemplate")
         .templateName("templateName")
         // the properties below are optional
         .content(List.of(InAppMessageContentProperty.builder()
                 .backgroundColor("backgroundColor")
                 .bodyConfig(BodyConfigProperty.builder()
                         .alignment("alignment")
                         .body("body")
                         .textColor("textColor")
                         .build())
                 .headerConfig(HeaderConfigProperty.builder()
                         .alignment("alignment")
                         .header("header")
                         .textColor("textColor")
                         .build())
                 .imageUrl("imageUrl")
                 .primaryBtn(ButtonConfigProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .secondaryBtn(ButtonConfigProperty.builder()
                         .android(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .defaultConfig(DefaultButtonConfigurationProperty.builder()
                                 .backgroundColor("backgroundColor")
                                 .borderRadius(123)
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .text("text")
                                 .textColor("textColor")
                                 .build())
                         .ios(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .web(OverrideButtonConfigurationProperty.builder()
                                 .buttonAction("buttonAction")
                                 .link("link")
                                 .build())
                         .build())
                 .build()))
         .customConfig(customConfig)
         .layout("layout")
         .tags(tags)
         .templateDescription("templateDescription")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnInAppTemplate.BodyConfigProperty Example:
static class	CfnInAppTemplate.Builder A fluent builder for CfnInAppTemplate.
static interface	CfnInAppTemplate.ButtonConfigProperty Example:
static interface	CfnInAppTemplate.DefaultButtonConfigurationProperty Example:
static interface	CfnInAppTemplate.HeaderConfigProperty Example:
static interface	CfnInAppTemplate.InAppMessageContentProperty Example:
static interface	CfnInAppTemplate.OverrideButtonConfigurationProperty Example:

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnInAppTemplate(software.constructs.Construct scope, String id, CfnInAppTemplateProps props) Create a new `AWS::Pinpoint::InAppTemplate`.
protected	CfnInAppTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnInAppTemplate(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
protected Map<String,Object>	getCfnProperties()
Object	getContent() `AWS::Pinpoint::InAppTemplate.Content`.
Object	getCustomConfig() `AWS::Pinpoint::InAppTemplate.CustomConfig`.
String	getLayout() `AWS::Pinpoint::InAppTemplate.Layout`.
TagManager	getTags() `AWS::Pinpoint::InAppTemplate.Tags`.
String	getTemplateDescription() `AWS::Pinpoint::InAppTemplate.TemplateDescription`.
String	getTemplateName() `AWS::Pinpoint::InAppTemplate.TemplateName`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setContent(IResolvable value) `AWS::Pinpoint::InAppTemplate.Content`.
void	setContent(List<Object> value) `AWS::Pinpoint::InAppTemplate.Content`.
void	setCustomConfig(Object value) `AWS::Pinpoint::InAppTemplate.CustomConfig`.
void	setLayout(String value) `AWS::Pinpoint::InAppTemplate.Layout`.
void	setTemplateDescription(String value) `AWS::Pinpoint::InAppTemplate.TemplateDescription`.
void	setTemplateName(String value) `AWS::Pinpoint::InAppTemplate.TemplateName`.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnInAppTemplate

protected CfnInAppTemplate(software.amazon.jsii.JsiiObjectRef objRef)

CfnInAppTemplate

protected CfnInAppTemplate(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnInAppTemplate

@Stability(value=Stable)
public CfnInAppTemplate(@NotNull
                                                 software.constructs.Construct scope,
                                                 @NotNull
                                                 String id,
                                                 @NotNull
                                                 CfnInAppTemplateProps props)

Create a new `AWS::Pinpoint::InAppTemplate`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getContent

@Stability(value=Stable)
 @Nullable
public Object getContent()

`AWS::Pinpoint::InAppTemplate.Content`.

setContent

@Stability(value=Stable)
public void setContent(@Nullable
                                                IResolvable value)

`AWS::Pinpoint::InAppTemplate.Content`.

setContent

@Stability(value=Stable)
public void setContent(@Nullable
                                                List<Object> value)

`AWS::Pinpoint::InAppTemplate.Content`.

getCustomConfig

@Stability(value=Stable)
 @NotNull
public Object getCustomConfig()

`AWS::Pinpoint::InAppTemplate.CustomConfig`.

setCustomConfig

@Stability(value=Stable)
public void setCustomConfig(@NotNull
                                                     Object value)

`AWS::Pinpoint::InAppTemplate.CustomConfig`.

getLayout

@Stability(value=Stable)
 @Nullable
public String getLayout()

`AWS::Pinpoint::InAppTemplate.Layout`.

setLayout

@Stability(value=Stable)
public void setLayout(@Nullable
                                               String value)

`AWS::Pinpoint::InAppTemplate.Layout`.

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

`AWS::Pinpoint::InAppTemplate.Tags`.

getTemplateDescription

@Stability(value=Stable)
 @Nullable
public String getTemplateDescription()

`AWS::Pinpoint::InAppTemplate.TemplateDescription`.

setTemplateDescription

@Stability(value=Stable)
public void setTemplateDescription(@Nullable
                                                            String value)

`AWS::Pinpoint::InAppTemplate.TemplateDescription`.

getTemplateName

@Stability(value=Stable)
 @NotNull
public String getTemplateName()

`AWS::Pinpoint::InAppTemplate.TemplateName`.

setTemplateName

@Stability(value=Stable)
public void setTemplateName(@NotNull
                                                     String value)

`AWS::Pinpoint::InAppTemplate.TemplateName`.