Documentation ¶
Index ¶
- func CfnADMChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnADMChannel_IsCfnElement(x interface{}) *bool
- func CfnADMChannel_IsCfnResource(x interface{}) *bool
- func CfnADMChannel_IsConstruct(x interface{}) *bool
- func CfnAPNSChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAPNSChannel_IsCfnElement(x interface{}) *bool
- func CfnAPNSChannel_IsCfnResource(x interface{}) *bool
- func CfnAPNSChannel_IsConstruct(x interface{}) *bool
- func CfnAPNSSandboxChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAPNSSandboxChannel_IsCfnElement(x interface{}) *bool
- func CfnAPNSSandboxChannel_IsCfnResource(x interface{}) *bool
- func CfnAPNSSandboxChannel_IsConstruct(x interface{}) *bool
- func CfnAPNSVoipChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAPNSVoipChannel_IsCfnElement(x interface{}) *bool
- func CfnAPNSVoipChannel_IsCfnResource(x interface{}) *bool
- func CfnAPNSVoipChannel_IsConstruct(x interface{}) *bool
- func CfnAPNSVoipSandboxChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnAPNSVoipSandboxChannel_IsCfnElement(x interface{}) *bool
- func CfnAPNSVoipSandboxChannel_IsCfnResource(x interface{}) *bool
- func CfnAPNSVoipSandboxChannel_IsConstruct(x interface{}) *bool
- func CfnApp_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApp_IsCfnElement(x interface{}) *bool
- func CfnApp_IsCfnResource(x interface{}) *bool
- func CfnApp_IsConstruct(x interface{}) *bool
- func CfnApplicationSettings_CFN_RESOURCE_TYPE_NAME() *string
- func CfnApplicationSettings_IsCfnElement(x interface{}) *bool
- func CfnApplicationSettings_IsCfnResource(x interface{}) *bool
- func CfnApplicationSettings_IsConstruct(x interface{}) *bool
- func CfnBaiduChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnBaiduChannel_IsCfnElement(x interface{}) *bool
- func CfnBaiduChannel_IsCfnResource(x interface{}) *bool
- func CfnBaiduChannel_IsConstruct(x interface{}) *bool
- func CfnCampaign_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCampaign_IsCfnElement(x interface{}) *bool
- func CfnCampaign_IsCfnResource(x interface{}) *bool
- func CfnCampaign_IsConstruct(x interface{}) *bool
- func CfnEmailChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEmailChannel_IsCfnElement(x interface{}) *bool
- func CfnEmailChannel_IsCfnResource(x interface{}) *bool
- func CfnEmailChannel_IsConstruct(x interface{}) *bool
- func CfnEmailTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEmailTemplate_IsCfnElement(x interface{}) *bool
- func CfnEmailTemplate_IsCfnResource(x interface{}) *bool
- func CfnEmailTemplate_IsConstruct(x interface{}) *bool
- func CfnEventStream_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventStream_IsCfnElement(x interface{}) *bool
- func CfnEventStream_IsCfnResource(x interface{}) *bool
- func CfnEventStream_IsConstruct(x interface{}) *bool
- func CfnGCMChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnGCMChannel_IsCfnElement(x interface{}) *bool
- func CfnGCMChannel_IsCfnResource(x interface{}) *bool
- func CfnGCMChannel_IsConstruct(x interface{}) *bool
- func CfnInAppTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnInAppTemplate_IsCfnElement(x interface{}) *bool
- func CfnInAppTemplate_IsCfnResource(x interface{}) *bool
- func CfnInAppTemplate_IsConstruct(x interface{}) *bool
- func CfnPushTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnPushTemplate_IsCfnElement(x interface{}) *bool
- func CfnPushTemplate_IsCfnResource(x interface{}) *bool
- func CfnPushTemplate_IsConstruct(x interface{}) *bool
- func CfnSMSChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSMSChannel_IsCfnElement(x interface{}) *bool
- func CfnSMSChannel_IsCfnResource(x interface{}) *bool
- func CfnSMSChannel_IsConstruct(x interface{}) *bool
- func CfnSegment_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSegment_IsCfnElement(x interface{}) *bool
- func CfnSegment_IsCfnResource(x interface{}) *bool
- func CfnSegment_IsConstruct(x interface{}) *bool
- func CfnSmsTemplate_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSmsTemplate_IsCfnElement(x interface{}) *bool
- func CfnSmsTemplate_IsCfnResource(x interface{}) *bool
- func CfnSmsTemplate_IsConstruct(x interface{}) *bool
- func CfnVoiceChannel_CFN_RESOURCE_TYPE_NAME() *string
- func CfnVoiceChannel_IsCfnElement(x interface{}) *bool
- func CfnVoiceChannel_IsCfnResource(x interface{}) *bool
- func CfnVoiceChannel_IsConstruct(x interface{}) *bool
- func NewCfnADMChannel_Override(c CfnADMChannel, scope constructs.Construct, id *string, ...)
- func NewCfnAPNSChannel_Override(c CfnAPNSChannel, scope constructs.Construct, id *string, ...)
- func NewCfnAPNSSandboxChannel_Override(c CfnAPNSSandboxChannel, scope constructs.Construct, id *string, ...)
- func NewCfnAPNSVoipChannel_Override(c CfnAPNSVoipChannel, scope constructs.Construct, id *string, ...)
- func NewCfnAPNSVoipSandboxChannel_Override(c CfnAPNSVoipSandboxChannel, scope constructs.Construct, id *string, ...)
- func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
- func NewCfnApplicationSettings_Override(c CfnApplicationSettings, scope constructs.Construct, id *string, ...)
- func NewCfnBaiduChannel_Override(c CfnBaiduChannel, scope constructs.Construct, id *string, ...)
- func NewCfnCampaign_Override(c CfnCampaign, scope constructs.Construct, id *string, props *CfnCampaignProps)
- func NewCfnEmailChannel_Override(c CfnEmailChannel, scope constructs.Construct, id *string, ...)
- func NewCfnEmailTemplate_Override(c CfnEmailTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnEventStream_Override(c CfnEventStream, scope constructs.Construct, id *string, ...)
- func NewCfnGCMChannel_Override(c CfnGCMChannel, scope constructs.Construct, id *string, ...)
- func NewCfnInAppTemplate_Override(c CfnInAppTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnPushTemplate_Override(c CfnPushTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnSMSChannel_Override(c CfnSMSChannel, scope constructs.Construct, id *string, ...)
- func NewCfnSegment_Override(c CfnSegment, scope constructs.Construct, id *string, props *CfnSegmentProps)
- func NewCfnSmsTemplate_Override(c CfnSmsTemplate, scope constructs.Construct, id *string, ...)
- func NewCfnVoiceChannel_Override(c CfnVoiceChannel, scope constructs.Construct, id *string, ...)
- type CfnADMChannel
- type CfnADMChannelProps
- type CfnAPNSChannel
- type CfnAPNSChannelProps
- type CfnAPNSSandboxChannel
- type CfnAPNSSandboxChannelProps
- type CfnAPNSVoipChannel
- type CfnAPNSVoipChannelProps
- type CfnAPNSVoipSandboxChannel
- type CfnAPNSVoipSandboxChannelProps
- type CfnApp
- type CfnAppProps
- type CfnApplicationSettings
- type CfnApplicationSettingsProps
- type CfnApplicationSettings_CampaignHookProperty
- type CfnApplicationSettings_LimitsProperty
- type CfnApplicationSettings_QuietTimeProperty
- type CfnBaiduChannel
- type CfnBaiduChannelProps
- type CfnCampaign
- type CfnCampaignProps
- type CfnCampaign_AttributeDimensionProperty
- type CfnCampaign_CampaignCustomMessageProperty
- type CfnCampaign_CampaignEmailMessageProperty
- type CfnCampaign_CampaignEventFilterProperty
- type CfnCampaign_CampaignHookProperty
- type CfnCampaign_CampaignInAppMessageProperty
- type CfnCampaign_CampaignSmsMessageProperty
- type CfnCampaign_CustomDeliveryConfigurationProperty
- type CfnCampaign_DefaultButtonConfigurationProperty
- type CfnCampaign_EventDimensionsProperty
- type CfnCampaign_InAppMessageBodyConfigProperty
- type CfnCampaign_InAppMessageButtonProperty
- type CfnCampaign_InAppMessageContentProperty
- type CfnCampaign_InAppMessageHeaderConfigProperty
- type CfnCampaign_LimitsProperty
- type CfnCampaign_MessageConfigurationProperty
- type CfnCampaign_MessageProperty
- type CfnCampaign_MetricDimensionProperty
- type CfnCampaign_OverrideButtonConfigurationProperty
- type CfnCampaign_QuietTimeProperty
- type CfnCampaign_ScheduleProperty
- type CfnCampaign_SetDimensionProperty
- type CfnCampaign_TemplateConfigurationProperty
- type CfnCampaign_TemplateProperty
- type CfnCampaign_WriteTreatmentResourceProperty
- type CfnEmailChannel
- type CfnEmailChannelProps
- type CfnEmailTemplate
- type CfnEmailTemplateProps
- type CfnEventStream
- type CfnEventStreamProps
- type CfnGCMChannel
- type CfnGCMChannelProps
- type CfnInAppTemplate
- type CfnInAppTemplateProps
- type CfnInAppTemplate_BodyConfigProperty
- type CfnInAppTemplate_ButtonConfigProperty
- type CfnInAppTemplate_DefaultButtonConfigurationProperty
- type CfnInAppTemplate_HeaderConfigProperty
- type CfnInAppTemplate_InAppMessageContentProperty
- type CfnInAppTemplate_OverrideButtonConfigurationProperty
- type CfnPushTemplate
- type CfnPushTemplateProps
- type CfnPushTemplate_APNSPushNotificationTemplateProperty
- type CfnPushTemplate_AndroidPushNotificationTemplateProperty
- type CfnPushTemplate_DefaultPushNotificationTemplateProperty
- type CfnSMSChannel
- type CfnSMSChannelProps
- type CfnSegment
- type CfnSegmentProps
- type CfnSegment_AttributeDimensionProperty
- type CfnSegment_BehaviorProperty
- type CfnSegment_CoordinatesProperty
- type CfnSegment_DemographicProperty
- type CfnSegment_GPSPointProperty
- type CfnSegment_GroupsProperty
- type CfnSegment_LocationProperty
- type CfnSegment_RecencyProperty
- type CfnSegment_SegmentDimensionsProperty
- type CfnSegment_SegmentGroupsProperty
- type CfnSegment_SetDimensionProperty
- type CfnSegment_SourceSegmentsProperty
- type CfnSmsTemplate
- type CfnSmsTemplateProps
- type CfnVoiceChannel
- type CfnVoiceChannelProps
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnADMChannel_IsConstruct ¶
func CfnADMChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAPNSChannel_IsConstruct ¶
func CfnAPNSChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAPNSSandboxChannel_IsConstruct ¶
func CfnAPNSSandboxChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAPNSVoipChannel_IsConstruct ¶
func CfnAPNSVoipChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnAPNSVoipSandboxChannel_IsConstruct ¶
func CfnAPNSVoipSandboxChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApp_IsConstruct ¶
func CfnApp_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnApplicationSettings_IsConstruct ¶
func CfnApplicationSettings_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnBaiduChannel_IsConstruct ¶
func CfnBaiduChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCampaign_IsConstruct ¶
func CfnCampaign_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEmailChannel_IsConstruct ¶
func CfnEmailChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEmailTemplate_IsConstruct ¶
func CfnEmailTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEventStream_IsConstruct ¶
func CfnEventStream_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnGCMChannel_IsConstruct ¶
func CfnGCMChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnInAppTemplate_IsConstruct ¶
func CfnInAppTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnPushTemplate_IsConstruct ¶
func CfnPushTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSMSChannel_IsConstruct ¶
func CfnSMSChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSegment_IsConstruct ¶
func CfnSegment_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSmsTemplate_IsConstruct ¶
func CfnSmsTemplate_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
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(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnVoiceChannel_IsConstruct ¶
func CfnVoiceChannel_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnADMChannel_Override ¶
func NewCfnADMChannel_Override(c CfnADMChannel, scope constructs.Construct, id *string, props *CfnADMChannelProps)
func NewCfnAPNSChannel_Override ¶
func NewCfnAPNSChannel_Override(c CfnAPNSChannel, scope constructs.Construct, id *string, props *CfnAPNSChannelProps)
func NewCfnAPNSSandboxChannel_Override ¶
func NewCfnAPNSSandboxChannel_Override(c CfnAPNSSandboxChannel, scope constructs.Construct, id *string, props *CfnAPNSSandboxChannelProps)
func NewCfnAPNSVoipChannel_Override ¶
func NewCfnAPNSVoipChannel_Override(c CfnAPNSVoipChannel, scope constructs.Construct, id *string, props *CfnAPNSVoipChannelProps)
func NewCfnAPNSVoipSandboxChannel_Override ¶
func NewCfnAPNSVoipSandboxChannel_Override(c CfnAPNSVoipSandboxChannel, scope constructs.Construct, id *string, props *CfnAPNSVoipSandboxChannelProps)
func NewCfnApp_Override ¶
func NewCfnApp_Override(c CfnApp, scope constructs.Construct, id *string, props *CfnAppProps)
func NewCfnApplicationSettings_Override ¶
func NewCfnApplicationSettings_Override(c CfnApplicationSettings, scope constructs.Construct, id *string, props *CfnApplicationSettingsProps)
func NewCfnBaiduChannel_Override ¶
func NewCfnBaiduChannel_Override(c CfnBaiduChannel, scope constructs.Construct, id *string, props *CfnBaiduChannelProps)
func NewCfnCampaign_Override ¶
func NewCfnCampaign_Override(c CfnCampaign, scope constructs.Construct, id *string, props *CfnCampaignProps)
func NewCfnEmailChannel_Override ¶
func NewCfnEmailChannel_Override(c CfnEmailChannel, scope constructs.Construct, id *string, props *CfnEmailChannelProps)
func NewCfnEmailTemplate_Override ¶
func NewCfnEmailTemplate_Override(c CfnEmailTemplate, scope constructs.Construct, id *string, props *CfnEmailTemplateProps)
func NewCfnEventStream_Override ¶
func NewCfnEventStream_Override(c CfnEventStream, scope constructs.Construct, id *string, props *CfnEventStreamProps)
func NewCfnGCMChannel_Override ¶
func NewCfnGCMChannel_Override(c CfnGCMChannel, scope constructs.Construct, id *string, props *CfnGCMChannelProps)
func NewCfnInAppTemplate_Override ¶
func NewCfnInAppTemplate_Override(c CfnInAppTemplate, scope constructs.Construct, id *string, props *CfnInAppTemplateProps)
func NewCfnPushTemplate_Override ¶
func NewCfnPushTemplate_Override(c CfnPushTemplate, scope constructs.Construct, id *string, props *CfnPushTemplateProps)
func NewCfnSMSChannel_Override ¶
func NewCfnSMSChannel_Override(c CfnSMSChannel, scope constructs.Construct, id *string, props *CfnSMSChannelProps)
func NewCfnSegment_Override ¶
func NewCfnSegment_Override(c CfnSegment, scope constructs.Construct, id *string, props *CfnSegmentProps)
func NewCfnSmsTemplate_Override ¶
func NewCfnSmsTemplate_Override(c CfnSmsTemplate, scope constructs.Construct, id *string, props *CfnSmsTemplateProps)
func NewCfnVoiceChannel_Override ¶
func NewCfnVoiceChannel_Override(c CfnVoiceChannel, scope constructs.Construct, id *string, props *CfnVoiceChannelProps)
Types ¶
type CfnADMChannel ¶
type CfnADMChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the ADM channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // The Client ID that you received from Amazon to send messages by using ADM. ClientId() *string SetClientId(val *string) // The Client Secret that you received from Amazon to send messages by using ADM. ClientSecret() *string SetClientSecret(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies whether to enable the ADM channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnADMChannel := awscdk.Aws_pinpoint.NewCfnADMChannel(this, jsii.String("MyCfnADMChannel"), &CfnADMChannelProps{ ApplicationId: jsii.String("applicationId"), ClientId: jsii.String("clientId"), ClientSecret: jsii.String("clientSecret"), // the properties below are optional Enabled: jsii.Boolean(false), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
func NewCfnADMChannel ¶
func NewCfnADMChannel(scope constructs.Construct, id *string, props *CfnADMChannelProps) CfnADMChannel
type CfnADMChannelProps ¶
type CfnADMChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the ADM channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The Client ID that you received from Amazon to send messages by using ADM. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientid // ClientId *string `field:"required" json:"clientId" yaml:"clientId"` // The Client Secret that you received from Amazon to send messages by using ADM. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-clientsecret // ClientSecret *string `field:"required" json:"clientSecret" yaml:"clientSecret"` // Specifies whether to enable the ADM channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html#cfn-pinpoint-admchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Properties for defining a `CfnADMChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnADMChannelProps := &CfnADMChannelProps{ ApplicationId: jsii.String("applicationId"), ClientId: jsii.String("clientId"), ClientSecret: jsii.String("clientSecret"), // the properties below are optional Enabled: jsii.Boolean(false), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-admchannel.html
type CfnAPNSChannel ¶
type CfnAPNSChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the APNs channel. // // This property is retained only for backward compatibility. AttrId() *string // The bundle identifier that's assigned to your iOS app. BundleId() *string SetBundleId(val *string) // The APNs client certificate that you received from Apple. Certificate() *string SetCertificate(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. DefaultAuthenticationMethod() *string SetDefaultAuthenticationMethod(val *string) // Specifies whether to enable the APNs channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. PrivateKey() *string SetPrivateKey(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The identifier that's assigned to your Apple Developer Account team. TeamId() *string SetTeamId(val *string) // The authentication key to use for APNs tokens. TokenKey() *string SetTokenKey(val *string) // The key identifier that's assigned to your APNs signing key. TokenKeyId() *string SetTokenKeyId(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSChannel := awscdk.Aws_pinpoint.NewCfnAPNSChannel(this, jsii.String("MyCfnAPNSChannel"), &CfnAPNSChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html
func NewCfnAPNSChannel ¶
func NewCfnAPNSChannel(scope constructs.Construct, id *string, props *CfnAPNSChannelProps) CfnAPNSChannel
type CfnAPNSChannelProps ¶
type CfnAPNSChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the APNs channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The bundle identifier that's assigned to your iOS app. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-bundleid // BundleId *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-certificate // Certificate *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-defaultauthenticationmethod // DefaultAuthenticationMethod *string `field:"optional" json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"` // Specifies whether to enable the APNs channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-privatekey // PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"` // The identifier that's assigned to your Apple Developer Account team. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-teamid // TeamId *string `field:"optional" json:"teamId" yaml:"teamId"` // The authentication key to use for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkey // TokenKey *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html#cfn-pinpoint-apnschannel-tokenkeyid // TokenKeyId *string `field:"optional" json:"tokenKeyId" yaml:"tokenKeyId"` }
Properties for defining a `CfnAPNSChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSChannelProps := &CfnAPNSChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnschannel.html
type CfnAPNSSandboxChannel ¶
type CfnAPNSSandboxChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the APNs sandbox channel. // // This property is retained only for backward compatibility. AttrId() *string // The bundle identifier that's assigned to your iOS app. BundleId() *string SetBundleId(val *string) // The APNs client certificate that you received from Apple. Certificate() *string SetCertificate(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. DefaultAuthenticationMethod() *string SetDefaultAuthenticationMethod(val *string) // Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. PrivateKey() *string SetPrivateKey(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The identifier that's assigned to your Apple Developer Account team. TeamId() *string SetTeamId(val *string) // The authentication key to use for APNs tokens. TokenKey() *string SetTokenKey(val *string) // The key identifier that's assigned to your APNs signing key. TokenKeyId() *string SetTokenKeyId(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSSandboxChannel := awscdk.Aws_pinpoint.NewCfnAPNSSandboxChannel(this, jsii.String("MyCfnAPNSSandboxChannel"), &CfnAPNSSandboxChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), })
func NewCfnAPNSSandboxChannel ¶
func NewCfnAPNSSandboxChannel(scope constructs.Construct, id *string, props *CfnAPNSSandboxChannelProps) CfnAPNSSandboxChannel
type CfnAPNSSandboxChannelProps ¶
type CfnAPNSSandboxChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the APNs sandbox channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The bundle identifier that's assigned to your iOS app. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-bundleid // BundleId *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-certificate // Certificate *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-defaultauthenticationmethod // DefaultAuthenticationMethod *string `field:"optional" json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"` // Specifies whether to enable the APNs Sandbox channel for the Amazon Pinpoint application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-privatekey // PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"` // The identifier that's assigned to your Apple Developer Account team. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-teamid // TeamId *string `field:"optional" json:"teamId" yaml:"teamId"` // The authentication key to use for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkey // TokenKey *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnssandboxchannel.html#cfn-pinpoint-apnssandboxchannel-tokenkeyid // TokenKeyId *string `field:"optional" json:"tokenKeyId" yaml:"tokenKeyId"` }
Properties for defining a `CfnAPNSSandboxChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSSandboxChannelProps := &CfnAPNSSandboxChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), }
type CfnAPNSVoipChannel ¶
type CfnAPNSVoipChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the APNs VoIP channel. // // This property is retained only for backward compatibility. AttrId() *string // The bundle identifier that's assigned to your iOS app. BundleId() *string SetBundleId(val *string) // The APNs client certificate that you received from Apple. Certificate() *string SetCertificate(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. DefaultAuthenticationMethod() *string SetDefaultAuthenticationMethod(val *string) // Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. PrivateKey() *string SetPrivateKey(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The identifier that's assigned to your Apple Developer Account team. TeamId() *string SetTeamId(val *string) // The authentication key to use for APNs tokens. TokenKey() *string SetTokenKey(val *string) // The key identifier that's assigned to your APNs signing key. TokenKeyId() *string SetTokenKeyId(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSVoipChannel := awscdk.Aws_pinpoint.NewCfnAPNSVoipChannel(this, jsii.String("MyCfnAPNSVoipChannel"), &CfnAPNSVoipChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), })
func NewCfnAPNSVoipChannel ¶
func NewCfnAPNSVoipChannel(scope constructs.Construct, id *string, props *CfnAPNSVoipChannelProps) CfnAPNSVoipChannel
type CfnAPNSVoipChannelProps ¶
type CfnAPNSVoipChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the APNs VoIP channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The bundle identifier that's assigned to your iOS app. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-bundleid // BundleId *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-certificate // Certificate *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-defaultauthenticationmethod // DefaultAuthenticationMethod *string `field:"optional" json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"` // Specifies whether to enable the APNs VoIP channel for the Amazon Pinpoint application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-privatekey // PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"` // The identifier that's assigned to your Apple Developer Account team. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-teamid // TeamId *string `field:"optional" json:"teamId" yaml:"teamId"` // The authentication key to use for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkey // TokenKey *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipchannel.html#cfn-pinpoint-apnsvoipchannel-tokenkeyid // TokenKeyId *string `field:"optional" json:"tokenKeyId" yaml:"tokenKeyId"` }
Properties for defining a `CfnAPNSVoipChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSVoipChannelProps := &CfnAPNSVoipChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), }
type CfnAPNSVoipSandboxChannel ¶
type CfnAPNSVoipSandboxChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the application that the APNs VoIP sandbox channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the APNs VoIP sandbox channel. // // This property is retained only for backward compatibility. AttrId() *string // The bundle identifier that's assigned to your iOS app. BundleId() *string SetBundleId(val *string) // The APNs client certificate that you received from Apple. Certificate() *string SetCertificate(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs. DefaultAuthenticationMethod() *string SetDefaultAuthenticationMethod(val *string) // Specifies whether the APNs VoIP sandbox channel is enabled for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment. PrivateKey() *string SetPrivateKey(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The identifier that's assigned to your Apple developer account team. TeamId() *string SetTeamId(val *string) // The authentication key to use for APNs tokens. TokenKey() *string SetTokenKey(val *string) // The key identifier that's assigned to your APNs signing key. TokenKeyId() *string SetTokenKeyId(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSVoipSandboxChannel := awscdk.Aws_pinpoint.NewCfnAPNSVoipSandboxChannel(this, jsii.String("MyCfnAPNSVoipSandboxChannel"), &CfnAPNSVoipSandboxChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), })
func NewCfnAPNSVoipSandboxChannel ¶
func NewCfnAPNSVoipSandboxChannel(scope constructs.Construct, id *string, props *CfnAPNSVoipSandboxChannelProps) CfnAPNSVoipSandboxChannel
type CfnAPNSVoipSandboxChannelProps ¶
type CfnAPNSVoipSandboxChannelProps struct { // The unique identifier for the application that the APNs VoIP sandbox channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The bundle identifier that's assigned to your iOS app. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-bundleid // BundleId *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-certificate // Certificate *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-defaultauthenticationmethod // DefaultAuthenticationMethod *string `field:"optional" json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"` // Specifies whether the APNs VoIP sandbox channel is enabled for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-enabled // Enabled interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-privatekey // PrivateKey *string `field:"optional" json:"privateKey" yaml:"privateKey"` // The identifier that's assigned to your Apple developer account team. // // This identifier is used for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-teamid // TeamId *string `field:"optional" json:"teamId" yaml:"teamId"` // The authentication key to use for APNs tokens. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkey // TokenKey *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-apnsvoipsandboxchannel.html#cfn-pinpoint-apnsvoipsandboxchannel-tokenkeyid // TokenKeyId *string `field:"optional" json:"tokenKeyId" yaml:"tokenKeyId"` }
Properties for defining a `CfnAPNSVoipSandboxChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnAPNSVoipSandboxChannelProps := &CfnAPNSVoipSandboxChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional BundleId: jsii.String("bundleId"), Certificate: jsii.String("certificate"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), PrivateKey: jsii.String("privateKey"), TeamId: jsii.String("teamId"), TokenKey: jsii.String("tokenKey"), TokenKeyId: jsii.String("tokenKeyId"), }
type CfnApp ¶
type CfnApp interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the application. AttrArn() *string // The unique identifier for the application. // // This identifier is displayed as the *Project ID* on the Amazon Pinpoint console. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The display name of the application. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnApp := awscdk.Aws_pinpoint.NewCfnApp(this, jsii.String("MyCfnApp"), &CfnAppProps{ Name: jsii.String("name"), // the properties below are optional Tags: tags, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html
func NewCfnApp ¶
func NewCfnApp(scope constructs.Construct, id *string, props *CfnAppProps) CfnApp
type CfnAppProps ¶
type CfnAppProps struct { // The display name of the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-name // Name *string `field:"required" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html#cfn-pinpoint-app-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnApp`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnAppProps := &CfnAppProps{ Name: jsii.String("name"), // the properties below are optional Tags: tags, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html
type CfnApplicationSettings ¶
type CfnApplicationSettings interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application. ApplicationId() *string SetApplicationId(val *string) AttrId() *string // The settings for the Lambda function to use by default as a code hook for campaigns in the application. CampaignHook() interface{} SetCampaignHook(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string CloudWatchMetricsEnabled() interface{} SetCloudWatchMetricsEnabled(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default sending limits for campaigns in the application. Limits() interface{} SetLimits(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The default quiet time for campaigns in the application. QuietTime() interface{} SetQuietTime(val interface{}) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationSettings := awscdk.Aws_pinpoint.NewCfnApplicationSettings(this, jsii.String("MyCfnApplicationSettings"), &CfnApplicationSettingsProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional CampaignHook: &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }, CloudWatchMetricsEnabled: jsii.Boolean(false), Limits: &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Total: jsii.Number(123), }, QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, })
func NewCfnApplicationSettings ¶
func NewCfnApplicationSettings(scope constructs.Construct, id *string, props *CfnApplicationSettingsProps) CfnApplicationSettings
type CfnApplicationSettingsProps ¶
type CfnApplicationSettingsProps struct { // The unique identifier for the Amazon Pinpoint application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-applicationid // ApplicationId *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-campaignhook // CampaignHook interface{} `field:"optional" json:"campaignHook" yaml:"campaignHook"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-cloudwatchmetricsenabled // CloudWatchMetricsEnabled interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-limits // Limits interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-applicationsettings.html#cfn-pinpoint-applicationsettings-quiettime // QuietTime interface{} `field:"optional" json:"quietTime" yaml:"quietTime"` }
Properties for defining a `CfnApplicationSettings`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnApplicationSettingsProps := &CfnApplicationSettingsProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional CampaignHook: &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }, CloudWatchMetricsEnabled: jsii.Boolean(false), Limits: &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Total: jsii.Number(123), }, QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-lambdafunctionname // LambdaFunctionName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-mode // Mode *string `field:"optional" json:"mode" yaml:"mode"` // The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-campaignhook.html#cfn-pinpoint-applicationsettings-campaignhook-weburl // WebUrl *string `field:"optional" json:"webUrl" yaml:"webUrl"` }
Specifies the Lambda function to use by default as a code hook for campaigns in the application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" campaignHookProperty := &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-daily // Daily *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-maximumduration // MaximumDuration *float64 `field:"optional" json:"maximumDuration" yaml:"maximumDuration"` // The maximum number of messages that a campaign can send each second. // // The minimum value is 1. The maximum value is 20,000. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-messagespersecond // MessagesPerSecond *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-limits.html#cfn-pinpoint-applicationsettings-limits-total // Total *float64 `field:"optional" json:"total" yaml:"total"` }
Specifies the default sending limits for campaigns in the application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" limitsProperty := &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Total: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-end // End *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-applicationsettings-quiettime.html#cfn-pinpoint-applicationsettings-quiettime-start // Start *string `field:"required" json:"start" yaml:"start"` }
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" quietTimeProperty := &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }
type CfnBaiduChannel ¶
type CfnBaiduChannel interface { awscdk.CfnResource awscdk.IInspectable // The API key that you received from the Baidu Cloud Push service to communicate with the service. ApiKey() *string SetApiKey(val *string) // The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the Baidu channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies whether to enable the Baidu channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The secret key that you received from the Baidu Cloud Push service to communicate with the service. SecretKey() *string SetSecretKey(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnBaiduChannel := awscdk.Aws_pinpoint.NewCfnBaiduChannel(this, jsii.String("MyCfnBaiduChannel"), &CfnBaiduChannelProps{ ApiKey: jsii.String("apiKey"), ApplicationId: jsii.String("applicationId"), SecretKey: jsii.String("secretKey"), // the properties below are optional Enabled: jsii.Boolean(false), })
func NewCfnBaiduChannel ¶
func NewCfnBaiduChannel(scope constructs.Construct, id *string, props *CfnBaiduChannelProps) CfnBaiduChannel
type CfnBaiduChannelProps ¶
type CfnBaiduChannelProps struct { // The API key that you received from the Baidu Cloud Push service to communicate with the service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-apikey // ApiKey *string `field:"required" json:"apiKey" yaml:"apiKey"` // The unique identifier for the Amazon Pinpoint application that you're configuring the Baidu channel for. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The secret key that you received from the Baidu Cloud Push service to communicate with the service. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-secretkey // SecretKey *string `field:"required" json:"secretKey" yaml:"secretKey"` // Specifies whether to enable the Baidu channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-baiduchannel.html#cfn-pinpoint-baiduchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Properties for defining a `CfnBaiduChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnBaiduChannelProps := &CfnBaiduChannelProps{ ApiKey: jsii.String("apiKey"), ApplicationId: jsii.String("applicationId"), SecretKey: jsii.String("secretKey"), // the properties below are optional Enabled: jsii.Boolean(false), }
type CfnCampaign ¶
type CfnCampaign interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. AdditionalTreatments() interface{} SetAdditionalTreatments(val interface{}) // The unique identifier for the Amazon Pinpoint application that the campaign is associated with. ApplicationId() *string SetApplicationId(val *string) // The Amazon Resource Name (ARN) of the campaign. AttrArn() *string // The unique identifier for the campaign. AttrCampaignId() *string // Specifies the Lambda function to use as a code hook for a campaign. CampaignHook() interface{} SetCampaignHook(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The delivery configuration settings for sending the treatment through a custom channel. CustomDeliveryConfiguration() interface{} SetCustomDeliveryConfiguration(val interface{}) // A custom description of the campaign. Description() *string SetDescription(val *string) // The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. HoldoutPercent() *float64 SetHoldoutPercent(val *float64) // Specifies whether to pause the campaign. IsPaused() interface{} SetIsPaused(val interface{}) // The messaging limits for the campaign. Limits() interface{} SetLimits(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The message configuration settings for the treatment. MessageConfiguration() interface{} SetMessageConfiguration(val interface{}) // The name of the campaign. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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. Priority() *float64 SetPriority(val *float64) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The schedule settings for the treatment. Schedule() interface{} SetSchedule(val interface{}) // The unique identifier for the segment to associate with the campaign. SegmentId() *string SetSegmentId(val *string) // The version of the segment to associate with the campaign. SegmentVersion() *float64 SetSegmentVersion(val *float64) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // The message template to use for the treatment. TemplateConfiguration() interface{} SetTemplateConfiguration(val interface{}) // A custom description of the treatment. TreatmentDescription() *string SetTreatmentDescription(val *string) // A custom name for the treatment. TreatmentName() *string SetTreatmentName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Specifies the settings for a campaign.
A *campaign* is a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var customConfig interface{} var metrics interface{} var tags interface{} cfnCampaign := awscdk.Aws_pinpoint.NewCfnCampaign(this, jsii.String("MyCfnCampaign"), &CfnCampaignProps{ ApplicationId: jsii.String("applicationId"), Name: jsii.String("name"), Schedule: &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }, SegmentId: jsii.String("segmentId"), // the properties below are optional AdditionalTreatments: []interface{}{ &WriteTreatmentResourceProperty{ CustomDeliveryConfiguration: &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }, MessageConfiguration: &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }, Schedule: &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }, SizePercent: jsii.Number(123), TemplateConfiguration: &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }, TreatmentDescription: jsii.String("treatmentDescription"), TreatmentName: jsii.String("treatmentName"), }, }, CampaignHook: &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }, CustomDeliveryConfiguration: &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }, Description: jsii.String("description"), HoldoutPercent: jsii.Number(123), IsPaused: jsii.Boolean(false), Limits: &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Session: jsii.Number(123), Total: jsii.Number(123), }, MessageConfiguration: &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }, Priority: jsii.Number(123), SegmentVersion: jsii.Number(123), Tags: tags, TemplateConfiguration: &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }, TreatmentDescription: jsii.String("treatmentDescription"), TreatmentName: jsii.String("treatmentName"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html
func NewCfnCampaign ¶
func NewCfnCampaign(scope constructs.Construct, id *string, props *CfnCampaignProps) CfnCampaign
type CfnCampaignProps ¶
type CfnCampaignProps struct { // The unique identifier for the Amazon Pinpoint application that the campaign is associated with. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The name of the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-name // Name *string `field:"required" json:"name" yaml:"name"` // The schedule settings for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-schedule // Schedule interface{} `field:"required" json:"schedule" yaml:"schedule"` // The unique identifier for the segment to associate with the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentid // SegmentId *string `field:"required" json:"segmentId" yaml:"segmentId"` // An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-additionaltreatments // AdditionalTreatments interface{} `field:"optional" json:"additionalTreatments" yaml:"additionalTreatments"` // Specifies the Lambda function to use as a code hook for a campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-campaignhook // CampaignHook interface{} `field:"optional" json:"campaignHook" yaml:"campaignHook"` // The delivery configuration settings for sending the treatment through a custom channel. // // This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-customdeliveryconfiguration // CustomDeliveryConfiguration interface{} `field:"optional" json:"customDeliveryConfiguration" yaml:"customDeliveryConfiguration"` // A custom description of the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-description // Description *string `field:"optional" json:"description" yaml:"description"` // The allocated percentage of users (segment members) who shouldn't receive messages from the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-holdoutpercent // HoldoutPercent *float64 `field:"optional" 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. If a campaign is running it will complete and then pause. Pause only pauses or skips the next run for a recurring future scheduled campaign. A campaign scheduled for immediate can't be paused. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-ispaused // IsPaused interface{} `field:"optional" json:"isPaused" yaml:"isPaused"` // The messaging limits for the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-limits // Limits interface{} `field:"optional" json:"limits" yaml:"limits"` // The message configuration settings for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-messageconfiguration // MessageConfiguration interface{} `field:"optional" json:"messageConfiguration" yaml:"messageConfiguration"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-priority // Priority *float64 `field:"optional" json:"priority" yaml:"priority"` // The version of the segment to associate with the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-segmentversion // SegmentVersion *float64 `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // The message template to use for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-templateconfiguration // TemplateConfiguration interface{} `field:"optional" json:"templateConfiguration" yaml:"templateConfiguration"` // A custom description of the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentdescription // TreatmentDescription *string `field:"optional" json:"treatmentDescription" yaml:"treatmentDescription"` // A custom name for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html#cfn-pinpoint-campaign-treatmentname // TreatmentName *string `field:"optional" json:"treatmentName" yaml:"treatmentName"` }
Properties for defining a `CfnCampaign`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var customConfig interface{} var metrics interface{} var tags interface{} cfnCampaignProps := &CfnCampaignProps{ ApplicationId: jsii.String("applicationId"), Name: jsii.String("name"), Schedule: &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }, SegmentId: jsii.String("segmentId"), // the properties below are optional AdditionalTreatments: []interface{}{ &WriteTreatmentResourceProperty{ CustomDeliveryConfiguration: &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }, MessageConfiguration: &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }, Schedule: &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }, SizePercent: jsii.Number(123), TemplateConfiguration: &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }, TreatmentDescription: jsii.String("treatmentDescription"), TreatmentName: jsii.String("treatmentName"), }, }, CampaignHook: &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }, CustomDeliveryConfiguration: &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }, Description: jsii.String("description"), HoldoutPercent: jsii.Number(123), IsPaused: jsii.Boolean(false), Limits: &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Session: jsii.Number(123), Total: jsii.Number(123), }, MessageConfiguration: &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }, Priority: jsii.Number(123), SegmentVersion: jsii.Number(123), Tags: tags, TemplateConfiguration: &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }, TreatmentDescription: jsii.String("treatmentDescription"), TreatmentName: jsii.String("treatmentName"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-campaign.html
type CfnCampaign_AttributeDimensionProperty ¶
type CfnCampaign_AttributeDimensionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-attributetype // AttributeType *string `field:"optional" json:"attributeType" yaml:"attributeType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-attributedimension.html#cfn-pinpoint-campaign-attributedimension-values // Values *[]*string `field:"optional" json:"values" yaml:"values"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" attributeDimensionProperty := &AttributeDimensionProperty{ AttributeType: jsii.String("attributeType"), Values: []*string{ jsii.String("values"), }, }
type CfnCampaign_CampaignCustomMessageProperty ¶ added in v2.27.0
type CfnCampaign_CampaignCustomMessageProperty struct { // The raw, JSON-formatted string to use as the payload for the message. // // The maximum size is 5 KB. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigncustommessage.html#cfn-pinpoint-campaign-campaigncustommessage-data // Data *string `field:"optional" json:"data" yaml:"data"` }
Specifies the contents of a message that's sent through a custom channel to recipients of a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" campaignCustomMessageProperty := &CampaignCustomMessageProperty{ Data: jsii.String("data"), }
type CfnCampaign_CampaignEmailMessageProperty ¶
type CfnCampaign_CampaignEmailMessageProperty struct { // The body of the email for recipients whose email clients don't render HTML content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-body // Body *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-fromaddress // FromAddress *string `field:"optional" json:"fromAddress" yaml:"fromAddress"` // The body of the email, in HTML format, for recipients whose email clients render HTML content. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-htmlbody // HtmlBody *string `field:"optional" json:"htmlBody" yaml:"htmlBody"` // The subject line, or title, of the email. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignemailmessage.html#cfn-pinpoint-campaign-campaignemailmessage-title // Title *string `field:"optional" json:"title" yaml:"title"` }
Specifies the content and "From" address for an email message that's sent to recipients of a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" campaignEmailMessageProperty := &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }
type CfnCampaign_CampaignEventFilterProperty ¶
type CfnCampaign_CampaignEventFilterProperty struct { // The dimension settings of the event filter for the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-dimensions // Dimensions interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigneventfilter.html#cfn-pinpoint-campaign-campaigneventfilter-filtertype // FilterType *string `field:"optional" json:"filterType" yaml:"filterType"` }
Specifies the settings for events that cause a campaign to be sent.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} campaignEventFilterProperty := &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-lambdafunctionname // LambdaFunctionName *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-mode // Mode *string `field:"optional" json:"mode" yaml:"mode"` // The web URL that Amazon Pinpoint calls to invoke the Lambda function over HTTPS. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignhook.html#cfn-pinpoint-campaign-campaignhook-weburl // WebUrl *string `field:"optional" json:"webUrl" yaml:"webUrl"` }
Specifies settings for invoking an Lambda function that customizes a segment for a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" campaignHookProperty := &CampaignHookProperty{ LambdaFunctionName: jsii.String("lambdaFunctionName"), Mode: jsii.String("mode"), WebUrl: jsii.String("webUrl"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-content // Content interface{} `field:"optional" json:"content" yaml:"content"` // Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-customconfig // CustomConfig interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaigninappmessage.html#cfn-pinpoint-campaign-campaigninappmessage-layout // Layout *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customConfig interface{} campaignInAppMessageProperty := &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }
type CfnCampaign_CampaignSmsMessageProperty ¶
type CfnCampaign_CampaignSmsMessageProperty struct { // The body of the SMS message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-body // Body *string `field:"optional" json:"body" yaml:"body"` // The entity ID or Principal Entity (PE) id received from the regulatory body for sending SMS in your country. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-entityid // EntityId *string `field:"optional" 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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-messagetype // MessageType *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-originationnumber // OriginationNumber *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-senderid // SenderId *string `field:"optional" json:"senderId" yaml:"senderId"` // The template ID received from the regulatory body for sending SMS in your country. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-campaignsmsmessage.html#cfn-pinpoint-campaign-campaignsmsmessage-templateid // TemplateId *string `field:"optional" json:"templateId" yaml:"templateId"` }
Specifies the content and settings for an SMS message that's sent to recipients of a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" campaignSmsMessageProperty := &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }
type CfnCampaign_CustomDeliveryConfigurationProperty ¶ added in v2.27.0
type CfnCampaign_CustomDeliveryConfigurationProperty struct { // The destination to send the campaign or treatment to. This value can be one of the following:. // // - The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. // - The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-deliveryuri // DeliveryUri *string `field:"optional" json:"deliveryUri" yaml:"deliveryUri"` // The types of endpoints to send the campaign or treatment to. // // Each valid value maps to a type of channel that you can associate with an endpoint by using the `ChannelType` property of an endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-customdeliveryconfiguration.html#cfn-pinpoint-campaign-customdeliveryconfiguration-endpointtypes // EndpointTypes *[]*string `field:"optional" json:"endpointTypes" yaml:"endpointTypes"` }
Specifies the delivery configuration settings for sending a campaign or campaign treatment through a custom channel.
This object is required if you use the `CampaignCustomMessage` object to define the message to send for the campaign or campaign treatment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customDeliveryConfigurationProperty := &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }
type CfnCampaign_DefaultButtonConfigurationProperty ¶
type CfnCampaign_DefaultButtonConfigurationProperty struct { // The background color of a button, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-backgroundcolor // BackgroundColor *string `field:"optional" json:"backgroundColor" yaml:"backgroundColor"` // The border radius of a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-borderradius // BorderRadius *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-buttonaction // ButtonAction *string `field:"optional" json:"buttonAction" yaml:"buttonAction"` // The destination (such as a URL) for a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-link // Link *string `field:"optional" json:"link" yaml:"link"` // The text that appears on a button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-text // Text *string `field:"optional" json:"text" yaml:"text"` // The color of the body text in a button, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-defaultbuttonconfiguration.html#cfn-pinpoint-campaign-defaultbuttonconfiguration-textcolor // TextColor *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultButtonConfigurationProperty := &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-attributes // Attributes interface{} `field:"optional" 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` or `_custom.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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-eventtype // EventType interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-eventdimensions.html#cfn-pinpoint-campaign-eventdimensions-metrics // Metrics interface{} `field:"optional" json:"metrics" yaml:"metrics"` }
Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} eventDimensionsProperty := &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }
type CfnCampaign_InAppMessageBodyConfigProperty ¶
type CfnCampaign_InAppMessageBodyConfigProperty struct { // The text alignment of the main body text of the message. // // Acceptable values: `LEFT` , `CENTER` , `RIGHT` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-alignment // Alignment *string `field:"optional" json:"alignment" yaml:"alignment"` // The main body text of the message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-body // Body *string `field:"optional" 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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebodyconfig.html#cfn-pinpoint-campaign-inappmessagebodyconfig-textcolor // TextColor *string `field:"optional" json:"textColor" yaml:"textColor"` }
Specifies the configuration of main body text of the in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inAppMessageBodyConfigProperty := &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }
type CfnCampaign_InAppMessageButtonProperty ¶
type CfnCampaign_InAppMessageButtonProperty struct { // An object that defines the default behavior for a button in in-app messages sent to Android. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-android // Android interface{} `field:"optional" json:"android" yaml:"android"` // An object that defines the default behavior for a button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-defaultconfig // DefaultConfig interface{} `field:"optional" json:"defaultConfig" yaml:"defaultConfig"` // An object that defines the default behavior for a button in in-app messages sent to iOS devices. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-ios // Ios interface{} `field:"optional" json:"ios" yaml:"ios"` // An object that defines the default behavior for a button in in-app messages for web applications. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagebutton.html#cfn-pinpoint-campaign-inappmessagebutton-web // Web interface{} `field:"optional" json:"web" yaml:"web"` }
Specifies the configuration of a button that appears in an in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inAppMessageButtonProperty := &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }
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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-backgroundcolor // BackgroundColor *string `field:"optional" json:"backgroundColor" yaml:"backgroundColor"` // Specifies the configuration of main body text in an in-app message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-bodyconfig // BodyConfig interface{} `field:"optional" json:"bodyConfig" yaml:"bodyConfig"` // Specifies the configuration and content of the header or title text of the in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-headerconfig // HeaderConfig interface{} `field:"optional" json:"headerConfig" yaml:"headerConfig"` // The URL of the image that appears on an in-app message banner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-imageurl // ImageUrl *string `field:"optional" json:"imageUrl" yaml:"imageUrl"` // An object that contains configuration information about the primary button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-primarybtn // PrimaryBtn interface{} `field:"optional" json:"primaryBtn" yaml:"primaryBtn"` // An object that contains configuration information about the secondary button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessagecontent.html#cfn-pinpoint-campaign-inappmessagecontent-secondarybtn // SecondaryBtn interface{} `field:"optional" json:"secondaryBtn" yaml:"secondaryBtn"` }
Specifies the configuration and contents of an in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inAppMessageContentProperty := &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }
type CfnCampaign_InAppMessageHeaderConfigProperty ¶
type CfnCampaign_InAppMessageHeaderConfigProperty struct { // The text alignment of the title of the message. // // Acceptable values: `LEFT` , `CENTER` , `RIGHT` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-alignment // Alignment *string `field:"optional" json:"alignment" yaml:"alignment"` // The header or title text of the in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-header // Header *string `field:"optional" 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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-inappmessageheaderconfig.html#cfn-pinpoint-campaign-inappmessageheaderconfig-textcolor // TextColor *string `field:"optional" json:"textColor" yaml:"textColor"` }
Specifies the configuration and content of the header or title text of the in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inAppMessageHeaderConfigProperty := &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-daily // Daily *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-maximumduration // MaximumDuration *float64 `field:"optional" json:"maximumDuration" yaml:"maximumDuration"` // The maximum number of messages that a campaign can send each second. // // The minimum value is 1. The maximum value is 20,000. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-messagespersecond // MessagesPerSecond *float64 `field:"optional" json:"messagesPerSecond" yaml:"messagesPerSecond"` // The maximum number of messages that the campaign can send per user session. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-session // Session *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-limits.html#cfn-pinpoint-campaign-limits-total // Total *float64 `field:"optional" json:"total" yaml:"total"` }
Specifies the limits on the messages that a campaign can send.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" limitsProperty := &LimitsProperty{ Daily: jsii.Number(123), MaximumDuration: jsii.Number(123), MessagesPerSecond: jsii.Number(123), Session: jsii.Number(123), Total: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-admmessage // AdmMessage interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-apnsmessage // ApnsMessage interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-baidumessage // BaiduMessage interface{} `field:"optional" json:"baiduMessage" yaml:"baiduMessage"` // The message that the campaign sends through a custom channel, as specified by the delivery configuration ( `CustomDeliveryConfiguration` ) settings for the campaign. // // If specified, this message overrides the default message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-custommessage // CustomMessage interface{} `field:"optional" json:"customMessage" yaml:"customMessage"` // The default message that the campaign sends through all the channels that are configured for the campaign. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-defaultmessage // DefaultMessage interface{} `field:"optional" json:"defaultMessage" yaml:"defaultMessage"` // The message that the campaign sends through the email channel. If specified, this message overrides the default message. // // > The maximum email message size is 200 KB. You can use email templates to send larger email messages. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-emailmessage // EmailMessage interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-gcmmessage // GcmMessage interface{} `field:"optional" json:"gcmMessage" yaml:"gcmMessage"` // The default message for the in-app messaging channel. // // This message overrides the default message ( `DefaultMessage` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-inappmessage // InAppMessage interface{} `field:"optional" json:"inAppMessage" yaml:"inAppMessage"` // The message that the campaign sends through the SMS channel. // // If specified, this message overrides the default message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-messageconfiguration.html#cfn-pinpoint-campaign-messageconfiguration-smsmessage // SmsMessage interface{} `field:"optional" json:"smsMessage" yaml:"smsMessage"` }
Specifies the message configuration settings for a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customConfig interface{} messageConfigurationProperty := &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-action // Action *string `field:"optional" json:"action" yaml:"action"` // The body of the notification message. // // The maximum number of characters is 200. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-body // Body *string `field:"optional" json:"body" yaml:"body"` // The URL of the image to display as the push notification icon, such as the icon for the app. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageiconurl // ImageIconUrl *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imagesmalliconurl // ImageSmallIconUrl *string `field:"optional" json:"imageSmallIconUrl" yaml:"imageSmallIconUrl"` // The URL of an image to display in the push notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-imageurl // ImageUrl *string `field:"optional" json:"imageUrl" yaml:"imageUrl"` // The JSON payload to use for a silent push notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-jsonbody // JsonBody *string `field:"optional" json:"jsonBody" yaml:"jsonBody"` // The URL of the image or video to display in the push notification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-mediaurl // MediaUrl *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-rawcontent // RawContent *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-silentpush // SilentPush interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-timetolive // TimeToLive *float64 `field:"optional" json:"timeToLive" yaml:"timeToLive"` // The title to display above the notification message on a recipient's device. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-title // Title *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-message.html#cfn-pinpoint-campaign-message-url // Url *string `field:"optional" json:"url" yaml:"url"` }
Specifies the content and settings for a push notification that's sent to recipients of a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" messageProperty := &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }
type CfnCampaign_MetricDimensionProperty ¶
type CfnCampaign_MetricDimensionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-comparisonoperator // ComparisonOperator *string `field:"optional" json:"comparisonOperator" yaml:"comparisonOperator"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-metricdimension.html#cfn-pinpoint-campaign-metricdimension-value // Value *float64 `field:"optional" json:"value" yaml:"value"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" metricDimensionProperty := &MetricDimensionProperty{ ComparisonOperator: jsii.String("comparisonOperator"), Value: jsii.Number(123), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-overridebuttonconfiguration.html#cfn-pinpoint-campaign-overridebuttonconfiguration-buttonaction // ButtonAction *string `field:"optional" json:"buttonAction" yaml:"buttonAction"` // The destination (such as a URL) for a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-overridebuttonconfiguration.html#cfn-pinpoint-campaign-overridebuttonconfiguration-link // Link *string `field:"optional" json:"link" yaml:"link"` }
Specifies the configuration of a button with settings that are specific to a certain device type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" overrideButtonConfigurationProperty := &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-quiettime.html#cfn-pinpoint-campaign-quiettime-end // End *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-quiettime.html#cfn-pinpoint-campaign-quiettime-start // Start *string `field:"required" json:"start" yaml:"start"` }
Specifies the start and end times that define a time range when messages aren't sent to endpoints.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" quietTimeProperty := &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }
type CfnCampaign_ScheduleProperty ¶
type CfnCampaign_ScheduleProperty struct { // The scheduled time, in ISO 8601 format, when the campaign ended or will end. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-endtime // EndTime *string `field:"optional" json:"endTime" yaml:"endTime"` // The type of event that causes the campaign to be sent, if the value of the `Frequency` property is `EVENT` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-eventfilter // EventFilter interface{} `field:"optional" json:"eventFilter" yaml:"eventFilter"` // Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-frequency // Frequency *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-islocaltime // IsLocalTime interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-quiettime // QuietTime interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-starttime // StartTime *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-schedule.html#cfn-pinpoint-campaign-schedule-timezone // TimeZone *string `field:"optional" json:"timeZone" yaml:"timeZone"` }
Specifies the schedule settings for a campaign.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} scheduleProperty := &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-dimensiontype // DimensionType *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-setdimension.html#cfn-pinpoint-campaign-setdimension-values // Values *[]*string `field:"optional" json:"values" yaml:"values"` }
Specifies the dimension type and values for a segment dimension.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" setDimensionProperty := &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }
type CfnCampaign_TemplateConfigurationProperty ¶ added in v2.27.0
type CfnCampaign_TemplateConfigurationProperty struct { // The email template to use for the message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-emailtemplate // EmailTemplate interface{} `field:"optional" json:"emailTemplate" yaml:"emailTemplate"` // The push notification template to use for the message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-pushtemplate // PushTemplate interface{} `field:"optional" json:"pushTemplate" yaml:"pushTemplate"` // The SMS template to use for the message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-smstemplate // SmsTemplate interface{} `field:"optional" json:"smsTemplate" yaml:"smsTemplate"` // The voice template to use for the message. // // This object isn't supported for campaigns. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-templateconfiguration.html#cfn-pinpoint-campaign-templateconfiguration-voicetemplate // VoiceTemplate interface{} `field:"optional" json:"voiceTemplate" yaml:"voiceTemplate"` }
Specifies the message template to use for the message, for each type of channel.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" templateConfigurationProperty := &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }
type CfnCampaign_TemplateProperty ¶ added in v2.27.0
type CfnCampaign_TemplateProperty struct { // The name of the message template to use for the message. // // If specified, this value must match the name of an existing message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-name // Name *string `field:"optional" json:"name" yaml:"name"` // The unique identifier for the version of the message template to use for the message. // // If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the [Template Versions](https://docs.aws.amazon.com/pinpoint/latest/apireference/templates-template-name-template-type-versions.html) resource. // // If you don't specify a value for this property, Amazon Pinpoint uses the *active version* of the template. The *active version* is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-version // Version *string `field:"optional" json:"version" yaml:"version"` }
Specifies the name and version of the message template to use for the message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" templateProperty := &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }
type CfnCampaign_WriteTreatmentResourceProperty ¶
type CfnCampaign_WriteTreatmentResourceProperty struct { // The delivery configuration settings for sending the treatment through a custom channel. // // This object is required if the `MessageConfiguration` object for the treatment specifies a `CustomMessage` object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-customdeliveryconfiguration // CustomDeliveryConfiguration interface{} `field:"optional" json:"customDeliveryConfiguration" yaml:"customDeliveryConfiguration"` // The message configuration settings for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-messageconfiguration // MessageConfiguration interface{} `field:"optional" json:"messageConfiguration" yaml:"messageConfiguration"` // The schedule settings for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-schedule // Schedule interface{} `field:"optional" json:"schedule" yaml:"schedule"` // The allocated percentage of users (segment members) to send the treatment to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-sizepercent // SizePercent *float64 `field:"optional" json:"sizePercent" yaml:"sizePercent"` // The message template to use for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-templateconfiguration // TemplateConfiguration interface{} `field:"optional" json:"templateConfiguration" yaml:"templateConfiguration"` // A custom description of the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentdescription // TreatmentDescription *string `field:"optional" json:"treatmentDescription" yaml:"treatmentDescription"` // A custom name for the treatment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-writetreatmentresource.html#cfn-pinpoint-campaign-writetreatmentresource-treatmentname // TreatmentName *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var customConfig interface{} var metrics interface{} writeTreatmentResourceProperty := &WriteTreatmentResourceProperty{ CustomDeliveryConfiguration: &CustomDeliveryConfigurationProperty{ DeliveryUri: jsii.String("deliveryUri"), EndpointTypes: []*string{ jsii.String("endpointTypes"), }, }, MessageConfiguration: &MessageConfigurationProperty{ AdmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, ApnsMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, BaiduMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, CustomMessage: &CampaignCustomMessageProperty{ Data: jsii.String("data"), }, DefaultMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, EmailMessage: &CampaignEmailMessageProperty{ Body: jsii.String("body"), FromAddress: jsii.String("fromAddress"), HtmlBody: jsii.String("htmlBody"), Title: jsii.String("title"), }, GcmMessage: &MessageProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageSmallIconUrl: jsii.String("imageSmallIconUrl"), ImageUrl: jsii.String("imageUrl"), JsonBody: jsii.String("jsonBody"), MediaUrl: jsii.String("mediaUrl"), RawContent: jsii.String("rawContent"), SilentPush: jsii.Boolean(false), TimeToLive: jsii.Number(123), Title: jsii.String("title"), Url: jsii.String("url"), }, InAppMessage: &CampaignInAppMessageProperty{ Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &InAppMessageBodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &InAppMessageHeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &InAppMessageButtonProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), }, SmsMessage: &CampaignSmsMessageProperty{ Body: jsii.String("body"), EntityId: jsii.String("entityId"), MessageType: jsii.String("messageType"), OriginationNumber: jsii.String("originationNumber"), SenderId: jsii.String("senderId"), TemplateId: jsii.String("templateId"), }, }, Schedule: &ScheduleProperty{ EndTime: jsii.String("endTime"), EventFilter: &CampaignEventFilterProperty{ Dimensions: &EventDimensionsProperty{ Attributes: attributes, EventType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Metrics: metrics, }, FilterType: jsii.String("filterType"), }, Frequency: jsii.String("frequency"), IsLocalTime: jsii.Boolean(false), QuietTime: &QuietTimeProperty{ End: jsii.String("end"), Start: jsii.String("start"), }, StartTime: jsii.String("startTime"), TimeZone: jsii.String("timeZone"), }, SizePercent: jsii.Number(123), TemplateConfiguration: &TemplateConfigurationProperty{ EmailTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, PushTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, SmsTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, VoiceTemplate: &TemplateProperty{ Name: jsii.String("name"), Version: jsii.String("version"), }, }, TreatmentDescription: jsii.String("treatmentDescription"), TreatmentName: jsii.String("treatmentName"), }
type CfnEmailChannel ¶
type CfnEmailChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the email channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // 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 SetConfigurationSet(val *string) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies whether to enable the email channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The verified email address that you want to send email from when you send email through the channel. FromAddress() *string SetFromAddress(val *string) // 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 SetIdentity(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES . OrchestrationSendingRoleArn() *string SetOrchestrationSendingRoleArn(val *string) // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // 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 SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEmailChannel := awscdk.Aws_pinpoint.NewCfnEmailChannel(this, jsii.String("MyCfnEmailChannel"), &CfnEmailChannelProps{ ApplicationId: jsii.String("applicationId"), FromAddress: jsii.String("fromAddress"), Identity: jsii.String("identity"), // the properties below are optional ConfigurationSet: jsii.String("configurationSet"), Enabled: jsii.Boolean(false), OrchestrationSendingRoleArn: jsii.String("orchestrationSendingRoleArn"), RoleArn: jsii.String("roleArn"), })
func NewCfnEmailChannel ¶
func NewCfnEmailChannel(scope constructs.Construct, id *string, props *CfnEmailChannelProps) CfnEmailChannel
type CfnEmailChannelProps ¶
type CfnEmailChannelProps struct { // The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The verified email address that you want to send email from when you send email through the channel. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-fromaddress // FromAddress *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-identity // Identity *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-configurationset // ConfigurationSet *string `field:"optional" json:"configurationSet" yaml:"configurationSet"` // Specifies whether to enable the email channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // The ARN of an IAM role for Amazon Pinpoint to use to send email from your campaigns or journeys through Amazon SES . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-orchestrationsendingrolearn // OrchestrationSendingRoleArn *string `field:"optional" json:"orchestrationSendingRoleArn" yaml:"orchestrationSendingRoleArn"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailchannel.html#cfn-pinpoint-emailchannel-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
Properties for defining a `CfnEmailChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEmailChannelProps := &CfnEmailChannelProps{ ApplicationId: jsii.String("applicationId"), FromAddress: jsii.String("fromAddress"), Identity: jsii.String("identity"), // the properties below are optional ConfigurationSet: jsii.String("configurationSet"), Enabled: jsii.Boolean(false), OrchestrationSendingRoleArn: jsii.String("orchestrationSendingRoleArn"), RoleArn: jsii.String("roleArn"), }
type CfnEmailTemplate ¶
type CfnEmailTemplate interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the message template. AttrArn() *string AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A JSON object that specifies the default values to use for message variables in the message template. DefaultSubstitutions() *string SetDefaultSubstitutions(val *string) // The message body, in HTML format, to use in email messages that are based on the message template. HtmlPart() *string SetHtmlPart(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The subject line, or title, to use in email messages that are based on the message template. Subject() *string SetSubject(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // A custom description of the message template. TemplateDescription() *string SetTemplateDescription(val *string) // The name of the message template. TemplateName() *string SetTemplateName(val *string) // The message body, in plain text format, to use in email messages that are based on the message template. TextPart() *string SetTextPart(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnEmailTemplate := awscdk.Aws_pinpoint.NewCfnEmailTemplate(this, jsii.String("MyCfnEmailTemplate"), &CfnEmailTemplateProps{ Subject: jsii.String("subject"), TemplateName: jsii.String("templateName"), // the properties below are optional DefaultSubstitutions: jsii.String("defaultSubstitutions"), HtmlPart: jsii.String("htmlPart"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), TextPart: jsii.String("textPart"), })
func NewCfnEmailTemplate ¶
func NewCfnEmailTemplate(scope constructs.Construct, id *string, props *CfnEmailTemplateProps) CfnEmailTemplate
type CfnEmailTemplateProps ¶
type CfnEmailTemplateProps struct { // The subject line, or title, to use in email messages that are based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-subject // Subject *string `field:"required" json:"subject" yaml:"subject"` // The name of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatename // TemplateName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-defaultsubstitutions // DefaultSubstitutions *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-htmlpart // HtmlPart *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // A custom description of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-templatedescription // TemplateDescription *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-emailtemplate.html#cfn-pinpoint-emailtemplate-textpart // TextPart *string `field:"optional" json:"textPart" yaml:"textPart"` }
Properties for defining a `CfnEmailTemplate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnEmailTemplateProps := &CfnEmailTemplateProps{ Subject: jsii.String("subject"), TemplateName: jsii.String("templateName"), // the properties below are optional DefaultSubstitutions: jsii.String("defaultSubstitutions"), HtmlPart: jsii.String("htmlPart"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), TextPart: jsii.String("textPart"), }
type CfnEventStream ¶
type CfnEventStream interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that you want to export data from. ApplicationId() *string SetApplicationId(val *string) AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon Data Firehose delivery stream that you want to publish event data to. DestinationStreamArn() *string SetDestinationStreamArn(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // 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 SetRoleArn(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a new event stream for an application or updates the settings of an existing event stream for an application.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEventStream := awscdk.Aws_pinpoint.NewCfnEventStream(this, jsii.String("MyCfnEventStream"), &CfnEventStreamProps{ ApplicationId: jsii.String("applicationId"), DestinationStreamArn: jsii.String("destinationStreamArn"), RoleArn: jsii.String("roleArn"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
func NewCfnEventStream ¶
func NewCfnEventStream(scope constructs.Construct, id *string, props *CfnEventStreamProps) CfnEventStream
type CfnEventStreamProps ¶
type CfnEventStreamProps struct { // The unique identifier for the Amazon Pinpoint application that you want to export data from. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The Amazon Resource Name (ARN) of the Amazon Kinesis Data Stream or Amazon 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 Firehose delivery stream, the ARN format is: `arn:aws:firehose: region : account-id :deliverystream/ stream_name`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-destinationstreamarn // DestinationStreamArn *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html#cfn-pinpoint-eventstream-rolearn // RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` }
Properties for defining a `CfnEventStream`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnEventStreamProps := &CfnEventStreamProps{ ApplicationId: jsii.String("applicationId"), DestinationStreamArn: jsii.String("destinationStreamArn"), RoleArn: jsii.String("roleArn"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-eventstream.html
type CfnGCMChannel ¶
type CfnGCMChannel interface { awscdk.CfnResource awscdk.IInspectable // The Web API key, also called the *server key* , that you received from Google to communicate with Google services. ApiKey() *string SetApiKey(val *string) // The unique identifier for the Amazon Pinpoint application that the GCM channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the GCM channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default authentication method used for GCM. DefaultAuthenticationMethod() *string SetDefaultAuthenticationMethod(val *string) // Specifies whether to enable the GCM channel for the Amazon Pinpoint application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. ServiceJson() *string SetServiceJson(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGCMChannel := awscdk.Aws_pinpoint.NewCfnGCMChannel(this, jsii.String("MyCfnGCMChannel"), &CfnGCMChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional ApiKey: jsii.String("apiKey"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), ServiceJson: jsii.String("serviceJson"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
func NewCfnGCMChannel ¶
func NewCfnGCMChannel(scope constructs.Construct, id *string, props *CfnGCMChannelProps) CfnGCMChannel
type CfnGCMChannelProps ¶
type CfnGCMChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the GCM channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The Web API key, also called the *server key* , that you received from Google to communicate with Google services. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-apikey // ApiKey *string `field:"optional" json:"apiKey" yaml:"apiKey"` // The default authentication method used for GCM. // // Values are either "TOKEN" or "KEY". Defaults to "KEY". // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-defaultauthenticationmethod // DefaultAuthenticationMethod *string `field:"optional" json:"defaultAuthenticationMethod" yaml:"defaultAuthenticationMethod"` // Specifies whether to enable the GCM channel for the Amazon Pinpoint application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` // The contents of the JSON file provided by Google during registration in order to generate an access token for authentication. // // For more information see [Migrate from legacy FCM APIs to HTTP v1](https://docs.aws.amazon.com/https://firebase.google.com/docs/cloud-messaging/migrate-v1) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html#cfn-pinpoint-gcmchannel-servicejson // ServiceJson *string `field:"optional" json:"serviceJson" yaml:"serviceJson"` }
Properties for defining a `CfnGCMChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnGCMChannelProps := &CfnGCMChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional ApiKey: jsii.String("apiKey"), DefaultAuthenticationMethod: jsii.String("defaultAuthenticationMethod"), Enabled: jsii.Boolean(false), ServiceJson: jsii.String("serviceJson"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-gcmchannel.html
type CfnInAppTemplate ¶
type CfnInAppTemplate interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the message template. AttrArn() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // 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{} SetContent(val interface{}) // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. CustomConfig() interface{} SetCustomConfig(val interface{}) // A string that determines the appearance of the in-app message. // // You can specify one of the following:. Layout() *string SetLayout(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // An optional description of the in-app template. TemplateDescription() *string SetTemplateDescription(val *string) // The name of the in-app message template. TemplateName() *string SetTemplateName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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. The In-App channel is unavailable in AWS GovCloud (US).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customConfig interface{} var tags interface{} cfnInAppTemplate := awscdk.Aws_pinpoint.NewCfnInAppTemplate(this, jsii.String("MyCfnInAppTemplate"), &CfnInAppTemplateProps{ TemplateName: jsii.String("templateName"), // the properties below are optional Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &BodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &HeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), })
func NewCfnInAppTemplate ¶
func NewCfnInAppTemplate(scope constructs.Construct, id *string, props *CfnInAppTemplateProps) CfnInAppTemplate
type CfnInAppTemplateProps ¶
type CfnInAppTemplateProps struct { // The name of the in-app message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-templatename // TemplateName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-content // Content interface{} `field:"optional" json:"content" yaml:"content"` // Custom data, in the form of key-value pairs, that is included in an in-app messaging payload. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-customconfig // CustomConfig interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-layout // Layout *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // An optional description of the in-app template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-inapptemplate.html#cfn-pinpoint-inapptemplate-templatedescription // TemplateDescription *string `field:"optional" json:"templateDescription" yaml:"templateDescription"` }
Properties for defining a `CfnInAppTemplate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var customConfig interface{} var tags interface{} cfnInAppTemplateProps := &CfnInAppTemplateProps{ TemplateName: jsii.String("templateName"), // the properties below are optional Content: []interface{}{ &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &BodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &HeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }, }, CustomConfig: customConfig, Layout: jsii.String("layout"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), }
type CfnInAppTemplate_BodyConfigProperty ¶
type CfnInAppTemplate_BodyConfigProperty struct { // The text alignment of the main body text of the message. // // Acceptable values: `LEFT` , `CENTER` , `RIGHT` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-alignment // Alignment *string `field:"optional" json:"alignment" yaml:"alignment"` // The main body text of the message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-body // Body *string `field:"optional" json:"body" yaml:"body"` // The color of the body text, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-bodyconfig.html#cfn-pinpoint-inapptemplate-bodyconfig-textcolor // TextColor *string `field:"optional" json:"textColor" yaml:"textColor"` }
Specifies the configuration of the main body text of the in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" bodyConfigProperty := &BodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-android // Android interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-defaultconfig // DefaultConfig interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-ios // Ios interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-buttonconfig.html#cfn-pinpoint-inapptemplate-buttonconfig-web // Web interface{} `field:"optional" json:"web" yaml:"web"` }
Specifies the behavior of buttons that appear in an in-app message template.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" buttonConfigProperty := &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }
type CfnInAppTemplate_DefaultButtonConfigurationProperty ¶
type CfnInAppTemplate_DefaultButtonConfigurationProperty struct { // The background color of a button, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-backgroundcolor // BackgroundColor *string `field:"optional" json:"backgroundColor" yaml:"backgroundColor"` // The border radius of a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-borderradius // BorderRadius *float64 `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-buttonaction // ButtonAction *string `field:"optional" json:"buttonAction" yaml:"buttonAction"` // The destination (such as a URL) for a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-link // Link *string `field:"optional" json:"link" yaml:"link"` // The text that appears on a button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-text // Text *string `field:"optional" json:"text" yaml:"text"` // The color of the body text in a button, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-defaultbuttonconfiguration.html#cfn-pinpoint-inapptemplate-defaultbuttonconfiguration-textcolor // TextColor *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultButtonConfigurationProperty := &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }
type CfnInAppTemplate_HeaderConfigProperty ¶
type CfnInAppTemplate_HeaderConfigProperty struct { // The text alignment of the title of the message. // // Acceptable values: `LEFT` , `CENTER` , `RIGHT` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-alignment // Alignment *string `field:"optional" json:"alignment" yaml:"alignment"` // The title text of the in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-header // Header *string `field:"optional" json:"header" yaml:"header"` // The color of the title text, expressed as a hex color code (such as #000000 for black). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-headerconfig.html#cfn-pinpoint-inapptemplate-headerconfig-textcolor // TextColor *string `field:"optional" json:"textColor" yaml:"textColor"` }
Specifies the configuration and content of the header or title text of the in-app message.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" headerConfigProperty := &HeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }
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). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-backgroundcolor // BackgroundColor *string `field:"optional" json:"backgroundColor" yaml:"backgroundColor"` // An object that contains configuration information about the header or title text of the in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-bodyconfig // BodyConfig interface{} `field:"optional" json:"bodyConfig" yaml:"bodyConfig"` // An object that contains configuration information about the header or title text of the in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-headerconfig // HeaderConfig interface{} `field:"optional" json:"headerConfig" yaml:"headerConfig"` // The URL of the image that appears on an in-app message banner. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-imageurl // ImageUrl *string `field:"optional" json:"imageUrl" yaml:"imageUrl"` // An object that contains configuration information about the primary button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-primarybtn // PrimaryBtn interface{} `field:"optional" json:"primaryBtn" yaml:"primaryBtn"` // An object that contains configuration information about the secondary button in an in-app message. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-inappmessagecontent.html#cfn-pinpoint-inapptemplate-inappmessagecontent-secondarybtn // SecondaryBtn interface{} `field:"optional" json:"secondaryBtn" yaml:"secondaryBtn"` }
Specifies the configuration of an in-app message, including its header, body, buttons, colors, and images.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" inAppMessageContentProperty := &InAppMessageContentProperty{ BackgroundColor: jsii.String("backgroundColor"), BodyConfig: &BodyConfigProperty{ Alignment: jsii.String("alignment"), Body: jsii.String("body"), TextColor: jsii.String("textColor"), }, HeaderConfig: &HeaderConfigProperty{ Alignment: jsii.String("alignment"), Header: jsii.String("header"), TextColor: jsii.String("textColor"), }, ImageUrl: jsii.String("imageUrl"), PrimaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, SecondaryBtn: &ButtonConfigProperty{ Android: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, DefaultConfig: &DefaultButtonConfigurationProperty{ BackgroundColor: jsii.String("backgroundColor"), BorderRadius: jsii.Number(123), ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), Text: jsii.String("text"), TextColor: jsii.String("textColor"), }, Ios: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, Web: &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }, }, }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-buttonaction // ButtonAction *string `field:"optional" json:"buttonAction" yaml:"buttonAction"` // The destination (such as a URL) for a button. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-inapptemplate-overridebuttonconfiguration.html#cfn-pinpoint-inapptemplate-overridebuttonconfiguration-link // Link *string `field:"optional" json:"link" yaml:"link"` }
Specifies the configuration of a button with settings that are specific to a certain device type.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" overrideButtonConfigurationProperty := &OverrideButtonConfigurationProperty{ ButtonAction: jsii.String("buttonAction"), Link: jsii.String("link"), }
type CfnPushTemplate ¶
type CfnPushTemplate interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The message template to use for the ADM (Amazon Device Messaging) channel. Adm() interface{} SetAdm(val interface{}) // The message template to use for the APNs (Apple Push Notification service) channel. Apns() interface{} SetApns(val interface{}) // The Amazon Resource Name (ARN) of the message template. AttrArn() *string AttrId() *string // The message template to use for the Baidu (Baidu Cloud Push) channel. Baidu() interface{} SetBaidu(val interface{}) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The default message template to use for push notification channels. Default() interface{} SetDefault(val interface{}) // A JSON object that specifies the default values to use for message variables in the message template. DefaultSubstitutions() *string SetDefaultSubstitutions(val *string) // 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. Gcm() interface{} SetGcm(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // A custom description of the message template. TemplateDescription() *string SetTemplateDescription(val *string) // The name of the message template to use for the message. TemplateName() *string SetTemplateName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnPushTemplate := awscdk.Aws_pinpoint.NewCfnPushTemplate(this, jsii.String("MyCfnPushTemplate"), &CfnPushTemplateProps{ TemplateName: jsii.String("templateName"), // the properties below are optional Adm: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Apns: &APNSPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), MediaUrl: jsii.String("mediaUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Baidu: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Default: &DefaultPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, DefaultSubstitutions: jsii.String("defaultSubstitutions"), Gcm: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Tags: tags, TemplateDescription: jsii.String("templateDescription"), })
func NewCfnPushTemplate ¶
func NewCfnPushTemplate(scope constructs.Construct, id *string, props *CfnPushTemplateProps) CfnPushTemplate
type CfnPushTemplateProps ¶
type CfnPushTemplateProps struct { // The name of the message template to use for the message. // // If specified, this value must match the name of an existing message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatename // TemplateName *string `field:"required" 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` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-adm // Adm interface{} `field:"optional" 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` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-apns // Apns interface{} `field:"optional" 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` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-baidu // Baidu interface{} `field:"optional" json:"baidu" yaml:"baidu"` // The default message template to use for push notification channels. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-default // Default interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-defaultsubstitutions // DefaultSubstitutions *string `field:"optional" 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` ). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-gcm // Gcm interface{} `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // A custom description of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-pushtemplate.html#cfn-pinpoint-pushtemplate-templatedescription // TemplateDescription *string `field:"optional" json:"templateDescription" yaml:"templateDescription"` }
Properties for defining a `CfnPushTemplate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnPushTemplateProps := &CfnPushTemplateProps{ TemplateName: jsii.String("templateName"), // the properties below are optional Adm: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Apns: &APNSPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), MediaUrl: jsii.String("mediaUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Baidu: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Default: &DefaultPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, DefaultSubstitutions: jsii.String("defaultSubstitutions"), Gcm: &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }, Tags: tags, TemplateDescription: jsii.String("templateDescription"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-action // Action *string `field:"optional" json:"action" yaml:"action"` // The message body to use in push notifications that are based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-body // Body *string `field:"optional" json:"body" yaml:"body"` // The URL of an image or video to display in push notifications that are based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-mediaurl // MediaUrl *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-sound // Sound *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-title // Title *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-apnspushnotificationtemplate.html#cfn-pinpoint-pushtemplate-apnspushnotificationtemplate-url // Url *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" aPNSPushNotificationTemplateProperty := &APNSPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), MediaUrl: jsii.String("mediaUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-action // Action *string `field:"optional" json:"action" yaml:"action"` // The message body to use in a push notification that's based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-body // Body *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageiconurl // ImageIconUrl *string `field:"optional" json:"imageIconUrl" yaml:"imageIconUrl"` // The URL of an image to display in a push notification that's based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-imageurl // ImageUrl *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-smallimageiconurl // SmallImageIconUrl *string `field:"optional" 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/` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-sound // Sound *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-title // Title *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-androidpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-androidpushnotificationtemplate-url // Url *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" androidPushNotificationTemplateProperty := &AndroidPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), ImageIconUrl: jsii.String("imageIconUrl"), ImageUrl: jsii.String("imageUrl"), SmallImageIconUrl: jsii.String("smallImageIconUrl"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-action // Action *string `field:"optional" json:"action" yaml:"action"` // The message body to use in push notifications that are based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-body // Body *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-sound // Sound *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-title // Title *string `field:"optional" 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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-pushtemplate-defaultpushnotificationtemplate.html#cfn-pinpoint-pushtemplate-defaultpushnotificationtemplate-url // Url *string `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" defaultPushNotificationTemplateProperty := &DefaultPushNotificationTemplateProperty{ Action: jsii.String("action"), Body: jsii.String("body"), Sound: jsii.String("sound"), Title: jsii.String("title"), Url: jsii.String("url"), }
type CfnSMSChannel ¶
type CfnSMSChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the SMS channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the SMS channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies whether to enable the SMS channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The identity that you want to display on recipients' devices when they receive messages from the SMS channel. SenderId() *string SetSenderId(val *string) // The registered short code that you want to use when you send messages through the SMS channel. ShortCode() *string SetShortCode(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSMSChannel := awscdk.Aws_pinpoint.NewCfnSMSChannel(this, jsii.String("MyCfnSMSChannel"), &CfnSMSChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional Enabled: jsii.Boolean(false), SenderId: jsii.String("senderId"), ShortCode: jsii.String("shortCode"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html
func NewCfnSMSChannel ¶
func NewCfnSMSChannel(scope constructs.Construct, id *string, props *CfnSMSChannelProps) CfnSMSChannel
type CfnSMSChannelProps ¶
type CfnSMSChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the SMS channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // Specifies whether to enable the SMS channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-enabled // Enabled interface{} `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-senderid // SenderId *string `field:"optional" 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* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html#cfn-pinpoint-smschannel-shortcode // ShortCode *string `field:"optional" json:"shortCode" yaml:"shortCode"` }
Properties for defining a `CfnSMSChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnSMSChannelProps := &CfnSMSChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional Enabled: jsii.Boolean(false), SenderId: jsii.String("senderId"), ShortCode: jsii.String("shortCode"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smschannel.html
type CfnSegment ¶
type CfnSegment interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The unique identifier for the Amazon Pinpoint application that the segment is associated with. ApplicationId() *string SetApplicationId(val *string) // The Amazon Resource Name (ARN) of the segment. AttrArn() *string // The unique identifier for the segment. AttrSegmentId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // An array that defines the dimensions for the segment. Dimensions() interface{} SetDimensions(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The name of the segment. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. SegmentGroups() interface{} SetSegmentGroups(val interface{}) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Updates the configuration, dimension, and other settings for an existing segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} var tags interface{} var userAttributes interface{} cfnSegment := awscdk.Aws_pinpoint.NewCfnSegment(this, jsii.String("MyCfnSegment"), &CfnSegmentProps{ ApplicationId: jsii.String("applicationId"), Name: jsii.String("name"), // the properties below are optional Dimensions: &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, SegmentGroups: &SegmentGroupsProperty{ Groups: []interface{}{ &GroupsProperty{ Dimensions: []interface{}{ &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, }, SourceSegments: []interface{}{ &SourceSegmentsProperty{ Id: jsii.String("id"), // the properties below are optional Version: jsii.Number(123), }, }, SourceType: jsii.String("sourceType"), Type: jsii.String("type"), }, }, Include: jsii.String("include"), }, Tags: tags, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
func NewCfnSegment ¶
func NewCfnSegment(scope constructs.Construct, id *string, props *CfnSegmentProps) CfnSegment
type CfnSegmentProps ¶
type CfnSegmentProps struct { // The unique identifier for the Amazon Pinpoint application that the segment is associated with. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // The name of the segment. // // > A segment must have a name otherwise it will not appear in the Amazon Pinpoint console. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-name // Name *string `field:"required" json:"name" yaml:"name"` // An array that defines the dimensions for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-dimensions // Dimensions interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-segmentgroups // SegmentGroups interface{} `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html#cfn-pinpoint-segment-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnSegment`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} var tags interface{} var userAttributes interface{} cfnSegmentProps := &CfnSegmentProps{ ApplicationId: jsii.String("applicationId"), Name: jsii.String("name"), // the properties below are optional Dimensions: &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, SegmentGroups: &SegmentGroupsProperty{ Groups: []interface{}{ &GroupsProperty{ Dimensions: []interface{}{ &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, }, SourceSegments: []interface{}{ &SourceSegmentsProperty{ Id: jsii.String("id"), // the properties below are optional Version: jsii.Number(123), }, }, SourceType: jsii.String("sourceType"), Type: jsii.String("type"), }, }, Include: jsii.String("include"), }, Tags: tags, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
type CfnSegment_AttributeDimensionProperty ¶
type CfnSegment_AttributeDimensionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-attributetype // AttributeType *string `field:"optional" json:"attributeType" yaml:"attributeType"` // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-attributedimension.html#cfn-pinpoint-segment-attributedimension-values // Values *[]*string `field:"optional" json:"values" yaml:"values"` }
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" attributeDimensionProperty := &AttributeDimensionProperty{ AttributeType: jsii.String("attributeType"), Values: []*string{ jsii.String("values"), }, }
type CfnSegment_BehaviorProperty ¶
type CfnSegment_BehaviorProperty struct { // Specifies how recently segment members were active. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-behavior.html#cfn-pinpoint-segment-behavior-recency // Recency interface{} `field:"optional" json:"recency" yaml:"recency"` }
Specifies behavior-based criteria for the segment, such as how recently users have used your app.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" behaviorProperty := &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }
type CfnSegment_CoordinatesProperty ¶
type CfnSegment_CoordinatesProperty struct { // The latitude coordinate of the location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-latitude // Latitude *float64 `field:"required" json:"latitude" yaml:"latitude"` // The longitude coordinate of the location. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-coordinates.html#cfn-pinpoint-segment-coordinates-longitude // Longitude *float64 `field:"required" json:"longitude" yaml:"longitude"` }
Specifies the GPS coordinates of a location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" coordinatesProperty := &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }
type CfnSegment_DemographicProperty ¶
type CfnSegment_DemographicProperty struct { // The app version criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-appversion // AppVersion interface{} `field:"optional" json:"appVersion" yaml:"appVersion"` // The channel criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-channel // Channel interface{} `field:"optional" json:"channel" yaml:"channel"` // The device type criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-devicetype // DeviceType interface{} `field:"optional" json:"deviceType" yaml:"deviceType"` // The device make criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-make // Make interface{} `field:"optional" json:"make" yaml:"make"` // The device model criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-model // Model interface{} `field:"optional" json:"model" yaml:"model"` // The device platform criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-demographic.html#cfn-pinpoint-segment-demographic-platform // Platform interface{} `field:"optional" json:"platform" yaml:"platform"` }
Specifies demographic-based criteria, such as device platform, for the segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" demographicProperty := &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }
type CfnSegment_GPSPointProperty ¶
type CfnSegment_GPSPointProperty struct { // The GPS coordinates to measure distance from. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-coordinates // Coordinates interface{} `field:"required" json:"coordinates" yaml:"coordinates"` // The range, in kilometers, from the GPS coordinates. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-gpspoint.html#cfn-pinpoint-segment-gpspoint-rangeinkilometers // RangeInKilometers *float64 `field:"required" json:"rangeInKilometers" yaml:"rangeInKilometers"` }
Specifies the GPS coordinates of the endpoint location.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" gPSPointProperty := &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }
type CfnSegment_GroupsProperty ¶
type CfnSegment_GroupsProperty struct { // An array that defines the dimensions to include or exclude from the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-dimensions // Dimensions interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcesegments // SourceSegments interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-sourcetype // SourceType *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-groups.html#cfn-pinpoint-segment-groups-type // Type *string `field:"optional" json:"type" yaml:"type"` }
An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} var userAttributes interface{} groupsProperty := &GroupsProperty{ Dimensions: []interface{}{ &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, }, SourceSegments: []interface{}{ &SourceSegmentsProperty{ Id: jsii.String("id"), // the properties below are optional Version: jsii.Number(123), }, }, SourceType: jsii.String("sourceType"), Type: jsii.String("type"), }
type CfnSegment_LocationProperty ¶
type CfnSegment_LocationProperty struct { // The country or region code, in ISO 3166-1 alpha-2 format, for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-country // Country interface{} `field:"optional" json:"country" yaml:"country"` // The GPS point dimension for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-location.html#cfn-pinpoint-segment-location-gpspoint // GpsPoint interface{} `field:"optional" json:"gpsPoint" yaml:"gpsPoint"` }
Specifies location-based criteria, such as region or GPS coordinates, for the segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" locationProperty := &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }
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` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-duration // Duration *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-recency.html#cfn-pinpoint-segment-recency-recencytype // RecencyType *string `field:"required" json:"recencyType" yaml:"recencyType"` }
Specifies how recently segment members were active.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" recencyProperty := &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }
type CfnSegment_SegmentDimensionsProperty ¶
type CfnSegment_SegmentDimensionsProperty struct { // One or more custom attributes to use as criteria for the segment. // // For more information see [AttributeDimension](https://docs.aws.amazon.com/pinpoint/latest/apireference/apps-application-id-segments.html#apps-application-id-segments-model-attributedimension) // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-attributes // Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"` // The behavior-based criteria, such as how recently users have used your app, for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-behavior // Behavior interface{} `field:"optional" json:"behavior" yaml:"behavior"` // The demographic-based criteria, such as device platform, for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-demographic // Demographic interface{} `field:"optional" json:"demographic" yaml:"demographic"` // The location-based criteria, such as region or GPS coordinates, for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-location // Location interface{} `field:"optional" json:"location" yaml:"location"` // One or more custom metrics to use as criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-metrics // Metrics interface{} `field:"optional" json:"metrics" yaml:"metrics"` // One or more custom user attributes to use as criteria for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentdimensions.html#cfn-pinpoint-segment-segmentdimensions-userattributes // UserAttributes interface{} `field:"optional" json:"userAttributes" yaml:"userAttributes"` }
Specifies the dimension settings for a segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} var userAttributes interface{} segmentDimensionsProperty := &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }
type CfnSegment_SegmentGroupsProperty ¶
type CfnSegment_SegmentGroupsProperty struct { // Specifies the set of segment criteria to evaluate when handling segment groups for the segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-groups // Groups interface{} `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-segmentgroups.html#cfn-pinpoint-segment-segmentgroups-include // Include *string `field:"optional" json:"include" yaml:"include"` }
Specifies the set of segment criteria to evaluate when handling segment groups for the segment.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var attributes interface{} var metrics interface{} var userAttributes interface{} segmentGroupsProperty := &SegmentGroupsProperty{ Groups: []interface{}{ &GroupsProperty{ Dimensions: []interface{}{ &SegmentDimensionsProperty{ Attributes: attributes, Behavior: &BehaviorProperty{ Recency: &RecencyProperty{ Duration: jsii.String("duration"), RecencyType: jsii.String("recencyType"), }, }, Demographic: &DemographicProperty{ AppVersion: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Channel: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, DeviceType: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Make: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Model: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, Platform: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, }, Location: &LocationProperty{ Country: &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }, GpsPoint: &GPSPointProperty{ Coordinates: &CoordinatesProperty{ Latitude: jsii.Number(123), Longitude: jsii.Number(123), }, RangeInKilometers: jsii.Number(123), }, }, Metrics: metrics, UserAttributes: userAttributes, }, }, SourceSegments: []interface{}{ &SourceSegmentsProperty{ Id: jsii.String("id"), // the properties below are optional Version: jsii.Number(123), }, }, SourceType: jsii.String("sourceType"), Type: jsii.String("type"), }, }, Include: jsii.String("include"), }
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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-dimensiontype // DimensionType *string `field:"optional" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-values // Values *[]*string `field:"optional" json:"values" yaml:"values"` }
Specifies the dimension type and values for a segment dimension.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" setDimensionProperty := &SetDimensionProperty{ DimensionType: jsii.String("dimensionType"), Values: []*string{ jsii.String("values"), }, }
type CfnSegment_SourceSegmentsProperty ¶
type CfnSegment_SourceSegmentsProperty struct { // The unique identifier for the source segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-id // Id *string `field:"required" json:"id" yaml:"id"` // The version number of the source segment. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-sourcesegments.html#cfn-pinpoint-segment-sourcesegments-version // Version *float64 `field:"optional" 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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" sourceSegmentsProperty := &SourceSegmentsProperty{ Id: jsii.String("id"), // the properties below are optional Version: jsii.Number(123), }
type CfnSmsTemplate ¶
type CfnSmsTemplate interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the message template. AttrArn() *string AttrId() *string // The message body to use in text messages that are based on the message template. Body() *string SetBody(val *string) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A JSON object that specifies the default values to use for message variables in the message template. DefaultSubstitutions() *string SetDefaultSubstitutions(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() interface{} SetTagsRaw(val interface{}) // A custom description of the message template. TemplateDescription() *string SetTemplateDescription(val *string) // The name of the message template to use for the message. TemplateName() *string SetTemplateName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnSmsTemplate := awscdk.Aws_pinpoint.NewCfnSmsTemplate(this, jsii.String("MyCfnSmsTemplate"), &CfnSmsTemplateProps{ Body: jsii.String("body"), TemplateName: jsii.String("templateName"), // the properties below are optional DefaultSubstitutions: jsii.String("defaultSubstitutions"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html
func NewCfnSmsTemplate ¶
func NewCfnSmsTemplate(scope constructs.Construct, id *string, props *CfnSmsTemplateProps) CfnSmsTemplate
type CfnSmsTemplateProps ¶
type CfnSmsTemplateProps struct { // The message body to use in text messages that are based on the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-body // Body *string `field:"required" json:"body" yaml:"body"` // The name of the message template to use for the message. // // If specified, this value must match the name of an existing message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatename // TemplateName *string `field:"required" 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-defaultsubstitutions // DefaultSubstitutions *string `field:"optional" 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) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-tags // Tags interface{} `field:"optional" json:"tags" yaml:"tags"` // A custom description of the message template. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html#cfn-pinpoint-smstemplate-templatedescription // TemplateDescription *string `field:"optional" json:"templateDescription" yaml:"templateDescription"` }
Properties for defining a `CfnSmsTemplate`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" var tags interface{} cfnSmsTemplateProps := &CfnSmsTemplateProps{ Body: jsii.String("body"), TemplateName: jsii.String("templateName"), // the properties below are optional DefaultSubstitutions: jsii.String("defaultSubstitutions"), Tags: tags, TemplateDescription: jsii.String("templateDescription"), }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-smstemplate.html
type CfnVoiceChannel ¶
type CfnVoiceChannel interface { awscdk.CfnResource awscdk.IInspectable // The unique identifier for the Amazon Pinpoint application that the voice channel applies to. ApplicationId() *string SetApplicationId(val *string) // (Deprecated) An identifier for the voice channel. // // This property is retained only for backward compatibility. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // Specifies whether to enable the voice channel for the application. Enabled() interface{} SetEnabled(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVoiceChannel := awscdk.Aws_pinpoint.NewCfnVoiceChannel(this, jsii.String("MyCfnVoiceChannel"), &CfnVoiceChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional Enabled: jsii.Boolean(false), })
func NewCfnVoiceChannel ¶
func NewCfnVoiceChannel(scope constructs.Construct, id *string, props *CfnVoiceChannelProps) CfnVoiceChannel
type CfnVoiceChannelProps ¶
type CfnVoiceChannelProps struct { // The unique identifier for the Amazon Pinpoint application that the voice channel applies to. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-applicationid // ApplicationId *string `field:"required" json:"applicationId" yaml:"applicationId"` // Specifies whether to enable the voice channel for the application. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-voicechannel.html#cfn-pinpoint-voicechannel-enabled // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Properties for defining a `CfnVoiceChannel`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnVoiceChannelProps := &CfnVoiceChannelProps{ ApplicationId: jsii.String("applicationId"), // the properties below are optional Enabled: jsii.Boolean(false), }
Source Files ¶
- CfnADMChannel.go
- CfnADMChannelProps.go
- CfnADMChannel__checks.go
- CfnAPNSChannel.go
- CfnAPNSChannelProps.go
- CfnAPNSChannel__checks.go
- CfnAPNSSandboxChannel.go
- CfnAPNSSandboxChannelProps.go
- CfnAPNSSandboxChannel__checks.go
- CfnAPNSVoipChannel.go
- CfnAPNSVoipChannelProps.go
- CfnAPNSVoipChannel__checks.go
- CfnAPNSVoipSandboxChannel.go
- CfnAPNSVoipSandboxChannelProps.go
- CfnAPNSVoipSandboxChannel__checks.go
- CfnApp.go
- CfnAppProps.go
- CfnApp__checks.go
- CfnApplicationSettings.go
- CfnApplicationSettingsProps.go
- CfnApplicationSettings_CampaignHookProperty.go
- CfnApplicationSettings_LimitsProperty.go
- CfnApplicationSettings_QuietTimeProperty.go
- CfnApplicationSettings__checks.go
- CfnBaiduChannel.go
- CfnBaiduChannelProps.go
- CfnBaiduChannel__checks.go
- CfnCampaign.go
- CfnCampaignProps.go
- CfnCampaign_AttributeDimensionProperty.go
- CfnCampaign_CampaignCustomMessageProperty.go
- CfnCampaign_CampaignEmailMessageProperty.go
- CfnCampaign_CampaignEventFilterProperty.go
- CfnCampaign_CampaignHookProperty.go
- CfnCampaign_CampaignInAppMessageProperty.go
- CfnCampaign_CampaignSmsMessageProperty.go
- CfnCampaign_CustomDeliveryConfigurationProperty.go
- CfnCampaign_DefaultButtonConfigurationProperty.go
- CfnCampaign_EventDimensionsProperty.go
- CfnCampaign_InAppMessageBodyConfigProperty.go
- CfnCampaign_InAppMessageButtonProperty.go
- CfnCampaign_InAppMessageContentProperty.go
- CfnCampaign_InAppMessageHeaderConfigProperty.go
- CfnCampaign_LimitsProperty.go
- CfnCampaign_MessageConfigurationProperty.go
- CfnCampaign_MessageProperty.go
- CfnCampaign_MetricDimensionProperty.go
- CfnCampaign_OverrideButtonConfigurationProperty.go
- CfnCampaign_QuietTimeProperty.go
- CfnCampaign_ScheduleProperty.go
- CfnCampaign_SetDimensionProperty.go
- CfnCampaign_TemplateConfigurationProperty.go
- CfnCampaign_TemplateProperty.go
- CfnCampaign_WriteTreatmentResourceProperty.go
- CfnCampaign__checks.go
- CfnEmailChannel.go
- CfnEmailChannelProps.go
- CfnEmailChannel__checks.go
- CfnEmailTemplate.go
- CfnEmailTemplateProps.go
- CfnEmailTemplate__checks.go
- CfnEventStream.go
- CfnEventStreamProps.go
- CfnEventStream__checks.go
- CfnGCMChannel.go
- CfnGCMChannelProps.go
- CfnGCMChannel__checks.go
- CfnInAppTemplate.go
- CfnInAppTemplateProps.go
- CfnInAppTemplate_BodyConfigProperty.go
- CfnInAppTemplate_ButtonConfigProperty.go
- CfnInAppTemplate_DefaultButtonConfigurationProperty.go
- CfnInAppTemplate_HeaderConfigProperty.go
- CfnInAppTemplate_InAppMessageContentProperty.go
- CfnInAppTemplate_OverrideButtonConfigurationProperty.go
- CfnInAppTemplate__checks.go
- CfnPushTemplate.go
- CfnPushTemplateProps.go
- CfnPushTemplate_APNSPushNotificationTemplateProperty.go
- CfnPushTemplate_AndroidPushNotificationTemplateProperty.go
- CfnPushTemplate_DefaultPushNotificationTemplateProperty.go
- CfnPushTemplate__checks.go
- CfnSMSChannel.go
- CfnSMSChannelProps.go
- CfnSMSChannel__checks.go
- CfnSegment.go
- CfnSegmentProps.go
- CfnSegment_AttributeDimensionProperty.go
- CfnSegment_BehaviorProperty.go
- CfnSegment_CoordinatesProperty.go
- CfnSegment_DemographicProperty.go
- CfnSegment_GPSPointProperty.go
- CfnSegment_GroupsProperty.go
- CfnSegment_LocationProperty.go
- CfnSegment_RecencyProperty.go
- CfnSegment_SegmentDimensionsProperty.go
- CfnSegment_SegmentGroupsProperty.go
- CfnSegment_SetDimensionProperty.go
- CfnSegment_SourceSegmentsProperty.go
- CfnSegment__checks.go
- CfnSmsTemplate.go
- CfnSmsTemplateProps.go
- CfnSmsTemplate__checks.go
- CfnVoiceChannel.go
- CfnVoiceChannelProps.go
- CfnVoiceChannel__checks.go
- main.go