awspinpoint

package
v2.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 13, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnADMChannel_CFN_RESOURCE_TYPE_NAME 

func CfnADMChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnADMChannel_IsCfnElement 

func CfnADMChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnADMChannel_IsCfnResource 

func CfnADMChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnADMChannel_IsConstruct 

func CfnADMChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAPNSChannel_CFN_RESOURCE_TYPE_NAME 

func CfnAPNSChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnAPNSChannel_IsCfnElement 

func CfnAPNSChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAPNSChannel_IsCfnResource 

func CfnAPNSChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAPNSChannel_IsConstruct 

func CfnAPNSChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAPNSSandboxChannel_CFN_RESOURCE_TYPE_NAME 

func CfnAPNSSandboxChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnAPNSSandboxChannel_IsCfnElement 

func CfnAPNSSandboxChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAPNSSandboxChannel_IsCfnResource 

func CfnAPNSSandboxChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAPNSSandboxChannel_IsConstruct 

func CfnAPNSSandboxChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAPNSVoipChannel_CFN_RESOURCE_TYPE_NAME 

func CfnAPNSVoipChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnAPNSVoipChannel_IsCfnElement 

func CfnAPNSVoipChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAPNSVoipChannel_IsCfnResource 

func CfnAPNSVoipChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAPNSVoipChannel_IsConstruct 

func CfnAPNSVoipChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnAPNSVoipSandboxChannel_CFN_RESOURCE_TYPE_NAME 

func CfnAPNSVoipSandboxChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnAPNSVoipSandboxChannel_IsCfnElement 

func CfnAPNSVoipSandboxChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnAPNSVoipSandboxChannel_IsCfnResource 

func CfnAPNSVoipSandboxChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnAPNSVoipSandboxChannel_IsConstruct 

func CfnAPNSVoipSandboxChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnApp_CFN_RESOURCE_TYPE_NAME 

func CfnApp_CFN_RESOURCE_TYPE_NAME() *string

func CfnApp_IsCfnElement 

func CfnApp_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApp_IsCfnResource 

func CfnApp_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApp_IsConstruct 

func CfnApp_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnApplicationSettings_CFN_RESOURCE_TYPE_NAME 

func CfnApplicationSettings_CFN_RESOURCE_TYPE_NAME() *string

func CfnApplicationSettings_IsCfnElement 

func CfnApplicationSettings_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnApplicationSettings_IsCfnResource 

func CfnApplicationSettings_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnApplicationSettings_IsConstruct 

func CfnApplicationSettings_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnBaiduChannel_CFN_RESOURCE_TYPE_NAME 

func CfnBaiduChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnBaiduChannel_IsCfnElement 

func CfnBaiduChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnBaiduChannel_IsCfnResource 

func CfnBaiduChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnBaiduChannel_IsConstruct 

func CfnBaiduChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnCampaign_CFN_RESOURCE_TYPE_NAME 

func CfnCampaign_CFN_RESOURCE_TYPE_NAME() *string

func CfnCampaign_IsCfnElement 

func CfnCampaign_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCampaign_IsCfnResource 

func CfnCampaign_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCampaign_IsConstruct 

func CfnCampaign_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEmailChannel_CFN_RESOURCE_TYPE_NAME 

func CfnEmailChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnEmailChannel_IsCfnElement 

func CfnEmailChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEmailChannel_IsCfnResource 

func CfnEmailChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEmailChannel_IsConstruct 

func CfnEmailChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEmailTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnEmailTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnEmailTemplate_IsCfnElement 

func CfnEmailTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEmailTemplate_IsCfnResource 

func CfnEmailTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEmailTemplate_IsConstruct 

func CfnEmailTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnEventStream_CFN_RESOURCE_TYPE_NAME 

func CfnEventStream_CFN_RESOURCE_TYPE_NAME() *string

func CfnEventStream_IsCfnElement 

func CfnEventStream_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnEventStream_IsCfnResource 

func CfnEventStream_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnEventStream_IsConstruct 

func CfnEventStream_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnGCMChannel_CFN_RESOURCE_TYPE_NAME 

func CfnGCMChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnGCMChannel_IsCfnElement 

func CfnGCMChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnGCMChannel_IsCfnResource 

func CfnGCMChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnGCMChannel_IsConstruct 

func CfnGCMChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnInAppTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnInAppTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnInAppTemplate_IsCfnElement 

func CfnInAppTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnInAppTemplate_IsCfnResource 

func CfnInAppTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnInAppTemplate_IsConstruct 

func CfnInAppTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnPushTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnPushTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnPushTemplate_IsCfnElement 

func CfnPushTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnPushTemplate_IsCfnResource 

func CfnPushTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnPushTemplate_IsConstruct 

func CfnPushTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnSMSChannel_CFN_RESOURCE_TYPE_NAME 

func CfnSMSChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnSMSChannel_IsCfnElement 

func CfnSMSChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSMSChannel_IsCfnResource 

func CfnSMSChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSMSChannel_IsConstruct 

func CfnSMSChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnSegment_CFN_RESOURCE_TYPE_NAME 

func CfnSegment_CFN_RESOURCE_TYPE_NAME() *string

func CfnSegment_IsCfnElement 

func CfnSegment_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSegment_IsCfnResource 

func CfnSegment_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSegment_IsConstruct 

func CfnSegment_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnSmsTemplate_CFN_RESOURCE_TYPE_NAME 

func CfnSmsTemplate_CFN_RESOURCE_TYPE_NAME() *string

func CfnSmsTemplate_IsCfnElement 

func CfnSmsTemplate_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSmsTemplate_IsCfnResource 

func CfnSmsTemplate_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSmsTemplate_IsConstruct 

func CfnSmsTemplate_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnVoiceChannel_CFN_RESOURCE_TYPE_NAME 

func CfnVoiceChannel_CFN_RESOURCE_TYPE_NAME() *string

func CfnVoiceChannel_IsCfnElement 

func CfnVoiceChannel_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnVoiceChannel_IsCfnResource 

func CfnVoiceChannel_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnVoiceChannel_IsConstruct 

func CfnVoiceChannel_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnADMChannel_Override 

func NewCfnADMChannel_Override(c CfnADMChannel, scope constructs.Construct, id *string, props *CfnADMChannelProps)

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

func NewCfnAPNSChannel_Override 

func NewCfnAPNSChannel_Override(c CfnAPNSChannel, scope constructs.Construct, id *string, props *CfnAPNSChannelProps)

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

func NewCfnAPNSSandboxChannel_Override 

func NewCfnAPNSSandboxChannel_Override(c CfnAPNSSandboxChannel, scope constructs.Construct, id *string, props *CfnAPNSSandboxChannelProps)

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

func NewCfnAPNSVoipChannel_Override 

func NewCfnAPNSVoipChannel_Override(c CfnAPNSVoipChannel, scope constructs.Construct, id *string, props *CfnAPNSVoipChannelProps)

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

func NewCfnAPNSVoipSandboxChannel_Override 

func NewCfnAPNSVoipSandboxChannel_Override(c CfnAPNSVoipSandboxChannel, scope constructs.Construct, id *string, props *CfnAPNSVoipSandboxChannelProps)

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

func NewCfnApp_Override 

func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)

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

func NewCfnApplicationSettings_Override 

func NewCfnApplicationSettings_Override(c CfnApplicationSettings, scope constructs.Construct, id *string, props *CfnApplicationSettingsProps)

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

func NewCfnBaiduChannel_Override 

func NewCfnBaiduChannel_Override(c CfnBaiduChannel, scope constructs.Construct, id *string, props *CfnBaiduChannelProps)

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

func NewCfnCampaign_Override 

func NewCfnCampaign_Override(c CfnCampaign, scope constructs.Construct, id *string, props *CfnCampaignProps)

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

func NewCfnEmailChannel_Override 

func NewCfnEmailChannel_Override(c CfnEmailChannel, scope constructs.Construct, id *string, props *CfnEmailChannelProps)

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

func NewCfnEmailTemplate_Override 

func NewCfnEmailTemplate_Override(c CfnEmailTemplate, scope constructs.Construct, id *string, props *CfnEmailTemplateProps)

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

func NewCfnEventStream_Override 

func NewCfnEventStream_Override(c CfnEventStream, scope constructs.Construct, id *string, props *CfnEventStreamProps)

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

func NewCfnGCMChannel_Override 

func NewCfnGCMChannel_Override(c CfnGCMChannel, scope constructs.Construct, id *string, props *CfnGCMChannelProps)

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

func NewCfnInAppTemplate_Override 

func NewCfnInAppTemplate_Override(c CfnInAppTemplate, scope constructs.Construct, id *string, props *CfnInAppTemplateProps)

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

func NewCfnPushTemplate_Override 

func NewCfnPushTemplate_Override(c CfnPushTemplate, scope constructs.Construct, id *string, props *CfnPushTemplateProps)

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

func NewCfnSMSChannel_Override 

func NewCfnSMSChannel_Override(c CfnSMSChannel, scope constructs.Construct, id *string, props *CfnSMSChannelProps)

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

func NewCfnSegment_Override 

func NewCfnSegment_Override(c CfnSegment, scope constructs.Construct, id *string, props *CfnSegmentProps)

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

func NewCfnSmsTemplate_Override 

func NewCfnSmsTemplate_Override(c CfnSmsTemplate, scope constructs.Construct, id *string, props *CfnSmsTemplateProps)

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

func NewCfnVoiceChannel_Override 

func NewCfnVoiceChannel_Override(c CfnVoiceChannel, scope constructs.Construct, id *string, props *CfnVoiceChannelProps)

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

Types

type CfnADMChannel 

type CfnADMChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ClientId() *string
	SetClientId(val *string)
	ClientSecret() *string
	SetClientSecret(val *string)
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::ADMChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the ADM channel to send push notifications through the Amazon Device Messaging (ADM) service to apps that run on Amazon devices, such as Kindle Fire tablets. Before you can use Amazon Pinpoint to send messages to Amazon devices, you have to enable the ADM channel for an Amazon Pinpoint application.

The ADMChannel resource represents the status and authentication settings for the ADM channel for an application.

TODO: EXAMPLE

func NewCfnADMChannel 

func NewCfnADMChannel(scope constructs.Construct, id *string, props *CfnADMChannelProps) CfnADMChannel

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

type CfnADMChannelProps 

type CfnADMChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the ADM channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The Client ID that you received from Amazon to send messages by using ADM.
	ClientId *string `json:"clientId" yaml:"clientId"`
	// The Client Secret that you received from Amazon to send messages by using ADM.
	ClientSecret *string `json:"clientSecret" yaml:"clientSecret"`
	// Specifies whether to enable the ADM channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
}

Properties for defining a `CfnADMChannel`.

TODO: EXAMPLE

type CfnAPNSChannel 

type CfnAPNSChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	BundleId() *string
	SetBundleId(val *string)
	Certificate() *string
	SetCertificate(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultAuthenticationMethod() *string
	SetDefaultAuthenticationMethod(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	PrivateKey() *string
	SetPrivateKey(val *string)
	Ref() *string
	Stack() awscdk.Stack
	TeamId() *string
	SetTeamId(val *string)
	TokenKey() *string
	SetTokenKey(val *string)
	TokenKeyId() *string
	SetTokenKeyId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::APNSChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the APNs channel to send push notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to APNs, you have to enable the APNs channel for an Amazon Pinpoint application.

The APNSChannel resource represents the status and authentication settings for the APNs channel for an application.

TODO: EXAMPLE

func NewCfnAPNSChannel 

func NewCfnAPNSChannel(scope constructs.Construct, id *string, props *CfnAPNSChannelProps) CfnAPNSChannel

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

type CfnAPNSChannelProps 

type CfnAPNSChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the APNs channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The bundle identifier that's assigned to your iOS app.
	//
	// This identifier is used for APNs tokens.
	BundleId *string `json:"bundleId" yaml:"bundleId"`
	// The APNs client certificate that you received from Apple.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string `json:"certificate" yaml:"certificate"`
	// The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
	//
	// Valid options are `key` or `certificate` .
	DefaultAuthenticationMethod *string `json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"`
	// Specifies whether to enable the APNs channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
	PrivateKey *string `json:"privateKey" yaml:"privateKey"`
	// The identifier that's assigned to your Apple Developer Account team.
	//
	// This identifier is used for APNs tokens.
	TeamId *string `json:"teamId" yaml:"teamId"`
	// The authentication key to use for APNs tokens.
	TokenKey *string `json:"tokenKey" yaml:"tokenKey"`
	// The key identifier that's assigned to your APNs signing key.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string `json:"tokenKeyId" yaml:"tokenKeyId"`
}

Properties for defining a `CfnAPNSChannel`.

TODO: EXAMPLE

type CfnAPNSSandboxChannel 

type CfnAPNSSandboxChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	BundleId() *string
	SetBundleId(val *string)
	Certificate() *string
	SetCertificate(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultAuthenticationMethod() *string
	SetDefaultAuthenticationMethod(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	PrivateKey() *string
	SetPrivateKey(val *string)
	Ref() *string
	Stack() awscdk.Stack
	TeamId() *string
	SetTeamId(val *string)
	TokenKey() *string
	SetTokenKey(val *string)
	TokenKeyId() *string
	SetTokenKeyId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::APNSSandboxChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the APNs sandbox channel to send push notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send notifications to the APNs sandbox environment, you have to enable the APNs sandbox channel for an Amazon Pinpoint application.

The APNSSandboxChannel resource represents the status and authentication settings of the APNs sandbox channel for an application.

TODO: EXAMPLE

func NewCfnAPNSSandboxChannel 

func NewCfnAPNSSandboxChannel(scope constructs.Construct, id *string, props *CfnAPNSSandboxChannelProps) CfnAPNSSandboxChannel

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

type CfnAPNSSandboxChannelProps 

type CfnAPNSSandboxChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The bundle identifier that's assigned to your iOS app.
	//
	// This identifier is used for APNs tokens.
	BundleId *string `json:"bundleId" yaml:"bundleId"`
	// The APNs client certificate that you received from Apple.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string `json:"certificate" yaml:"certificate"`
	// The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
	//
	// Valid options are `key` or `certificate` .
	DefaultAuthenticationMethod *string `json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"`
	// Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
	PrivateKey *string `json:"privateKey" yaml:"privateKey"`
	// The identifier that's assigned to your Apple Developer Account team.
	//
	// This identifier is used for APNs tokens.
	TeamId *string `json:"teamId" yaml:"teamId"`
	// The authentication key to use for APNs tokens.
	TokenKey *string `json:"tokenKey" yaml:"tokenKey"`
	// The key identifier that's assigned to your APNs signing key.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string `json:"tokenKeyId" yaml:"tokenKeyId"`
}

Properties for defining a `CfnAPNSSandboxChannel`.

TODO: EXAMPLE

type CfnAPNSVoipChannel 

type CfnAPNSVoipChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	BundleId() *string
	SetBundleId(val *string)
	Certificate() *string
	SetCertificate(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultAuthenticationMethod() *string
	SetDefaultAuthenticationMethod(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	PrivateKey() *string
	SetPrivateKey(val *string)
	Ref() *string
	Stack() awscdk.Stack
	TeamId() *string
	SetTeamId(val *string)
	TokenKey() *string
	SetTokenKey(val *string)
	TokenKeyId() *string
	SetTokenKeyId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::APNSVoipChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to APNs, you have to enable the APNs VoIP channel for an Amazon Pinpoint application.

The APNSVoipChannel resource represents the status and authentication settings of the APNs VoIP channel for an application.

TODO: EXAMPLE

func NewCfnAPNSVoipChannel 

func NewCfnAPNSVoipChannel(scope constructs.Construct, id *string, props *CfnAPNSVoipChannelProps) CfnAPNSVoipChannel

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

type CfnAPNSVoipChannelProps 

type CfnAPNSVoipChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The bundle identifier that's assigned to your iOS app.
	//
	// This identifier is used for APNs tokens.
	BundleId *string `json:"bundleId" yaml:"bundleId"`
	// The APNs client certificate that you received from Apple.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
	Certificate *string `json:"certificate" yaml:"certificate"`
	// The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
	//
	// Valid options are `key` or `certificate` .
	DefaultAuthenticationMethod *string `json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"`
	// Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
	PrivateKey *string `json:"privateKey" yaml:"privateKey"`
	// The identifier that's assigned to your Apple Developer Account team.
	//
	// This identifier is used for APNs tokens.
	TeamId *string `json:"teamId" yaml:"teamId"`
	// The authentication key to use for APNs tokens.
	TokenKey *string `json:"tokenKey" yaml:"tokenKey"`
	// The key identifier that's assigned to your APNs signing key.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
	TokenKeyId *string `json:"tokenKeyId" yaml:"tokenKeyId"`
}

Properties for defining a `CfnAPNSVoipChannel`.

TODO: EXAMPLE

type CfnAPNSVoipSandboxChannel 

type CfnAPNSVoipSandboxChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	BundleId() *string
	SetBundleId(val *string)
	Certificate() *string
	SetCertificate(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultAuthenticationMethod() *string
	SetDefaultAuthenticationMethod(val *string)
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	PrivateKey() *string
	SetPrivateKey(val *string)
	Ref() *string
	Stack() awscdk.Stack
	TeamId() *string
	SetTeamId(val *string)
	TokenKey() *string
	SetTokenKey(val *string)
	TokenKeyId() *string
	SetTokenKeyId(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::APNSVoipSandboxChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the APNs VoIP sandbox channel to send VoIP notification messages to the sandbox environment of the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notifications to the APNs sandbox environment, you have to enable the APNs VoIP sandbox channel for an Amazon Pinpoint application.

The APNSVoipSandboxChannel resource represents the status and authentication settings of the APNs VoIP sandbox channel for an application.

TODO: EXAMPLE

func NewCfnAPNSVoipSandboxChannel 

func NewCfnAPNSVoipSandboxChannel(scope constructs.Construct, id *string, props *CfnAPNSVoipSandboxChannelProps) CfnAPNSVoipSandboxChannel

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

type CfnAPNSVoipSandboxChannelProps 

type CfnAPNSVoipSandboxChannelProps struct {
	// The unique identifier for the application that the APNs VoIP sandbox channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The bundle identifier that's assigned to your iOS app.
	//
	// This identifier is used for APNs tokens.
	BundleId *string `json:"bundleId" yaml:"bundleId"`
	// The APNs client certificate that you received from Apple.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
	Certificate *string `json:"certificate" yaml:"certificate"`
	// The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs.
	//
	// Valid options are `key` or `certificate` .
	DefaultAuthenticationMethod *string `json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"`
	// Specifies whether the APNs VoIP sandbox channel is enabled for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
	PrivateKey *string `json:"privateKey" yaml:"privateKey"`
	// The identifier that's assigned to your Apple developer account team.
	//
	// This identifier is used for APNs tokens.
	TeamId *string `json:"teamId" yaml:"teamId"`
	// The authentication key to use for APNs tokens.
	TokenKey *string `json:"tokenKey" yaml:"tokenKey"`
	// The key identifier that's assigned to your APNs signing key.
	//
	// Specify this value if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
	TokenKeyId *string `json:"tokenKeyId" yaml:"tokenKeyId"`
}

Properties for defining a `CfnAPNSVoipSandboxChannel`.

TODO: EXAMPLE

type CfnApp 

type CfnApp interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::App`.

An *app* is an Amazon Pinpoint application, also referred to as a *project* . An application is a collection of related settings, customer information, segments, campaigns, and other types of Amazon Pinpoint resources.

The App resource represents an Amazon Pinpoint application.

TODO: EXAMPLE

func NewCfnApp 

func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp

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

type CfnAppProps 

type CfnAppProps struct {
	// The display name of the application.
	Name *string `json:"name" yaml:"name"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnApp`.

TODO: EXAMPLE

type CfnApplicationSettings 

type CfnApplicationSettings interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CampaignHook() interface{}
	SetCampaignHook(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CloudWatchMetricsEnabled() interface{}
	SetCloudWatchMetricsEnabled(val interface{})
	CreationStack() *[]*string
	Limits() interface{}
	SetLimits(val interface{})
	LogicalId() *string
	Node() constructs.Node
	QuietTime() interface{}
	SetQuietTime(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::ApplicationSettings`.

Specifies the settings for an Amazon Pinpoint application. In Amazon Pinpoint, an *application* (also referred to as an *app* or *project* ) is a collection of related settings, customer information, segments, and campaigns, and other types of Amazon Pinpoint resources.

TODO: EXAMPLE

func NewCfnApplicationSettings 

func NewCfnApplicationSettings(scope constructs.Construct, id *string, props *CfnApplicationSettingsProps) CfnApplicationSettings

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

type CfnApplicationSettingsProps 

type CfnApplicationSettingsProps struct {
	// The unique identifier for the Amazon Pinpoint application.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The settings for the Lambda function to use by default as a code hook for campaigns in the application.
	//
	// To override these settings for a specific campaign, use the Campaign resource to define custom Lambda function settings for the campaign.
	CampaignHook interface{} `json:"campaignHook" yaml:"campaignHook"`
	// Specifies whether to enable application-related alarms in Amazon CloudWatch.
	CloudWatchMetricsEnabled interface{} `json:"cloudWatchMetricsEnabled" yaml:"cloudWatchMetricsEnabled"`
	// The default sending limits for campaigns in the application.
	//
	// To override these limits for a specific campaign, use the Campaign resource to define custom limits for the campaign.
	Limits interface{} `json:"limits" yaml:"limits"`
	// The default quiet time for campaigns in the application.
	//
	// Quiet time is a specific time range when campaigns don't send messages to endpoints, if all the following conditions are met:
	//
	// - The `EndpointDemographic.Timezone` property of the endpoint is set to a valid value.
	//
	// - The current time in the endpoint's time zone is later than or equal to the time specified by the `QuietTime.Start` property for the application (or a campaign that has custom quiet time settings).
	//
	// - The current time in the endpoint's time zone is earlier than or equal to the time specified by the `QuietTime.End` property for the application (or a campaign that has custom quiet time settings).
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign, even if quiet time is enabled.
	//
	// To override the default quiet time settings for a specific campaign, use the Campaign resource to define a custom quiet time for the campaign.
	QuietTime interface{} `json:"quietTime" yaml:"quietTime"`
}

Properties for defining a `CfnApplicationSettings`.

TODO: EXAMPLE

type CfnApplicationSettings_CampaignHookProperty 

type CfnApplicationSettings_CampaignHookProperty struct {
	// The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to send messages for campaigns in the application.
	LambdaFunctionName *string `json:"lambdaFunctionName" yaml:"lambdaFunctionName"`
	// The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.
	//
	// - `FILTER` - Invoke the function to customize the segment that's used by a campaign.
	// - `DELIVERY` - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the `CustomDeliveryConfiguration` and `CampaignCustomMessage` objects of the campaign.
	Mode *string `json:"mode" yaml:"mode"`
	// The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
	WebUrl *string `json:"webUrl" yaml:"webUrl"`
}

Specifies the Lambda function to use by default as a code hook for campaigns in the application.

TODO: EXAMPLE

type CfnApplicationSettings_LimitsProperty 

type CfnApplicationSettings_LimitsProperty struct {
	// The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
	//
	// The maximum value is 100.
	Daily *float64 `json:"daily" yaml:"daily"`
	// The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
	//
	// The minimum value is 60 seconds.
	MaximumDuration *float64 `json:"maximumDuration" yaml:"maximumDuration"`
	// The maximum number of messages that a campaign can send each second.
	//
	// The minimum value is 50. The maximum value is 20,000.
	MessagesPerSecond *float64 `json:"messagesPerSecond" yaml:"messagesPerSecond"`
	// The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.
	//
	// The maximum value is 100.
	Total *float64 `json:"total" yaml:"total"`
}

Specifies the default sending limits for campaigns in the application.

TODO: EXAMPLE

type CfnApplicationSettings_QuietTimeProperty 

type CfnApplicationSettings_QuietTimeProperty struct {
	// The specific time when quiet time ends.
	//
	// This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
	End *string `json:"end" yaml:"end"`
	// The specific time when quiet time begins.
	//
	// This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
	Start *string `json:"start" yaml:"start"`
}

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

TODO: EXAMPLE

type CfnBaiduChannel 

type CfnBaiduChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiKey() *string
	SetApiKey(val *string)
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SecretKey() *string
	SetSecretKey(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::BaiduChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the Baidu channel to send notifications to the Baidu Cloud Push notification service. Before you can use Amazon Pinpoint to send notifications to the Baidu Cloud Push service, you have to enable the Baidu channel for an Amazon Pinpoint application.

The BaiduChannel resource represents the status and authentication settings of the Baidu channel for an application.

TODO: EXAMPLE

func NewCfnBaiduChannel 

func NewCfnBaiduChannel(scope constructs.Construct, id *string, props *CfnBaiduChannelProps) CfnBaiduChannel

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

type CfnBaiduChannelProps 

type CfnBaiduChannelProps struct {
	// The API key that you received from the Baidu Cloud Push service to communicate with the service.
	ApiKey *string `json:"apiKey" yaml:"apiKey"`
	// The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The secret key that you received from the Baidu Cloud Push service to communicate with the service.
	SecretKey *string `json:"secretKey" yaml:"secretKey"`
	// Specifies whether to enable the Baidu channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
}

Properties for defining a `CfnBaiduChannel`.

TODO: EXAMPLE

type CfnCampaign 

type CfnCampaign interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AdditionalTreatments() interface{}
	SetAdditionalTreatments(val interface{})
	ApplicationId() *string
	SetApplicationId(val *string)
	AttrArn() *string
	AttrCampaignId() *string
	CampaignHook() interface{}
	SetCampaignHook(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	HoldoutPercent() *float64
	SetHoldoutPercent(val *float64)
	IsPaused() interface{}
	SetIsPaused(val interface{})
	Limits() interface{}
	SetLimits(val interface{})
	LogicalId() *string
	MessageConfiguration() interface{}
	SetMessageConfiguration(val interface{})
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Priority() *float64
	SetPriority(val *float64)
	Ref() *string
	Schedule() interface{}
	SetSchedule(val interface{})
	SegmentId() *string
	SetSegmentId(val *string)
	SegmentVersion() *float64
	SetSegmentVersion(val *float64)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TreatmentDescription() *string
	SetTreatmentDescription(val *string)
	TreatmentName() *string
	SetTreatmentName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::Campaign`.

Specifies the settings for a campaign. A *campaign* is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.

TODO: EXAMPLE

func NewCfnCampaign 

func NewCfnCampaign(scope constructs.Construct, id *string, props *CfnCampaignProps) CfnCampaign

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

type CfnCampaignProps 

type CfnCampaignProps struct {
	// The unique identifier for the Amazon Pinpoint application that the campaign is associated with.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The message configuration settings for the campaign.
	MessageConfiguration interface{} `json:"messageConfiguration" yaml:"messageConfiguration"`
	// The name of the campaign.
	Name *string `json:"name" yaml:"name"`
	// The schedule settings for the campaign.
	Schedule interface{} `json:"schedule" yaml:"schedule"`
	// The unique identifier for the segment to associate with the campaign.
	SegmentId *string `json:"segmentId" yaml:"segmentId"`
	// An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
	AdditionalTreatments interface{} `json:"additionalTreatments" yaml:"additionalTreatments"`
	// Specifies the Lambda function to use as a code hook for a campaign.
	CampaignHook interface{} `json:"campaignHook" yaml:"campaignHook"`
	// A custom description of the campaign.
	Description *string `json:"description" yaml:"description"`
	// The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
	HoldoutPercent *float64 `json:"holdoutPercent" yaml:"holdoutPercent"`
	// Specifies whether to pause the campaign.
	//
	// A paused campaign doesn't run unless you resume it by changing this value to `false` . If you restart a campaign, the campaign restarts from the beginning and not at the point you paused it.
	IsPaused interface{} `json:"isPaused" yaml:"isPaused"`
	// The messaging limits for the campaign.
	Limits interface{} `json:"limits" yaml:"limits"`
	// An integer between 1 and 5, inclusive, that represents the priority of the in-app message campaign, where 1 is the highest priority and 5 is the lowest.
	//
	// If there are multiple messages scheduled to be displayed at the same time, the priority determines the order in which those messages are displayed.
	Priority *float64 `json:"priority" yaml:"priority"`
	// The version of the segment to associate with the campaign.
	SegmentVersion *float64 `json:"segmentVersion" yaml:"segmentVersion"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
	// A custom description of the default treatment for the campaign.
	TreatmentDescription *string `json:"treatmentDescription" yaml:"treatmentDescription"`
	// A custom name of the default treatment for the campaign, if the campaign has multiple treatments.
	//
	// A *treatment* is a variation of a campaign that's used for A/B testing.
	TreatmentName *string `json:"treatmentName" yaml:"treatmentName"`
}

Properties for defining a `CfnCampaign`.

TODO: EXAMPLE

type CfnCampaign_AttributeDimensionProperty 

type CfnCampaign_AttributeDimensionProperty struct {
	// The type of segment dimension to use. Valid values are:.
	//
	// - `INCLUSIVE` – endpoints that have attributes matching the values are included in the segment.
	// - `EXCLUSIVE` – endpoints that have attributes matching the values are excluded from the segment.
	// - `CONTAINS` – endpoints that have attributes' substrings match the values are included in the segment.
	// - `BEFORE` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
	// - `AFTER` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
	// - `BETWEEN` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
	// - `ON` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
	AttributeType *string `json:"attributeType" yaml:"attributeType"`
	// The criteria values to use for the segment dimension.
	//
	// Depending on the value of the `AttributeType` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies attribute-based criteria for including or excluding endpoints from a segment.

TODO: EXAMPLE

type CfnCampaign_CampaignEmailMessageProperty 

type CfnCampaign_CampaignEmailMessageProperty struct {
	// The body of the email for recipients whose email clients don't render HTML content.
	Body *string `json:"body" yaml:"body"`
	// The verified email address to send the email from.
	//
	// The default address is the `FromAddress` specified for the email channel for the application.
	FromAddress *string `json:"fromAddress" yaml:"fromAddress"`
	// The body of the email, in HTML format, for recipients whose email clients render HTML content.
	HtmlBody *string `json:"htmlBody" yaml:"htmlBody"`
	// The subject line, or title, of the email.
	Title *string `json:"title" yaml:"title"`
}

Specifies the content and "From" address for an email message that's sent to recipients of a campaign.

TODO: EXAMPLE

type CfnCampaign_CampaignEventFilterProperty 

type CfnCampaign_CampaignEventFilterProperty struct {
	// The dimension settings of the event filter for the campaign.
	Dimensions interface{} `json:"dimensions" yaml:"dimensions"`
	// The type of event that causes the campaign to be sent.
	//
	// Valid values are: `SYSTEM` , sends the campaign when a system event occurs; and, `ENDPOINT` , sends the campaign when an endpoint event (Events resource) occurs.
	FilterType *string `json:"filterType" yaml:"filterType"`
}

Specifies the settings for events that cause a campaign to be sent.

TODO: EXAMPLE

type CfnCampaign_CampaignHookProperty 

type CfnCampaign_CampaignHookProperty struct {
	// The name or Amazon Resource Name (ARN) of the Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
	LambdaFunctionName *string `json:"lambdaFunctionName" yaml:"lambdaFunctionName"`
	// The mode that Amazon Pinpoint uses to invoke the Lambda function. Possible values are:.
	//
	// - `FILTER` - Invoke the function to customize the segment that's used by a campaign.
	// - `DELIVERY` - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the `CustomDeliveryConfiguration` and `CampaignCustomMessage` objects of the campaign.
	Mode *string `json:"mode" yaml:"mode"`
	// The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS.
	WebUrl *string `json:"webUrl" yaml:"webUrl"`
}

Specifies settings for invoking an Lambda function that customizes a segment for a campaign.

TODO: EXAMPLE

type CfnCampaign_CampaignInAppMessageProperty 

type CfnCampaign_CampaignInAppMessageProperty struct {
	// An array that contains configurtion information about the in-app message for the campaign, including title and body text, text colors, background colors, image URLs, and button configurations.
	Content interface{} `json:"content" yaml:"content"`
	// Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
	CustomConfig interface{} `json:"customConfig" yaml:"customConfig"`
	// A string that describes how the in-app message will appear. 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.
	Layout *string `json:"layout" yaml:"layout"`
}

Specifies the appearance of an in-app message, including the message type, the title and body text, text and background colors, and the configurations of buttons that appear in the message.

TODO: EXAMPLE

type CfnCampaign_CampaignSmsMessageProperty 

type CfnCampaign_CampaignSmsMessageProperty struct {
	// The body of the SMS message.
	Body *string `json:"body" yaml:"body"`
	// The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country.
	EntityId *string `json:"entityId" yaml:"entityId"`
	// The SMS message type.
	//
	// Valid values are `TRANSACTIONAL` (for messages that are critical or time-sensitive, such as a one-time passwords) and `PROMOTIONAL` (for messsages that aren't critical or time-sensitive, such as marketing messages).
	MessageType *string `json:"messageType" yaml:"messageType"`
	// The long code to send the SMS message from.
	//
	// This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code using an E.164 format to ensure prompt and accurate delivery of the message. For example, +12065550100.
	OriginationNumber *string `json:"originationNumber" yaml:"originationNumber"`
	// The alphabetic Sender ID to display as the sender of the message on a recipient's device.
	//
	// Support for sender IDs varies by country or region. To specify a phone number as the sender, omit this parameter and use `OriginationNumber` instead. For more information about support for Sender ID by country, see the [Amazon Pinpoint User Guide](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) .
	SenderId *string `json:"senderId" yaml:"senderId"`
	// The template ID received from the regulatory body for sending SMS in your country.
	TemplateId *string `json:"templateId" yaml:"templateId"`
}

Specifies the content and settings for an SMS message that's sent to recipients of a campaign.

TODO: EXAMPLE

type CfnCampaign_DefaultButtonConfigurationProperty 

type CfnCampaign_DefaultButtonConfigurationProperty struct {
	// The background color of a button, expressed as a hex color code (such as #000000 for black).
	BackgroundColor *string `json:"backgroundColor" yaml:"backgroundColor"`
	// The border radius of a button.
	BorderRadius *float64 `json:"borderRadius" yaml:"borderRadius"`
	// 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.
	ButtonAction *string `json:"buttonAction" yaml:"buttonAction"`
	// The destination (such as a URL) for a button.
	Link *string `json:"link" yaml:"link"`
	// The text that appears on a button in an in-app message.
	Text *string `json:"text" yaml:"text"`
	// The color of the body text in a button, expressed as a hex color code (such as #000000 for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

Specifies the default behavior for 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.

TODO: EXAMPLE

type CfnCampaign_EventDimensionsProperty 

type CfnCampaign_EventDimensionsProperty struct {
	// One or more custom attributes that your application reports to Amazon Pinpoint.
	//
	// You can use these attributes as selection criteria when you create an event filter.
	Attributes interface{} `json:"attributes" yaml:"attributes"`
	// The name of the event that causes the campaign to be sent or the journey activity to be performed.
	//
	// This can be a standard event that Amazon Pinpoint generates, such as `_email.delivered` . For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see [Streaming Amazon Pinpoint Events](https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html) in the *Amazon Pinpoint Developer Guide* .
	EventType interface{} `json:"eventType" yaml:"eventType"`
	// One or more custom metrics that your application reports to Amazon Pinpoint .
	//
	// You can use these metrics as selection criteria when you create an event filter.
	Metrics interface{} `json:"metrics" yaml:"metrics"`
}

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

TODO: EXAMPLE

type CfnCampaign_InAppMessageBodyConfigProperty 

type CfnCampaign_InAppMessageBodyConfigProperty struct {
	// The text alignment of the main body text of the message.
	//
	// Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
	Alignment *string `json:"alignment" yaml:"alignment"`
	// The main body text of the message.
	Body *string `json:"body" yaml:"body"`
	// The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

Specifies the configuration of main body text of the in-app message.

TODO: EXAMPLE

type CfnCampaign_InAppMessageButtonProperty 

type CfnCampaign_InAppMessageButtonProperty struct {
	// An object that defines the default behavior for a button in in-app messages sent to Android.
	Android interface{} `json:"android" yaml:"android"`
	// An object that defines the default behavior for a button in an in-app message.
	DefaultConfig interface{} `json:"defaultConfig" yaml:"defaultConfig"`
	// An object that defines the default behavior for a button in in-app messages sent to iOS devices.
	Ios interface{} `json:"ios" yaml:"ios"`
	// An object that defines the default behavior for a button in in-app messages for web applications.
	Web interface{} `json:"web" yaml:"web"`
}

Specifies the configuration of a button that appears in an in-app message.

TODO: EXAMPLE

type CfnCampaign_InAppMessageContentProperty 

type CfnCampaign_InAppMessageContentProperty struct {
	// The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
	BackgroundColor *string `json:"backgroundColor" yaml:"backgroundColor"`
	// Specifies the configuration of main body text in an in-app message template.
	BodyConfig interface{} `json:"bodyConfig" yaml:"bodyConfig"`
	// Specifies the configuration and content of the header or title text of the in-app message.
	HeaderConfig interface{} `json:"headerConfig" yaml:"headerConfig"`
	// The URL of the image that appears on an in-app message banner.
	ImageUrl *string `json:"imageUrl" yaml:"imageUrl"`
	// An object that contains configuration information about the primary button in an in-app message.
	PrimaryBtn interface{} `json:"primaryBtn" yaml:"primaryBtn"`
	// An object that contains configuration information about the secondary button in an in-app message.
	SecondaryBtn interface{} `json:"secondaryBtn" yaml:"secondaryBtn"`
}

Specifies the configuration and contents of an in-app message.

TODO: EXAMPLE

type CfnCampaign_InAppMessageHeaderConfigProperty 

type CfnCampaign_InAppMessageHeaderConfigProperty struct {
	// The text alignment of the title of the message.
	//
	// Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
	Alignment *string `json:"alignment" yaml:"alignment"`
	// The header or title text of the in-app message.
	Header *string `json:"header" yaml:"header"`
	// The color of the body text, expressed as a string consisting of a hex color code (such as "#000000" for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

Specifies the configuration and content of the header or title text of the in-app message.

TODO: EXAMPLE

type CfnCampaign_LimitsProperty 

type CfnCampaign_LimitsProperty struct {
	// The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period.
	//
	// The maximum value is 100.
	Daily *float64 `json:"daily" yaml:"daily"`
	// The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign.
	//
	// The minimum value is 60 seconds.
	MaximumDuration *float64 `json:"maximumDuration" yaml:"maximumDuration"`
	// The maximum number of messages that a campaign can send each second.
	//
	// The minimum value is 50. The maximum value is 20,000.
	MessagesPerSecond *float64 `json:"messagesPerSecond" yaml:"messagesPerSecond"`
	// `CfnCampaign.LimitsProperty.Session`.
	Session *float64 `json:"session" yaml:"session"`
	// The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign.
	//
	// The maximum value is 100.
	Total *float64 `json:"total" yaml:"total"`
}

Specifies the limits on the messages that a campaign can send.

TODO: EXAMPLE

type CfnCampaign_MessageConfigurationProperty 

type CfnCampaign_MessageConfigurationProperty struct {
	// The message that the campaign sends through the ADM (Amazon Device Messaging) channel.
	//
	// If specified, this message overrides the default message.
	AdmMessage interface{} `json:"admMessage" yaml:"admMessage"`
	// The message that the campaign sends through the APNs (Apple Push Notification service) channel.
	//
	// If specified, this message overrides the default message.
	ApnsMessage interface{} `json:"apnsMessage" yaml:"apnsMessage"`
	// The message that the campaign sends through the Baidu (Baidu Cloud Push) channel.
	//
	// If specified, this message overrides the default message.
	BaiduMessage interface{} `json:"baiduMessage" yaml:"baiduMessage"`
	// The default message that the campaign sends through all the channels that are configured for the campaign.
	DefaultMessage interface{} `json:"defaultMessage" yaml:"defaultMessage"`
	// The message that the campaign sends through the email channel.
	//
	// If specified, this message overrides the default message.
	EmailMessage interface{} `json:"emailMessage" yaml:"emailMessage"`
	// The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
	//
	// If specified, this message overrides the default message.
	GcmMessage interface{} `json:"gcmMessage" yaml:"gcmMessage"`
	// The default message for the in-app messaging channel.
	//
	// This message overrides the default message ( `DefaultMessage` ).
	InAppMessage interface{} `json:"inAppMessage" yaml:"inAppMessage"`
	// The message that the campaign sends through the SMS channel.
	//
	// If specified, this message overrides the default message.
	SmsMessage interface{} `json:"smsMessage" yaml:"smsMessage"`
}

Specifies the message configuration settings for a campaign.

TODO: EXAMPLE

type CfnCampaign_MessageProperty 

type CfnCampaign_MessageProperty struct {
	// The action to occur if a recipient taps the push notification. Valid values are:.
	//
	// - `OPEN_APP` – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
	// - `DEEP_LINK` – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android.
	// - `URL` – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
	Action *string `json:"action" yaml:"action"`
	// The body of the notification message.
	//
	// The maximum number of characters is 200.
	Body *string `json:"body" yaml:"body"`
	// The URL of the image to display as the push notification icon, such as the icon for the app.
	ImageIconUrl *string `json:"imageIconUrl" yaml:"imageIconUrl"`
	// The URL of the image to display as the small, push notification icon, such as a small version of the icon for the app.
	ImageSmallIconUrl *string `json:"imageSmallIconUrl" yaml:"imageSmallIconUrl"`
	// The URL of an image to display in the push notification.
	ImageUrl *string `json:"imageUrl" yaml:"imageUrl"`
	// The JSON payload to use for a silent push notification.
	JsonBody *string `json:"jsonBody" yaml:"jsonBody"`
	// The URL of the image or video to display in the push notification.
	MediaUrl *string `json:"mediaUrl" yaml:"mediaUrl"`
	// The raw, JSON-formatted string to use as the payload for the notification message.
	//
	// If specified, this value overrides all other content for the message.
	RawContent *string `json:"rawContent" yaml:"rawContent"`
	// Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device.
	//
	// Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
	SilentPush interface{} `json:"silentPush" yaml:"silentPush"`
	// The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time.
	//
	// This value is converted to an expiration value when it's sent to a push notification service. If this value is `0` , the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again.
	//
	// This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
	TimeToLive *float64 `json:"timeToLive" yaml:"timeToLive"`
	// The title to display above the notification message on a recipient's device.
	Title *string `json:"title" yaml:"title"`
	// The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the `Action` property is `URL` .
	Url *string `json:"url" yaml:"url"`
}

Specifies the content and settings for a push notification that's sent to recipients of a campaign.

TODO: EXAMPLE

type CfnCampaign_MetricDimensionProperty 

type CfnCampaign_MetricDimensionProperty struct {
	// The operator to use when comparing metric values.
	//
	// Valid values are: `GREATER_THAN` , `LESS_THAN` , `GREATER_THAN_OR_EQUAL` , `LESS_THAN_OR_EQUAL` , and `EQUAL` .
	ComparisonOperator *string `json:"comparisonOperator" yaml:"comparisonOperator"`
	// The value to compare.
	Value *float64 `json:"value" yaml:"value"`
}

Specifies metric-based criteria for including or excluding endpoints from a segment.

These criteria derive from custom metrics that you define for endpoints.

TODO: EXAMPLE

type CfnCampaign_OverrideButtonConfigurationProperty 

type CfnCampaign_OverrideButtonConfigurationProperty struct {
	// 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.
	ButtonAction *string `json:"buttonAction" yaml:"buttonAction"`
	// The destination (such as a URL) for a button.
	Link *string `json:"link" yaml:"link"`
}

Specifies the configuration of a button with settings that are specific to a certain device type.

TODO: EXAMPLE

type CfnCampaign_QuietTimeProperty 

type CfnCampaign_QuietTimeProperty struct {
	// The specific time when quiet time ends.
	//
	// This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
	End *string `json:"end" yaml:"end"`
	// The specific time when quiet time begins.
	//
	// This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use `02:30` to represent 2:30 AM, or `14:30` to represent 2:30 PM.
	Start *string `json:"start" yaml:"start"`
}

Specifies the start and end times that define a time range when messages aren't sent to endpoints.

TODO: EXAMPLE

type CfnCampaign_ScheduleProperty 

type CfnCampaign_ScheduleProperty struct {
	// The scheduled time, in ISO 8601 format, when the campaign ended or will end.
	EndTime *string `json:"endTime" yaml:"endTime"`
	// The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` .
	EventFilter interface{} `json:"eventFilter" yaml:"eventFilter"`
	// Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
	Frequency *string `json:"frequency" yaml:"frequency"`
	// Specifies whether the start and end times for the campaign schedule use each recipient's local time.
	//
	// To base the schedule on each recipient's local time, set this value to `true` .
	IsLocalTime interface{} `json:"isLocalTime" yaml:"isLocalTime"`
	// The default quiet time for the campaign.
	//
	// Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:
	//
	// - The `EndpointDemographic.Timezone` property of the endpoint is set to a valid value.
	// - The current time in the endpoint's time zone is later than or equal to the time specified by the `QuietTime.Start` property for the campaign.
	// - The current time in the endpoint's time zone is earlier than or equal to the time specified by the `QuietTime.End` property for the campaign.
	//
	// If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
	QuietTime interface{} `json:"quietTime" yaml:"quietTime"`
	// The scheduled time when the campaign began or will begin.
	//
	// Valid values are: `IMMEDIATE` , to start the campaign immediately; or, a specific time in ISO 8601 format.
	StartTime *string `json:"startTime" yaml:"startTime"`
	// The starting UTC offset for the campaign schedule, if the value of the `IsLocalTime` property is `true` .
	//
	// Valid values are: `UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10,` and `UTC-11` .
	TimeZone *string `json:"timeZone" yaml:"timeZone"`
}

Specifies the schedule settings for a campaign.

TODO: EXAMPLE

type CfnCampaign_SetDimensionProperty 

type CfnCampaign_SetDimensionProperty struct {
	// The type of segment dimension to use.
	//
	// Valid values are: `INCLUSIVE` , endpoints that match the criteria are included in the segment; and, `EXCLUSIVE` , endpoints that match the criteria are excluded from the segment.
	DimensionType *string `json:"dimensionType" yaml:"dimensionType"`
	// The criteria values to use for the segment dimension.
	//
	// Depending on the value of the `DimensionType` property, endpoints are included or excluded from the segment if their values match the criteria values.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies the dimension type and values for a segment dimension.

TODO: EXAMPLE

type CfnCampaign_WriteTreatmentResourceProperty 

type CfnCampaign_WriteTreatmentResourceProperty struct {
	// The message configuration settings for the treatment.
	MessageConfiguration interface{} `json:"messageConfiguration" yaml:"messageConfiguration"`
	// The schedule settings for the treatment.
	Schedule interface{} `json:"schedule" yaml:"schedule"`
	// The allocated percentage of users (segment members) to send the treatment to.
	SizePercent *float64 `json:"sizePercent" yaml:"sizePercent"`
	// A custom description of the treatment.
	TreatmentDescription *string `json:"treatmentDescription" yaml:"treatmentDescription"`
	// A custom name for the treatment.
	TreatmentName *string `json:"treatmentName" yaml:"treatmentName"`
}

Specifies the settings for a campaign treatment.

A *treatment* is a variation of a campaign that's used for A/B testing of a campaign.

TODO: EXAMPLE

type CfnEmailChannel 

type CfnEmailChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	ConfigurationSet() *string
	SetConfigurationSet(val *string)
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	FromAddress() *string
	SetFromAddress(val *string)
	Identity() *string
	SetIdentity(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::EmailChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the email channel to send email to users. Before you can use Amazon Pinpoint to send email, you must enable the email channel for an Amazon Pinpoint application.

The EmailChannel resource represents the status, identity, and other settings of the email channel for an application

TODO: EXAMPLE

func NewCfnEmailChannel 

func NewCfnEmailChannel(scope constructs.Construct, id *string, props *CfnEmailChannelProps) CfnEmailChannel

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

type CfnEmailChannelProps 

type CfnEmailChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The verified email address that you want to send email from when you send email through the channel.
	FromAddress *string `json:"fromAddress" yaml:"fromAddress"`
	// The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
	Identity *string `json:"identity" yaml:"identity"`
	// The [Amazon SES configuration set](https://docs.aws.amazon.com/ses/latest/APIReference/API_ConfigurationSet.html) that you want to apply to messages that you send through the channel.
	ConfigurationSet *string `json:"configurationSet" yaml:"configurationSet"`
	// Specifies whether to enable the email channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
}

Properties for defining a `CfnEmailChannel`.

TODO: EXAMPLE

type CfnEmailTemplate 

type CfnEmailTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultSubstitutions() *string
	SetDefaultSubstitutions(val *string)
	HtmlPart() *string
	SetHtmlPart(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Subject() *string
	SetSubject(val *string)
	Tags() awscdk.TagManager
	TemplateDescription() *string
	SetTemplateDescription(val *string)
	TemplateName() *string
	SetTemplateName(val *string)
	TextPart() *string
	SetTextPart(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::EmailTemplate`.

Creates a message template that you can use in messages that are sent through the email channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

TODO: EXAMPLE

func NewCfnEmailTemplate 

func NewCfnEmailTemplate(scope constructs.Construct, id *string, props *CfnEmailTemplateProps) CfnEmailTemplate

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

type CfnEmailTemplateProps 

type CfnEmailTemplateProps struct {
	// The subject line, or title, to use in email messages that are based on the message template.
	Subject *string `json:"subject" yaml:"subject"`
	// The name of the message template.
	TemplateName *string `json:"templateName" yaml:"templateName"`
	// A JSON object that specifies the default values to use for message variables in the message template.
	//
	// This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
	DefaultSubstitutions *string `json:"defaultSubstitutions" yaml:"defaultSubstitutions"`
	// The message body, in HTML format, to use in email messages that are based on the message template.
	//
	// We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
	HtmlPart *string `json:"htmlPart" yaml:"htmlPart"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
	// A custom description of the message template.
	TemplateDescription *string `json:"templateDescription" yaml:"templateDescription"`
	// The message body, in plain text format, to use in email messages that are based on the message template.
	//
	// We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
	TextPart *string `json:"textPart" yaml:"textPart"`
}

Properties for defining a `CfnEmailTemplate`.

TODO: EXAMPLE

type CfnEventStream 

type CfnEventStream interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DestinationStreamArn() *string
	SetDestinationStreamArn(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	RoleArn() *string
	SetRoleArn(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::EventStream`.

Creates a new event stream for an application or updates the settings of an existing event stream for an application.

TODO: EXAMPLE

func NewCfnEventStream 

func NewCfnEventStream(scope constructs.Construct, id *string, props *CfnEventStreamProps) CfnEventStream

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

type CfnEventStreamProps 

type CfnEventStreamProps struct {
	// The unique identifier for the Amazon Pinpoint application that you want to export data from.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to.
	//
	// For a Kinesis data stream, the ARN format is: `arn:aws:kinesis: region : account-id :stream/ stream_name`
	//
	// For a Kinesis Data Firehose delivery stream, the ARN format is: `arn:aws:firehose: region : account-id :deliverystream/ stream_name`
	DestinationStreamArn *string `json:"destinationStreamArn" yaml:"destinationStreamArn"`
	// The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
	RoleArn *string `json:"roleArn" yaml:"roleArn"`
}

Properties for defining a `CfnEventStream`.

TODO: EXAMPLE

type CfnGCMChannel 

type CfnGCMChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApiKey() *string
	SetApiKey(val *string)
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::GCMChannel`.

A *channel* is a type of platform that you can deliver messages to. You can use the GCM channel to send push notification messages to the Firebase Cloud Messaging (FCM) service, which replaced the Google Cloud Messaging (GCM) service. Before you use Amazon Pinpoint to send notifications to FCM, you have to enable the GCM channel for an Amazon Pinpoint application.

The GCMChannel resource represents the status and authentication settings of the GCM channel for an application.

TODO: EXAMPLE

func NewCfnGCMChannel 

func NewCfnGCMChannel(scope constructs.Construct, id *string, props *CfnGCMChannelProps) CfnGCMChannel

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

type CfnGCMChannelProps 

type CfnGCMChannelProps struct {
	// The Web API key, also called the *server key* , that you received from Google to communicate with Google services.
	ApiKey *string `json:"apiKey" yaml:"apiKey"`
	// The unique identifier for the Amazon Pinpoint application that the GCM channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// Specifies whether to enable the GCM channel for the Amazon Pinpoint application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
}

Properties for defining a `CfnGCMChannel`.

TODO: EXAMPLE

type CfnInAppTemplate 

type CfnInAppTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	Content() interface{}
	SetContent(val interface{})
	CreationStack() *[]*string
	CustomConfig() interface{}
	SetCustomConfig(val interface{})
	Layout() *string
	SetLayout(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateDescription() *string
	SetTemplateDescription(val *string)
	TemplateName() *string
	SetTemplateName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

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

Creates a message template that you can use to send in-app messages. A message template is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

TODO: EXAMPLE

func NewCfnInAppTemplate 

func NewCfnInAppTemplate(scope constructs.Construct, id *string, props *CfnInAppTemplateProps) CfnInAppTemplate

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

type CfnInAppTemplateProps 

type CfnInAppTemplateProps struct {
	// The name of the in-app message template.
	TemplateName *string `json:"templateName" yaml:"templateName"`
	// 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.
	Content interface{} `json:"content" yaml:"content"`
	// Custom data, in the form of key-value pairs, that is included in an in-app messaging payload.
	CustomConfig interface{} `json:"customConfig" yaml:"customConfig"`
	// 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.
	Layout *string `json:"layout" yaml:"layout"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
	// An optional description of the in-app template.
	TemplateDescription *string `json:"templateDescription" yaml:"templateDescription"`
}

Properties for defining a `CfnInAppTemplate`.

TODO: EXAMPLE

type CfnInAppTemplate_BodyConfigProperty 

type CfnInAppTemplate_BodyConfigProperty struct {
	// The text alignment of the main body text of the message.
	//
	// Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
	Alignment *string `json:"alignment" yaml:"alignment"`
	// The main body text of the message.
	Body *string `json:"body" yaml:"body"`
	// The color of the body text, expressed as a hex color code (such as #000000 for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

Specifies the configuration of the main body text of the in-app message.

TODO: EXAMPLE

type CfnInAppTemplate_ButtonConfigProperty 

type CfnInAppTemplate_ButtonConfigProperty struct {
	// Optional button configuration to use for in-app messages sent to Android devices.
	//
	// This button configuration overrides the default button configuration.
	Android interface{} `json:"android" yaml:"android"`
	// 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.
	DefaultConfig interface{} `json:"defaultConfig" yaml:"defaultConfig"`
	// Optional button configuration to use for in-app messages sent to iOS devices.
	//
	// This button configuration overrides the default button configuration.
	Ios interface{} `json:"ios" yaml:"ios"`
	// Optional button configuration to use for in-app messages sent to web applications.
	//
	// This button configuration overrides the default button configuration.
	Web interface{} `json:"web" yaml:"web"`
}

Specifies the behavior of buttons that appear in an in-app message template.

TODO: EXAMPLE

type CfnInAppTemplate_DefaultButtonConfigurationProperty 

type CfnInAppTemplate_DefaultButtonConfigurationProperty struct {
	// The background color of a button, expressed as a hex color code (such as #000000 for black).
	BackgroundColor *string `json:"backgroundColor" yaml:"backgroundColor"`
	// The border radius of a button.
	BorderRadius *float64 `json:"borderRadius" yaml:"borderRadius"`
	// 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.
	ButtonAction *string `json:"buttonAction" yaml:"buttonAction"`
	// The destination (such as a URL) for a button.
	Link *string `json:"link" yaml:"link"`
	// The text that appears on a button in an in-app message.
	Text *string `json:"text" yaml:"text"`
	// The color of the body text in a button, expressed as a hex color code (such as #000000 for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

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.

TODO: EXAMPLE

type CfnInAppTemplate_HeaderConfigProperty 

type CfnInAppTemplate_HeaderConfigProperty struct {
	// The text alignment of the title of the message.
	//
	// Acceptable values: `LEFT` , `CENTER` , `RIGHT` .
	Alignment *string `json:"alignment" yaml:"alignment"`
	// The title text of the in-app message.
	Header *string `json:"header" yaml:"header"`
	// The color of the title text, expressed as a hex color code (such as #000000 for black).
	TextColor *string `json:"textColor" yaml:"textColor"`
}

Specifies the configuration and content of the header or title text of the in-app message.

TODO: EXAMPLE

type CfnInAppTemplate_InAppMessageContentProperty 

type CfnInAppTemplate_InAppMessageContentProperty struct {
	// The background color for an in-app message banner, expressed as a hex color code (such as #000000 for black).
	BackgroundColor *string `json:"backgroundColor" yaml:"backgroundColor"`
	// An object that contains configuration information about the header or title text of the in-app message.
	BodyConfig interface{} `json:"bodyConfig" yaml:"bodyConfig"`
	// An object that contains configuration information about the header or title text of the in-app message.
	HeaderConfig interface{} `json:"headerConfig" yaml:"headerConfig"`
	// The URL of the image that appears on an in-app message banner.
	ImageUrl *string `json:"imageUrl" yaml:"imageUrl"`
	// An object that contains configuration information about the primary button in an in-app message.
	PrimaryBtn interface{} `json:"primaryBtn" yaml:"primaryBtn"`
	// An object that contains configuration information about the secondary button in an in-app message.
	SecondaryBtn interface{} `json:"secondaryBtn" yaml:"secondaryBtn"`
}

Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.

TODO: EXAMPLE

type CfnInAppTemplate_OverrideButtonConfigurationProperty 

type CfnInAppTemplate_OverrideButtonConfigurationProperty struct {
	// 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.
	ButtonAction *string `json:"buttonAction" yaml:"buttonAction"`
	// The destination (such as a URL) for a button.
	Link *string `json:"link" yaml:"link"`
}

Specifies the configuration of a button with settings that are specific to a certain device type.

TODO: EXAMPLE

type CfnPushTemplate 

type CfnPushTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Adm() interface{}
	SetAdm(val interface{})
	Apns() interface{}
	SetApns(val interface{})
	AttrArn() *string
	Baidu() interface{}
	SetBaidu(val interface{})
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Default() interface{}
	SetDefault(val interface{})
	DefaultSubstitutions() *string
	SetDefaultSubstitutions(val *string)
	Gcm() interface{}
	SetGcm(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateDescription() *string
	SetTemplateDescription(val *string)
	TemplateName() *string
	SetTemplateName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::PushTemplate`.

Creates a message template that you can use in messages that are sent through a push notification channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

TODO: EXAMPLE

func NewCfnPushTemplate 

func NewCfnPushTemplate(scope constructs.Construct, id *string, props *CfnPushTemplateProps) CfnPushTemplate

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

type CfnPushTemplateProps 

type CfnPushTemplateProps struct {
	// The name of the message template.
	TemplateName *string `json:"templateName" yaml:"templateName"`
	// The message template to use for the ADM (Amazon Device Messaging) channel.
	//
	// This message template overrides the default template for push notification channels ( `Default` ).
	Adm interface{} `json:"adm" yaml:"adm"`
	// The message template to use for the APNs (Apple Push Notification service) channel.
	//
	// This message template overrides the default template for push notification channels ( `Default` ).
	Apns interface{} `json:"apns" yaml:"apns"`
	// The message template to use for the Baidu (Baidu Cloud Push) channel.
	//
	// This message template overrides the default template for push notification channels ( `Default` ).
	Baidu interface{} `json:"baidu" yaml:"baidu"`
	// The default message template to use for push notification channels.
	Default interface{} `json:"default" yaml:"default"`
	// A JSON object that specifies the default values to use for message variables in the message template.
	//
	// This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
	DefaultSubstitutions *string `json:"defaultSubstitutions" yaml:"defaultSubstitutions"`
	// The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service.
	//
	// This message template overrides the default template for push notification channels ( `Default` ).
	Gcm interface{} `json:"gcm" yaml:"gcm"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
	// A custom description of the message template.
	TemplateDescription *string `json:"templateDescription" yaml:"templateDescription"`
}

Properties for defining a `CfnPushTemplate`.

TODO: EXAMPLE

type CfnPushTemplate_APNSPushNotificationTemplateProperty 

type CfnPushTemplate_APNSPushNotificationTemplateProperty struct {
	// The action to occur if a recipient taps a push notification that's based on the message template.
	//
	// Valid values are:
	//
	// - `OPEN_APP` – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
	// - `DEEP_LINK` – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform.
	// - `URL` – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
	Action *string `json:"action" yaml:"action"`
	// The message body to use in push notifications that are based on the message template.
	Body *string `json:"body" yaml:"body"`
	// The URL of an image or video to display in push notifications that are based on the message template.
	MediaUrl *string `json:"mediaUrl" yaml:"mediaUrl"`
	// The key for the sound to play when the recipient receives a push notification that's based on the message template.
	//
	// The value for this key is the name of a sound file in your app's main bundle or the `Library/Sounds` folder in your app's data container. If the sound file can't be found or you specify `default` for the value, the system plays the default alert sound.
	Sound *string `json:"sound" yaml:"sound"`
	// The title to use in push notifications that are based on the message template.
	//
	// This title appears above the notification message on a recipient's device.
	Title *string `json:"title" yaml:"title"`
	// The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `Action` property is `URL` .
	Url *string `json:"url" yaml:"url"`
}

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the APNs (Apple Push Notification service) channel.

TODO: EXAMPLE

type CfnPushTemplate_AndroidPushNotificationTemplateProperty 

type CfnPushTemplate_AndroidPushNotificationTemplateProperty struct {
	// The action to occur if a recipient taps a push notification that's based on the message template.
	//
	// Valid values are:
	//
	// - `OPEN_APP` – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
	// - `DEEP_LINK` – Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform.
	// - `URL` – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
	Action *string `json:"action" yaml:"action"`
	// The message body to use in a push notification that's based on the message template.
	Body *string `json:"body" yaml:"body"`
	// The URL of the large icon image to display in the content view of a push notification that's based on the message template.
	ImageIconUrl *string `json:"imageIconUrl" yaml:"imageIconUrl"`
	// The URL of an image to display in a push notification that's based on the message template.
	ImageUrl *string `json:"imageUrl" yaml:"imageUrl"`
	// The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
	SmallImageIconUrl *string `json:"smallImageIconUrl" yaml:"smallImageIconUrl"`
	// The sound to play when a recipient receives a push notification that's based on the message template.
	//
	// You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/` .
	Sound *string `json:"sound" yaml:"sound"`
	// The title to use in a push notification that's based on the message template.
	//
	// This title appears above the notification message on a recipient's device.
	Title *string `json:"title" yaml:"title"`
	// The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `Action` property is `URL` .
	Url *string `json:"url" yaml:"url"`
}

Specifies channel-specific content and settings for a message template that can be used in push notifications that are sent through the ADM (Amazon Device Messaging), Baidu (Baidu Cloud Push), or GCM (Firebase Cloud Messaging, formerly Google Cloud Messaging) channel.

TODO: EXAMPLE

type CfnPushTemplate_DefaultPushNotificationTemplateProperty 

type CfnPushTemplate_DefaultPushNotificationTemplateProperty struct {
	// The action to occur if a recipient taps a push notification that's based on the message template.
	//
	// Valid values are:
	//
	// - `OPEN_APP` – Your app opens or it becomes the foreground app if it was sent to the background. This is the default action.
	// - `DEEP_LINK` – Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms.
	// - `URL` – The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
	Action *string `json:"action" yaml:"action"`
	// The message body to use in push notifications that are based on the message template.
	Body *string `json:"body" yaml:"body"`
	// The sound to play when a recipient receives a push notification that's based on the message template.
	//
	// You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in `/res/raw/` .
	//
	// For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the `Library/Sounds` folder in your app's data container. If the sound file can't be found or you specify `default` for the value, the system plays the default alert sound.
	Sound *string `json:"sound" yaml:"sound"`
	// The title to use in push notifications that are based on the message template.
	//
	// This title appears above the notification message on a recipient's device.
	Title *string `json:"title" yaml:"title"`
	// The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the `Action` property is `URL` .
	Url *string `json:"url" yaml:"url"`
}

Specifies the default settings and content for a message template that can be used in messages that are sent through a push notification channel.

TODO: EXAMPLE

type CfnSMSChannel 

type CfnSMSChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	SenderId() *string
	SetSenderId(val *string)
	ShortCode() *string
	SetShortCode(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::SMSChannel`.

A *channel* is a type of platform that you can deliver messages to. To send an SMS text message, you send the message through the SMS channel. Before you can use Amazon Pinpoint to send text messages, you have to enable the SMS channel for an Amazon Pinpoint application.

The SMSChannel resource represents the status, sender ID, and other settings for the SMS channel for an application.

TODO: EXAMPLE

func NewCfnSMSChannel 

func NewCfnSMSChannel(scope constructs.Construct, id *string, props *CfnSMSChannelProps) CfnSMSChannel

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

type CfnSMSChannelProps 

type CfnSMSChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the SMS channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// Specifies whether to enable the SMS channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
	// The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
	//
	// > SenderIDs are only supported in certain countries and regions. For more information, see [Supported Countries and Regions](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-countries.html) in the *Amazon Pinpoint User Guide* .
	SenderId *string `json:"senderId" yaml:"senderId"`
	// The registered short code that you want to use when you send messages through the SMS channel.
	//
	// > For information about obtaining a dedicated short code for sending SMS messages, see [Requesting Dedicated Short Codes for SMS Messaging with Amazon Pinpoint](https://docs.aws.amazon.com/pinpoint/latest/userguide/channels-sms-awssupport-short-code.html) in the *Amazon Pinpoint User Guide* .
	ShortCode *string `json:"shortCode" yaml:"shortCode"`
}

Properties for defining a `CfnSMSChannel`.

TODO: EXAMPLE

type CfnSegment 

type CfnSegment interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	AttrArn() *string
	AttrSegmentId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Dimensions() interface{}
	SetDimensions(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	SegmentGroups() interface{}
	SetSegmentGroups(val interface{})
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::Segment`.

Updates the configuration, dimension, and other settings for an existing segment.

TODO: EXAMPLE

func NewCfnSegment 

func NewCfnSegment(scope constructs.Construct, id *string, props *CfnSegmentProps) CfnSegment

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

type CfnSegmentProps 

type CfnSegmentProps struct {
	// The unique identifier for the Amazon Pinpoint application that the segment is associated with.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// The name of the segment.
	Name *string `json:"name" yaml:"name"`
	// The criteria that define the dimensions for the segment.
	Dimensions interface{} `json:"dimensions" yaml:"dimensions"`
	// The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
	//
	// A segment group can consist of zero or more base segments. Your request can include only one segment group.
	SegmentGroups interface{} `json:"segmentGroups" yaml:"segmentGroups"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnSegment`.

TODO: EXAMPLE

type CfnSegment_AttributeDimensionProperty 

type CfnSegment_AttributeDimensionProperty struct {
	// The type of segment dimension to use. Valid values are:.
	//
	// - `INCLUSIVE` – endpoints that have attributes matching the values are included in the segment.
	// - `EXCLUSIVE` – endpoints that have attributes matching the values are excluded from the segment.
	// - `CONTAINS` – endpoints that have attributes' substrings match the values are included in the segment.
	// - `BEFORE` – endpoints with attributes read as ISO_INSTANT datetimes before the value are included in the segment.
	// - `AFTER` – endpoints with attributes read as ISO_INSTANT datetimes after the value are included in the segment.
	// - `BETWEEN` – endpoints with attributes read as ISO_INSTANT datetimes between the values are included in the segment.
	// - `ON` – endpoints with attributes read as ISO_INSTANT dates on the value are included in the segment. Time is ignored in this comparison.
	AttributeType *string `json:"attributeType" yaml:"attributeType"`
	// The criteria values to use for the segment dimension.
	//
	// Depending on the value of the `AttributeType` property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies attribute-based criteria for including or excluding endpoints from a segment.

TODO: EXAMPLE

type CfnSegment_BehaviorProperty 

type CfnSegment_BehaviorProperty struct {
	// Specifies how recently segment members were active.
	Recency interface{} `json:"recency" yaml:"recency"`
}

Specifies behavior-based criteria for the segment, such as how recently users have used your app.

TODO: EXAMPLE

type CfnSegment_CoordinatesProperty 

type CfnSegment_CoordinatesProperty struct {
	// The latitude coordinate of the location.
	Latitude *float64 `json:"latitude" yaml:"latitude"`
	// The longitude coordinate of the location.
	Longitude *float64 `json:"longitude" yaml:"longitude"`
}

Specifies the GPS coordinates of a location.

TODO: EXAMPLE

type CfnSegment_DemographicProperty 

type CfnSegment_DemographicProperty struct {
	// The app version criteria for the segment.
	AppVersion interface{} `json:"appVersion" yaml:"appVersion"`
	// The channel criteria for the segment.
	Channel interface{} `json:"channel" yaml:"channel"`
	// The device type criteria for the segment.
	DeviceType interface{} `json:"deviceType" yaml:"deviceType"`
	// The device make criteria for the segment.
	Make interface{} `json:"make" yaml:"make"`
	// The device model criteria for the segment.
	Model interface{} `json:"model" yaml:"model"`
	// The device platform criteria for the segment.
	Platform interface{} `json:"platform" yaml:"platform"`
}

Specifies demographic-based criteria, such as device platform, for the segment.

TODO: EXAMPLE

type CfnSegment_GPSPointProperty 

type CfnSegment_GPSPointProperty struct {
	// The GPS coordinates to measure distance from.
	Coordinates interface{} `json:"coordinates" yaml:"coordinates"`
	// The range, in kilometers, from the GPS coordinates.
	RangeInKilometers *float64 `json:"rangeInKilometers" yaml:"rangeInKilometers"`
}

Specifies the GPS coordinates of the endpoint location.

TODO: EXAMPLE

type CfnSegment_GroupsProperty 

type CfnSegment_GroupsProperty struct {
	// An array that defines the dimensions to include or exclude from the segment.
	Dimensions interface{} `json:"dimensions" yaml:"dimensions"`
	// The base segment to build the segment on.
	//
	// A base segment, also called a *source segment* , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.
	//
	// You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.
	SourceSegments interface{} `json:"sourceSegments" yaml:"sourceSegments"`
	// Specifies how to handle multiple base segments for the segment.
	//
	// For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
	SourceType *string `json:"sourceType" yaml:"sourceType"`
	// Specifies how to handle multiple dimensions for the segment.
	//
	// For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
	Type *string `json:"type" yaml:"type"`
}

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

TODO: EXAMPLE

type CfnSegment_LocationProperty 

type CfnSegment_LocationProperty struct {
	// The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
	Country interface{} `json:"country" yaml:"country"`
	// The GPS point dimension for the segment.
	GpsPoint interface{} `json:"gpsPoint" yaml:"gpsPoint"`
}

Specifies location-based criteria, such as region or GPS coordinates, for the segment.

TODO: EXAMPLE

type CfnSegment_RecencyProperty 

type CfnSegment_RecencyProperty struct {
	// The duration to use when determining which users have been active or inactive with your app.
	//
	// Possible values: `HR_24` | `DAY_7` | `DAY_14` | `DAY_30` .
	Duration *string `json:"duration" yaml:"duration"`
	// The type of recency dimension to use for the segment.
	//
	// Valid values are: `ACTIVE` and `INACTIVE` . If the value is `ACTIVE` , the segment includes users who have used your app within the specified duration are included in the segment. If the value is `INACTIVE` , the segment includes users who haven't used your app within the specified duration are included in the segment.
	RecencyType *string `json:"recencyType" yaml:"recencyType"`
}

Specifies how recently segment members were active.

TODO: EXAMPLE

type CfnSegment_SegmentDimensionsProperty 

type CfnSegment_SegmentDimensionsProperty struct {
	// One or more custom attributes to use as criteria for the segment.
	Attributes interface{} `json:"attributes" yaml:"attributes"`
	// The behavior-based criteria, such as how recently users have used your app, for the segment.
	Behavior interface{} `json:"behavior" yaml:"behavior"`
	// The demographic-based criteria, such as device platform, for the segment.
	Demographic interface{} `json:"demographic" yaml:"demographic"`
	// The location-based criteria, such as region or GPS coordinates, for the segment.
	Location interface{} `json:"location" yaml:"location"`
	// One or more custom metrics to use as criteria for the segment.
	Metrics interface{} `json:"metrics" yaml:"metrics"`
	// One or more custom user attributes to use as criteria for the segment.
	UserAttributes interface{} `json:"userAttributes" yaml:"userAttributes"`
}

Specifies the dimension settings for a segment.

TODO: EXAMPLE

type CfnSegment_SegmentGroupsProperty 

type CfnSegment_SegmentGroupsProperty struct {
	// Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
	Groups interface{} `json:"groups" yaml:"groups"`
	// Specifies how to handle multiple segment groups for the segment.
	//
	// For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
	Include *string `json:"include" yaml:"include"`
}

Specifies the set of segment criteria to evaluate when handling segment groups for the segment.

TODO: EXAMPLE

type CfnSegment_SetDimensionProperty 

type CfnSegment_SetDimensionProperty struct {
	// The type of segment dimension to use.
	//
	// Valid values are: `INCLUSIVE` , endpoints that match the criteria are included in the segment; and, `EXCLUSIVE` , endpoints that match the criteria are excluded from the segment.
	DimensionType *string `json:"dimensionType" yaml:"dimensionType"`
	// The criteria values to use for the segment dimension.
	//
	// Depending on the value of the `DimensionType` property, endpoints are included or excluded from the segment if their values match the criteria values.
	Values *[]*string `json:"values" yaml:"values"`
}

Specifies the dimension type and values for a segment dimension.

TODO: EXAMPLE

type CfnSegment_SourceSegmentsProperty 

type CfnSegment_SourceSegmentsProperty struct {
	// The unique identifier for the source segment.
	Id *string `json:"id" yaml:"id"`
	// The version number of the source segment.
	Version *float64 `json:"version" yaml:"version"`
}

Specifies the base segment to build the segment on.

A base segment, also called a *source segment* , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.

TODO: EXAMPLE

type CfnSmsTemplate 

type CfnSmsTemplate interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	Body() *string
	SetBody(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DefaultSubstitutions() *string
	SetDefaultSubstitutions(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	TemplateDescription() *string
	SetTemplateDescription(val *string)
	TemplateName() *string
	SetTemplateName(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::SmsTemplate`.

Creates a message template that you can use in messages that are sent through the SMS channel. A *message template* is a set of content and settings that you can define, save, and reuse in messages for any of your Amazon Pinpoint applications.

TODO: EXAMPLE

func NewCfnSmsTemplate 

func NewCfnSmsTemplate(scope constructs.Construct, id *string, props *CfnSmsTemplateProps) CfnSmsTemplate

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

type CfnSmsTemplateProps 

type CfnSmsTemplateProps struct {
	// The message body to use in text messages that are based on the message template.
	Body *string `json:"body" yaml:"body"`
	// The name of the message template.
	TemplateName *string `json:"templateName" yaml:"templateName"`
	// A JSON object that specifies the default values to use for message variables in the message template.
	//
	// This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
	DefaultSubstitutions *string `json:"defaultSubstitutions" yaml:"defaultSubstitutions"`
	// An array of key-value pairs to apply to this resource.
	//
	// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
	Tags interface{} `json:"tags" yaml:"tags"`
	// A custom description of the message template.
	TemplateDescription *string `json:"templateDescription" yaml:"templateDescription"`
}

Properties for defining a `CfnSmsTemplate`.

TODO: EXAMPLE

type CfnVoiceChannel 

type CfnVoiceChannel interface {
	awscdk.CfnResource
	awscdk.IInspectable
	ApplicationId() *string
	SetApplicationId(val *string)
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Enabled() interface{}
	SetEnabled(val interface{})
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Pinpoint::VoiceChannel`.

A *channel* is a type of platform that you can deliver messages to. To send a voice message, you send the message through the voice channel. Before you can use Amazon Pinpoint to send voice messages, you have to enable the voice channel for an Amazon Pinpoint application.

The VoiceChannel resource represents the status and other information about the voice channel for an application.

TODO: EXAMPLE

func NewCfnVoiceChannel 

func NewCfnVoiceChannel(scope constructs.Construct, id *string, props *CfnVoiceChannelProps) CfnVoiceChannel

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

type CfnVoiceChannelProps 

type CfnVoiceChannelProps struct {
	// The unique identifier for the Amazon Pinpoint application that the voice channel applies to.
	ApplicationId *string `json:"applicationId" yaml:"applicationId"`
	// Specifies whether to enable the voice channel for the application.
	Enabled interface{} `json:"enabled" yaml:"enabled"`
}

Properties for defining a `CfnVoiceChannel`.

TODO: EXAMPLE

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.