aws-cdk-lib.aws_pinpoint.CfnCampaign.DefaultButtonConfigurationProperty

interface DefaultButtonConfigurationProperty

LanguageType name
.NETAmazon.CDK.AWS.Pinpoint.CfnCampaign.DefaultButtonConfigurationProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awspinpoint#CfnCampaign_DefaultButtonConfigurationProperty
Javasoftware.amazon.awscdk.services.pinpoint.CfnCampaign.DefaultButtonConfigurationProperty
Pythonaws_cdk.aws_pinpoint.CfnCampaign.DefaultButtonConfigurationProperty
TypeScript aws-cdk-lib » aws_pinpoint » CfnCampaign » DefaultButtonConfigurationProperty

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 { aws_pinpoint as pinpoint } from 'aws-cdk-lib';
const defaultButtonConfigurationProperty: pinpoint.CfnCampaign.DefaultButtonConfigurationProperty = {
  backgroundColor: 'backgroundColor',
  borderRadius: 123,
  buttonAction: 'buttonAction',
  link: 'link',
  text: 'text',
  textColor: 'textColor',
};

Properties

NameTypeDescription
backgroundColor?stringThe background color of a button, expressed as a hex color code (such as #000000 for black).
borderRadius?numberThe border radius of a button.
buttonAction?stringThe action that occurs when a recipient chooses a button in an in-app message.
link?stringThe destination (such as a URL) for a button.
text?stringThe text that appears on a button in an in-app message.
textColor?stringThe color of the body text in a button, expressed as a hex color code (such as #000000 for black).

backgroundColor?

Type: string (optional)

The background color of a button, expressed as a hex color code (such as #000000 for black).


borderRadius?

Type: number (optional)

The border radius of a button.


buttonAction?

Type: string (optional)

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.

link?

Type: string (optional)

The destination (such as a URL) for a button.


text?

Type: string (optional)

The text that appears on a button in an in-app message.


textColor?

Type: string (optional)

The color of the body text in a button, expressed as a hex color code (such as #000000 for black).