Package software.amazon.awscdk.services.pinpoint

Class CfnEmailChannel

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.pinpoint.CfnEmailChannel
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:20.566Z") @Stability(Stable) public class CfnEmailChannel extends CfnResource implements IInspectable
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 software.amazon.awscdk.services.pinpoint.*;
 CfnEmailChannel cfnEmailChannel = CfnEmailChannel.Builder.create(this, "MyCfnEmailChannel")
         .applicationId("applicationId")
         .fromAddress("fromAddress")
         .identity("identity")
         // the properties below are optional
         .configurationSet("configurationSet")
         .enabled(false)
         .orchestrationSendingRoleArn("orchestrationSendingRoleArn")
         .roleArn("roleArn")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEmailChannel

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

    • CfnEmailChannel

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

    • CfnEmailChannel

      @Stability(Stable) public CfnEmailChannel(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEmailChannelProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      (Deprecated) An identifier for the email channel.

      This property is retained only for backward compatibility.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApplicationId

      @Stability(Stable) @NotNull public String getApplicationId()
      The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.

    • setApplicationId

      @Stability(Stable) public void setApplicationId(@NotNull String value)
      The unique identifier for the Amazon Pinpoint application that you're specifying the email channel for.

    • getFromAddress

      @Stability(Stable) @NotNull public String getFromAddress()
      The verified email address that you want to send email from when you send email through the channel.

    • setFromAddress

      @Stability(Stable) public void setFromAddress(@NotNull String value)
      The verified email address that you want to send email from when you send email through the channel.

    • getIdentity

      @Stability(Stable) @NotNull public String getIdentity()
      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.

    • setIdentity

      @Stability(Stable) public void setIdentity(@NotNull String value)
      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.

    • getConfigurationSet

      @Stability(Stable) @Nullable public String getConfigurationSet()
      The Amazon SES configuration set that you want to apply to messages that you send through the channel.

    • setConfigurationSet

      @Stability(Stable) public void setConfigurationSet(@Nullable String value)
      The Amazon SES configuration set that you want to apply to messages that you send through the channel.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      Specifies whether to enable the email channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Specifies whether to enable the email channel for the application.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Specifies whether to enable the email channel for the application.

    • getOrchestrationSendingRoleArn

      @Stability(Stable) @Nullable public String getOrchestrationSendingRoleArn()

    • setOrchestrationSendingRoleArn

      @Stability(Stable) public void setOrchestrationSendingRoleArn(@Nullable String value)

    • getRoleArn

      @Stability(Stable) @Nullable public String getRoleArn()
      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.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@Nullable String value)
      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.