CfnRecommenderPropsMixin

class aws_cdk.cfn_property_mixins.aws_customerprofiles.CfnRecommenderPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html
CloudformationResource:: AWS::CustomerProfiles::Recommender
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_recommender_props_mixin = customerprofiles.CfnRecommenderPropsMixin(customerprofiles.CfnRecommenderMixinProps(
    description="description",
    domain_name="domainName",
    recommender_config=customerprofiles.CfnRecommenderPropsMixin.RecommenderConfigProperty(
        events_config=customerprofiles.CfnRecommenderPropsMixin.EventsConfigProperty(
            event_parameters_list=[customerprofiles.CfnRecommenderPropsMixin.EventParametersProperty(
                event_type="eventType",
                event_value_threshold=123
            )]
        )
    ),
    recommender_name="recommenderName",
    recommender_recipe_name="recommenderRecipeName",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::CustomerProfiles::Recommender.

Parameters:

props (Union[CfnRecommenderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['description', 'domainName', 'recommenderConfig', 'recommenderName', 'recommenderRecipeName', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

EventParametersProperty

class CfnRecommenderPropsMixin.EventParametersProperty(*, event_type=None, event_value_threshold=None)

Bases: object

Event parameters with type and value threshold.

Parameters:

event_type (Optional[str]) – The type of event.
event_value_threshold (Union[int, float, None]) – The threshold of the event type. Only events with a value greater or equal to this threshold will be considered for solution creation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

event_parameters_property = customerprofiles.CfnRecommenderPropsMixin.EventParametersProperty(
    event_type="eventType",
    event_value_threshold=123
)

Attributes

event_type

The type of event.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventtype

event_value_threshold

The threshold of the event type.

Only events with a value greater or equal to this threshold will be considered for solution creation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventvaluethreshold

EventsConfigProperty

class CfnRecommenderPropsMixin.EventsConfigProperty(*, event_parameters_list=None)

Bases: object

Configuration for events used in the recommender.

Parameters:: event_parameters_list (Union[IResolvable, Sequence[Union[IResolvable, EventParametersProperty, Dict[str, Any]]], None]) – List of event parameters with their value thresholds.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventsconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

events_config_property = customerprofiles.CfnRecommenderPropsMixin.EventsConfigProperty(
    event_parameters_list=[customerprofiles.CfnRecommenderPropsMixin.EventParametersProperty(
        event_type="eventType",
        event_value_threshold=123
    )]
)

Attributes

event_parameters_list

List of event parameters with their value thresholds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventsconfig.html#cfn-customerprofiles-recommender-eventsconfig-eventparameterslist

MetricsProperty

class CfnRecommenderPropsMixin.MetricsProperty(*, coverage=None, freshness=None, hit=None, popularity=None, recall=None, similarity=None)

Bases: object

Training metrics by type.

Parameters:

coverage (Union[int, float, None])
freshness (Union[int, float, None])
hit (Union[int, float, None])
popularity (Union[int, float, None])
recall (Union[int, float, None])
similarity (Union[int, float, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

metrics_property = customerprofiles.CfnRecommenderPropsMixin.MetricsProperty(
    coverage=123,
    freshness=123,
    hit=123,
    popularity=123,
    recall=123,
    similarity=123
)

Attributes

coverage

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-coverage

Type:: see

freshness

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-freshness

Type:: see

hit

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-hit

Type:: see

Type:: see

recall

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-recall

Type:: see

Type:: see

RecommenderConfigProperty

class CfnRecommenderPropsMixin.RecommenderConfigProperty(*, events_config=None)

Bases: object

Configuration for the recommender.

Parameters:: events_config (Union[IResolvable, EventsConfigProperty, Dict[str, Any], None]) – Configuration for events used in the recommender.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

recommender_config_property = customerprofiles.CfnRecommenderPropsMixin.RecommenderConfigProperty(
    events_config=customerprofiles.CfnRecommenderPropsMixin.EventsConfigProperty(
        event_parameters_list=[customerprofiles.CfnRecommenderPropsMixin.EventParametersProperty(
            event_type="eventType",
            event_value_threshold=123
        )]
    )
)

Attributes

events_config

Configuration for events used in the recommender.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderconfig.html#cfn-customerprofiles-recommender-recommenderconfig-eventsconfig

RecommenderUpdateProperty

class CfnRecommenderPropsMixin.RecommenderUpdateProperty(*, creation_date_time=None, failure_reason=None, last_updated_date_time=None, recommender_config=None, status=None)

Bases: object

Information about the latest recommender update.

Parameters:

creation_date_time (Optional[str]) – The timestamp of when the update was created.
failure_reason (Optional[str]) – The reason for update failure.
last_updated_date_time (Optional[str]) – The timestamp of when the update was last modified.
recommender_config (Union[IResolvable, RecommenderConfigProperty, Dict[str, Any], None]) – Configuration for the recommender.
status (Optional[str]) – The status of the recommender.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

recommender_update_property = customerprofiles.CfnRecommenderPropsMixin.RecommenderUpdateProperty(
    creation_date_time="creationDateTime",
    failure_reason="failureReason",
    last_updated_date_time="lastUpdatedDateTime",
    recommender_config=customerprofiles.CfnRecommenderPropsMixin.RecommenderConfigProperty(
        events_config=customerprofiles.CfnRecommenderPropsMixin.EventsConfigProperty(
            event_parameters_list=[customerprofiles.CfnRecommenderPropsMixin.EventParametersProperty(
                event_type="eventType",
                event_value_threshold=123
            )]
        )
    ),
    status="status"
)

Attributes

creation_date_time

The timestamp of when the update was created.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-creationdatetime

failure_reason

The reason for update failure.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-failurereason

last_updated_date_time

The timestamp of when the update was last modified.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-lastupdateddatetime

recommender_config

Configuration for the recommender.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-recommenderconfig

status

The status of the recommender.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-status

TrainingMetricsProperty

class CfnRecommenderPropsMixin.TrainingMetricsProperty(*, metrics=None, time=None)

Bases: object

Parameters:

metrics (Union[IResolvable, MetricsProperty, Dict[str, Any], None]) – Training metrics by type.
time (Optional[str]) – Timestamp of the training metrics.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_customerprofiles as customerprofiles

training_metrics_property = customerprofiles.CfnRecommenderPropsMixin.TrainingMetricsProperty(
    metrics=customerprofiles.CfnRecommenderPropsMixin.MetricsProperty(
        coverage=123,
        freshness=123,
        hit=123,
        popularity=123,
        recall=123,
        similarity=123
    ),
    time="time"
)

Attributes

metrics

Training metrics by type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-metrics

time

Timestamp of the training metrics.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-time