CfnProjectPropsMixin

class aws_cdk.mixins_preview.aws_evidently.mixins.CfnProjectPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates a project, which is the logical object in Evidently that can contain features, launches, and experiments.

Use projects to group similar features together.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-evidently-project.html
CloudformationResource:: AWS::Evidently::Project
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_evidently import mixins as evidently_mixins

cfn_project_props_mixin = evidently_mixins.CfnProjectPropsMixin(evidently_mixins.CfnProjectMixinProps(
    app_config_resource=evidently_mixins.CfnProjectPropsMixin.AppConfigResourceObjectProperty(
        application_id="applicationId",
        environment_id="environmentId"
    ),
    data_delivery=evidently_mixins.CfnProjectPropsMixin.DataDeliveryObjectProperty(
        log_group="logGroup",
        s3=evidently_mixins.CfnProjectPropsMixin.S3DestinationProperty(
            bucket_name="bucketName",
            prefix="prefix"
        )
    ),
    description="description",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Evidently::Project.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['appConfigResource', 'dataDelivery', 'description', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

AppConfigResourceObjectProperty

class CfnProjectPropsMixin.AppConfigResourceObjectProperty(*, application_id=None, environment_id=None)

Bases: object

This is a structure that defines the configuration of how your application integrates with AWS AppConfig to run client-side evaluation.

Parameters:

application_id (Optional[str]) – The ID of the AWS AppConfig application to use for client-side evaluation.
environment_id (Optional[str]) – The ID of the AWS AppConfig environment to use for client-side evaluation.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.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.mixins_preview.aws_evidently import mixins as evidently_mixins

app_config_resource_object_property = evidently_mixins.CfnProjectPropsMixin.AppConfigResourceObjectProperty(
    application_id="applicationId",
    environment_id="environmentId"
)

Attributes

application_id

The ID of the AWS AppConfig application to use for client-side evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-applicationid

environment_id

The ID of the AWS AppConfig environment to use for client-side evaluation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-appconfigresourceobject.html#cfn-evidently-project-appconfigresourceobject-environmentid

DataDeliveryObjectProperty

class CfnProjectPropsMixin.DataDeliveryObjectProperty(*, log_group=None, s3=None)

Bases: object

A structure that contains information about where Evidently is to store evaluation events for longer term storage.

Parameters:

log_group (Optional[str]) – If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name.
s3 (Union[IResolvable, S3DestinationProperty, Dict[str, Any], None]) – If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.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.mixins_preview.aws_evidently import mixins as evidently_mixins

data_delivery_object_property = evidently_mixins.CfnProjectPropsMixin.DataDeliveryObjectProperty(
    log_group="logGroup",
    s3=evidently_mixins.CfnProjectPropsMixin.S3DestinationProperty(
        bucket_name="bucketName",
        prefix="prefix"
    )
)

Attributes

log_group

If the project stores evaluation events in CloudWatch Logs , this structure stores the log group name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-loggroup

s3

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-datadeliveryobject.html#cfn-evidently-project-datadeliveryobject-s3

S3DestinationProperty

class CfnProjectPropsMixin.S3DestinationProperty(*, bucket_name=None, prefix=None)

Bases: object

If the project stores evaluation events in an Amazon S3 bucket, this structure stores the bucket name and bucket prefix.

Parameters:

bucket_name (Optional[str]) – The name of the bucket in which Evidently stores evaluation events.
prefix (Optional[str]) – The bucket prefix in which Evidently stores evaluation events.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.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.mixins_preview.aws_evidently import mixins as evidently_mixins

s3_destination_property = evidently_mixins.CfnProjectPropsMixin.S3DestinationProperty(
    bucket_name="bucketName",
    prefix="prefix"
)

Attributes

bucket_name

The name of the bucket in which Evidently stores evaluation events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-bucketname

prefix

The bucket prefix in which Evidently stores evaluation events.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-evidently-project-s3destination.html#cfn-evidently-project-s3destination-prefix