Package software.amazon.awscdk.services.pinpoint

Class CfnApp

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.CfnApp
All Implemented Interfaces:
IInspectable, ITaggable, IAppRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:43.146Z") @Stability(Stable) public class CfnApp extends CfnResource implements IInspectable, IAppRef, ITaggable
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: 

 import software.amazon.awscdk.services.pinpoint.*;
 UserPool userPool;
 CfnApp pinpointApp;
 Role pinpointRole;
 UserPoolClient.Builder.create(this, "Client")
         .userPool(userPool)
         .analytics(AnalyticsConfiguration.builder()
                 // Your Pinpoint project
                 .application(pinpointApp)
                 // Whether to include user data in analytics events
                 .shareUserData(true)
                 .build())
         .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

    • CfnApp

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

    • CfnApp

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

    • CfnApp

      @Stability(Stable) public CfnApp(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAppProps 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

    • fromAppArn

      @Stability(Stable) @NotNull public static IAppRef fromAppArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IAppRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromAppId

      @Stability(Stable) @NotNull public static IAppRef fromAppId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String appId)
      Creates a new IAppRef from a appId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      appId - This parameter is required.

    • 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.

    • getAppRef

      @Stability(Stable) @NotNull public AppReference getAppRef()
      A reference to a App resource.
      Specified by:
      getAppRef in interface IAppRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the application.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The unique identifier for the application.

      This identifier is displayed as the Project ID on the Amazon Pinpoint console.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The display name of the application.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The display name of the application.

    • getTagsRaw

      @Stability(Stable) @Nullable public Object getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Object value)
      An array of key-value pairs to apply to this resource.