Class CfnRecommender

Resource Type definition for AWS::CustomerProfiles::Recommender.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnRecommender

Implements

IInspectable

IRecommenderRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

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(RemovalPolicy?, IRemovalPolicyOptions)

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

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnRecommender : CfnResource, IInspectable, IRecommenderRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnRecommender Inherits CfnResource Implements IInspectable, IRecommenderRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnRecommender = new CfnRecommender(this, "MyCfnRecommender", new CfnRecommenderProps {
                 DomainName = "domainName",
                 RecommenderName = "recommenderName",
                 RecommenderRecipeName = "recommenderRecipeName",

                 // the properties below are optional
                 Description = "description",
                 RecommenderConfig = new RecommenderConfigProperty {
                     EventsConfig = new EventsConfigProperty {
                         EventParametersList = new [] { new EventParametersProperty {
                             EventType = "eventType",

                             // the properties below are optional
                             EventValueThreshold = 123
                         } }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnRecommender(Construct, string, ICfnRecommenderProps)

Create a new AWS::CustomerProfiles::Recommender.

Properties

AttrCreatedAt	The timestamp of when the recommender was created.
AttrFailureReason	The reason for recommender failure.
AttrLastUpdatedAt	The timestamp of when the recommender was last updated.
AttrLatestRecommenderUpdate	Information about the latest recommender update.
AttrRecommenderArn	The Amazon Resource Name (ARN) of the recommender.
AttrStatus	The status of the recommender.
AttrTrainingMetrics	Resource Type definition for AWS::CustomerProfiles::Recommender.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	Resource Type definition for AWS::CustomerProfiles::Recommender.
Description	The description of the recommender.
DomainName	The name of the domain for which the recommender will be created.
RecommenderConfig	Configuration for the recommender.
RecommenderName	The name of the recommender.
RecommenderRecipeName	The name of the recommender recipe.
RecommenderRef	A reference to a Recommender resource.
Tags	The tags used to organize, track, or control access for this resource.

Methods

ArnForRecommender(IRecommenderRef)	Resource Type definition for AWS::CustomerProfiles::Recommender.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnRecommender(object)	Checks whether the given object is a CfnRecommender.
RenderProperties(IDictionary<string, object>)	Resource Type definition for AWS::CustomerProfiles::Recommender.

Constructors

CfnRecommender(Construct, string, ICfnRecommenderProps)

Create a new AWS::CustomerProfiles::Recommender.

public CfnRecommender(Construct scope, string id, ICfnRecommenderProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

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

props ICfnRecommenderProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Properties

AttrCreatedAt

The timestamp of when the recommender was created.

public virtual string AttrCreatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedAt

AttrFailureReason

The reason for recommender failure.

public virtual string AttrFailureReason { get; }

Property Value

string

Remarks

CloudformationAttribute: FailureReason

AttrLastUpdatedAt

The timestamp of when the recommender was last updated.

public virtual string AttrLastUpdatedAt { get; }

Property Value

string

Remarks

CloudformationAttribute: LastUpdatedAt

AttrLatestRecommenderUpdate

Information about the latest recommender update.

public virtual IResolvable AttrLatestRecommenderUpdate { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: LatestRecommenderUpdate

AttrRecommenderArn

The Amazon Resource Name (ARN) of the recommender.

public virtual string AttrRecommenderArn { get; }

Property Value

string

Remarks

CloudformationAttribute: RecommenderArn

AttrStatus

The status of the recommender.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

CloudformationAttribute: Status

AttrTrainingMetrics

Resource Type definition for AWS::CustomerProfiles::Recommender.

public virtual IResolvable AttrTrainingMetrics { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: TrainingMetrics

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

CfnProperties

Resource Type definition for AWS::CustomerProfiles::Recommender.

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

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Description

The description of the recommender.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

DomainName

The name of the domain for which the recommender will be created.

public virtual string DomainName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

RecommenderConfig

Configuration for the recommender.

public virtual object? RecommenderConfig { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnRecommender.IRecommenderConfigProperty

RecommenderName

The name of the recommender.

public virtual string RecommenderName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

RecommenderRecipeName

The name of the recommender recipe.

public virtual string RecommenderRecipeName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

RecommenderRef

A reference to a Recommender resource.

public virtual IRecommenderReference RecommenderRef { get; }

Property Value

IRecommenderReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Tags

The tags used to organize, track, or control access for this resource.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Methods

ArnForRecommender(IRecommenderRef)

Resource Type definition for AWS::CustomerProfiles::Recommender.

public static string ArnForRecommender(IRecommenderRef resource)

Parameters

resource IRecommenderRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CustomerProfiles;

             var cfnRecommender = new CfnRecommender(this, "MyCfnRecommender", new CfnRecommenderProps {
                 DomainName = "domainName",
                 RecommenderName = "recommenderName",
                 RecommenderRecipeName = "recommenderRecipeName",

                 // the properties below are optional
                 Description = "description",
                 RecommenderConfig = new RecommenderConfigProperty {
                     EventsConfig = new EventsConfigProperty {
                         EventParametersList = new [] { new EventParametersProperty {
                             EventType = "eventType",

                             // the properties below are optional
                             EventValueThreshold = 123
                         } }
                     }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

IsCfnRecommender(object)

Checks whether the given object is a CfnRecommender.

public static bool IsCfnRecommender(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Resource Type definition for AWS::CustomerProfiles::Recommender.

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html

CloudformationResource: AWS::CustomerProfiles::Recommender

ExampleMetadata: fixture=_generated

Implements

IInspectable

IRecommenderRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2