Show / Hide Table of Contents

Class CfnApp

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

Inheritance
System.Object
CfnElement
CfnRefElement
CfnResource
CfnApp
Implements
IInspectable
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.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)
CfnResource.GetAtt(String, Nullable<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.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(Object)
CfnElement.OverrideLogicalId(String)
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnApp : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnApp
    Inherits CfnResource
    Implements IInspectable, 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(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

CfnApp(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

CfnApp(Construct, String, ICfnAppProps)

Properties

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

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

RenderProperties(IDictionary<String, Object>)

Constructors

CfnApp(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnApp(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

CfnApp(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnApp(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

CfnApp(Construct, String, ICfnAppProps)

public CfnApp(Construct scope, string id, ICfnAppProps props)
Parameters
scope Constructs.Construct

Scope in which this resource is defined.

id System.String

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

props ICfnAppProps

Resource properties.

Properties

AttrArn

The Amazon Resource Name (ARN) of the application.

public virtual string AttrArn { get; }
Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrId

The unique identifier for the application.

public virtual string AttrId { get; }
Property Value

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

System.String

CfnProperties

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

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.CfnProperties

Name

The display name of the application.

public virtual string Name { get; set; }
Property Value

System.String

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }
Property Value

TagManager

TagsRaw

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

public virtual object TagsRaw { get; set; }
Property Value

System.Object

Methods

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.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides
CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IInspectable
ITaggable
Back to top Generated by DocFX