Class CfnApp

An app is an Amazon Pinpoint application, also referred to as a project .

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnApp

Implements

IInspectable

IAppRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnApp : CfnResource, IInspectable, IAppRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnApp Inherits CfnResource Implements IInspectable, IAppRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Pinpoint;

             UserPool userPool;
             CfnApp pinpointApp;
             Role pinpointRole;


             new UserPoolClient(this, "Client", new UserPoolClientProps {
                 UserPool = userPool,
                 Analytics = new AnalyticsConfiguration {
                     // Your Pinpoint project
                     Application = pinpointApp,

                     // Whether to include user data in analytics events
                     ShareUserData = true
                 }
             });

Synopsis

Constructors

CfnApp(Construct, string, ICfnAppProps)

Create a new AWS::Pinpoint::App.

Properties

AppRef	A reference to a App resource.
AttrArn	The Amazon Resource Name (ARN) of the application.
AttrId	The unique identifier for the application.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	An app is an Amazon Pinpoint application, also referred to as a project .
CfnPropertyNames	An app is an Amazon Pinpoint application, also referred to as a project .
Name	The display name of the application.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.

Methods

ArnForApp(IAppRef)	An app is an Amazon Pinpoint application, also referred to as a project .
FromAppArn(Construct, string, string)	Creates a new IAppRef from an ARN.
FromAppId(Construct, string, string)	Creates a new IAppRef from a appId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnApp(object)	Checks whether the given object is a CfnApp.
RenderProperties(IDictionary<string, object>)	An app is an Amazon Pinpoint application, also referred to as a project .

Constructors

CfnApp(Construct, string, ICfnAppProps)

Create a new AWS::Pinpoint::App.

public CfnApp(Construct scope, string id, ICfnAppProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnAppProps

Resource properties.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Properties

AppRef

A reference to a App resource.

public virtual IAppReference AppRef { get; }

Property Value

IAppReference

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

AttrArn

The Amazon Resource Name (ARN) of the application.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrId

The unique identifier for the application.

public virtual string AttrId { get; }

Property Value

string

Remarks

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

CloudformationAttribute: Id

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

CfnProperties

An app is an Amazon Pinpoint application, also referred to as a project .

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

CfnPropertyNames

An app is an Amazon Pinpoint application, also referred to as a project .

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Name

The display name of the application.

public virtual string Name { get; set; }

Property Value

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual object TagsRaw { get; set; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Methods

ArnForApp(IAppRef)

An app is an Amazon Pinpoint application, also referred to as a project .

public static string ArnForApp(IAppRef resource)

Parameters

resource IAppRef

Returns

string

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.Pinpoint;

             UserPool userPool;
             CfnApp pinpointApp;
             Role pinpointRole;


             new UserPoolClient(this, "Client", new UserPoolClientProps {
                 UserPool = userPool,
                 Analytics = new AnalyticsConfiguration {
                     // Your Pinpoint project
                     Application = pinpointApp,

                     // Whether to include user data in analytics events
                     ShareUserData = true
                 }
             });

FromAppArn(Construct, string, string)

Creates a new IAppRef from an ARN.

public static IAppRef FromAppArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IAppRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

FromAppId(Construct, string, string)

Creates a new IAppRef from a appId.

public static IAppRef FromAppId(Construct scope, string id, string appId)

Parameters

scope Construct

id string

appId string

Returns

IAppRef

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

IsCfnApp(object)

Checks whether the given object is a CfnApp.

public static bool IsCfnApp(object x)

Parameters

x object

Returns

bool

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

RenderProperties(IDictionary<string, object>)

An app is an Amazon Pinpoint application, also referred to as a project .

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-app.html

CloudformationResource: AWS::Pinpoint::App

ExampleMetadata: infused

Implements

IInspectable

IAppRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable