CfnMetricAttributionPropsMixin

class aws_cdk.cfn_property_mixins.aws_personalize.CfnMetricAttributionPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a metric attribution for reporting on recommendation impact in Amazon Personalize.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-personalize-metricattribution.html
CloudformationResource:: AWS::Personalize::MetricAttribution
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_personalize as personalize
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_metric_attribution_props_mixin = personalize.CfnMetricAttributionPropsMixin(personalize.CfnMetricAttributionMixinProps(
    dataset_group_arn="datasetGroupArn",
    metrics=[personalize.CfnMetricAttributionPropsMixin.MetricAttributeProperty(
        event_type="eventType",
        expression="expression",
        metric_name="metricName"
    )],
    metrics_output_config=personalize.CfnMetricAttributionPropsMixin.MetricsOutputConfigProperty(
        role_arn="roleArn",
        s3_data_destination=personalize.CfnMetricAttributionPropsMixin.S3DataDestinationProperty(
            kms_key_arn="kmsKeyArn",
            path="path"
        )
    ),
    name="name"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Personalize::MetricAttribution.

Parameters:

props (Union[CfnMetricAttributionMixinProps, 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 = ['datasetGroupArn', 'metrics', 'metricsOutputConfig', 'name']

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.

MetricAttributeProperty

class CfnMetricAttributionPropsMixin.MetricAttributeProperty(*, event_type=None, expression=None, metric_name=None)

Bases: object

A metric attribute for the metric attribution.

Parameters:

event_type (Optional[str]) – The metric’s event type.
expression (Optional[str]) – The attribute’s expression.
metric_name (Optional[str]) – The metric’s name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.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_personalize as personalize

metric_attribute_property = personalize.CfnMetricAttributionPropsMixin.MetricAttributeProperty(
    event_type="eventType",
    expression="expression",
    metric_name="metricName"
)

Attributes

event_type

The metric’s event type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-eventtype

expression

The attribute’s expression.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-expression

metric_name

The metric’s name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricattribute.html#cfn-personalize-metricattribution-metricattribute-metricname

MetricsOutputConfigProperty

class CfnMetricAttributionPropsMixin.MetricsOutputConfigProperty(*, role_arn=None, s3_data_destination=None)

Bases: object

The output configuration details for the metric attribution.

Parameters:

role_arn (Optional[str]) – The ARN of the IAM role for the metric attribution.
s3_data_destination (Union[IResolvable, S3DataDestinationProperty, Dict[str, Any], None]) – The configuration details of an Amazon S3 output bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.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_personalize as personalize

metrics_output_config_property = personalize.CfnMetricAttributionPropsMixin.MetricsOutputConfigProperty(
    role_arn="roleArn",
    s3_data_destination=personalize.CfnMetricAttributionPropsMixin.S3DataDestinationProperty(
        kms_key_arn="kmsKeyArn",
        path="path"
    )
)

Attributes

role_arn

The ARN of the IAM role for the metric attribution.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.html#cfn-personalize-metricattribution-metricsoutputconfig-rolearn

s3_data_destination

The configuration details of an Amazon S3 output bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-metricsoutputconfig.html#cfn-personalize-metricattribution-metricsoutputconfig-s3datadestination

S3DataDestinationProperty

class CfnMetricAttributionPropsMixin.S3DataDestinationProperty(*, kms_key_arn=None, path=None)

Bases: object

The configuration details of an Amazon S3 output bucket.

Parameters:

kms_key_arn (Optional[str]) – The ARN of the KMS key.
path (Optional[str]) – The file path of the Amazon S3 bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.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_personalize as personalize

s3_data_destination_property = personalize.CfnMetricAttributionPropsMixin.S3DataDestinationProperty(
    kms_key_arn="kmsKeyArn",
    path="path"
)

Attributes

kms_key_arn

The ARN of the KMS key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.html#cfn-personalize-metricattribution-s3datadestination-kmskeyarn

path

The file path of the Amazon S3 bucket.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-personalize-metricattribution-s3datadestination.html#cfn-personalize-metricattribution-s3datadestination-path