CfnMetricPropsMixin

class aws_cdk.cfn_property_mixins.aws_connect.CfnMetricPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::Connect::Metric, a custom metric configured for an Amazon Connect instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-metric.html
CloudformationResource:: AWS::Connect::Metric
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_connect as connect
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_metric_props_mixin = connect.CfnMetricPropsMixin(connect.CfnMetricMixinProps(
    description="description",
    instance_arn="instanceArn",
    metric_calculation=connect.CfnMetricPropsMixin.MetricCalculationProperty(
        calculation="calculation",
        calculation_components=[connect.CfnMetricPropsMixin.CalculationComponentProperty(
            alias="alias",
            metric_filters=[connect.CfnMetricPropsMixin.MetricFilterProperty(
                boolean_condition=connect.CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(
                    comparison="comparison"
                ),
                metric_filter_key="metricFilterKey",
                negate=False,
                number_condition=connect.CfnMetricPropsMixin.MetricFilterNumberConditionProperty(
                    comparison="comparison",
                    values=[123]
                ),
                string_condition=connect.CfnMetricPropsMixin.MetricFilterStringConditionProperty(
                    comparison="comparison",
                    values=["values"]
                )
            )],
            metric_id="metricId",
            metric_name="metricName"
        )]
    ),
    name="name",
    positive_trend_indicator="positiveTrendIndicator",
    status="status",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    unit="unit"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::Connect::Metric.

Parameters:

props (Union[CfnMetricMixinProps, 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', 'instanceArn', 'metricCalculation', 'name', 'positiveTrendIndicator', 'status', 'tags', 'unit']

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.

AvailableFilterProperty

class CfnMetricPropsMixin.AvailableFilterProperty(*, id=None, type=None)

Bases: object

Parameters:

id (Optional[str])
type (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-availablefilter.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_connect as connect

available_filter_property = connect.CfnMetricPropsMixin.AvailableFilterProperty(
    id="id",
    type="type"
)

Attributes

id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-availablefilter.html#cfn-connect-metric-availablefilter-id

Type:: see

type

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-availablefilter.html#cfn-connect-metric-availablefilter-type

Type:: see

CalculationComponentProperty

class CfnMetricPropsMixin.CalculationComponentProperty(*, alias=None, metric_filters=None, metric_id=None, metric_name=None)

Bases: object

Parameters:

alias (Optional[str]) – Metric calculation component alias for use within a calculation.
metric_filters (Union[IResolvable, Sequence[Union[IResolvable, MetricFilterProperty, Dict[str, Any]]], None])
metric_id (Optional[str])
metric_name (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-calculationcomponent.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_connect as connect

calculation_component_property = connect.CfnMetricPropsMixin.CalculationComponentProperty(
    alias="alias",
    metric_filters=[connect.CfnMetricPropsMixin.MetricFilterProperty(
        boolean_condition=connect.CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(
            comparison="comparison"
        ),
        metric_filter_key="metricFilterKey",
        negate=False,
        number_condition=connect.CfnMetricPropsMixin.MetricFilterNumberConditionProperty(
            comparison="comparison",
            values=[123]
        ),
        string_condition=connect.CfnMetricPropsMixin.MetricFilterStringConditionProperty(
            comparison="comparison",
            values=["values"]
        )
    )],
    metric_id="metricId",
    metric_name="metricName"
)

Attributes

alias

Metric calculation component alias for use within a calculation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-calculationcomponent.html#cfn-connect-metric-calculationcomponent-alias

metric_filters

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-calculationcomponent.html#cfn-connect-metric-calculationcomponent-metricfilters

Type:: see

metric_id

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-calculationcomponent.html#cfn-connect-metric-calculationcomponent-metricid

Type:: see

metric_name

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-calculationcomponent.html#cfn-connect-metric-calculationcomponent-metricname

Type:: see

CreatedByInfoProperty

class CfnMetricPropsMixin.CreatedByInfoProperty(*, aws_identity_arn=None, connect_user_arn=None)

Bases: object

Parameters:

aws_identity_arn (Optional[str]) – STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.
connect_user_arn (Optional[str]) – An agent ARN representing a connect user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-createdbyinfo.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_connect as connect

created_by_info_property = connect.CfnMetricPropsMixin.CreatedByInfoProperty(
    aws_identity_arn="awsIdentityArn",
    connect_user_arn="connectUserArn"
)

Attributes

aws_identity_arn

STS or IAM ARN representing the identity of API Caller.

SDK users cannot populate this and this value is calculated automatically if ConnectUserArn is not provided.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-createdbyinfo.html#cfn-connect-metric-createdbyinfo-awsidentityarn

connect_user_arn

An agent ARN representing a connect user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-createdbyinfo.html#cfn-connect-metric-createdbyinfo-connectuserarn

MetricCalculationProperty

class CfnMetricPropsMixin.MetricCalculationProperty(*, calculation=None, calculation_components=None)

Bases: object

The calculation configuration for the metric.

Parameters:

calculation (Optional[str]) – The calculation formula.
calculation_components (Union[IResolvable, Sequence[Union[IResolvable, CalculationComponentProperty, Dict[str, Any]]], None]) – The calculation components for the metric.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metriccalculation.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_connect as connect

metric_calculation_property = connect.CfnMetricPropsMixin.MetricCalculationProperty(
    calculation="calculation",
    calculation_components=[connect.CfnMetricPropsMixin.CalculationComponentProperty(
        alias="alias",
        metric_filters=[connect.CfnMetricPropsMixin.MetricFilterProperty(
            boolean_condition=connect.CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(
                comparison="comparison"
            ),
            metric_filter_key="metricFilterKey",
            negate=False,
            number_condition=connect.CfnMetricPropsMixin.MetricFilterNumberConditionProperty(
                comparison="comparison",
                values=[123]
            ),
            string_condition=connect.CfnMetricPropsMixin.MetricFilterStringConditionProperty(
                comparison="comparison",
                values=["values"]
            )
        )],
        metric_id="metricId",
        metric_name="metricName"
    )]
)

Attributes

calculation

The calculation formula.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metriccalculation.html#cfn-connect-metric-metriccalculation-calculation

calculation_components

The calculation components for the metric.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metriccalculation.html#cfn-connect-metric-metriccalculation-calculationcomponents

MetricFilterBooleanConditionProperty

class CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(*, comparison=None)

Bases: object

Parameters:: comparison (Optional[str])
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilterbooleancondition.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_connect as connect

metric_filter_boolean_condition_property = connect.CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(
    comparison="comparison"
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilterbooleancondition.html#cfn-connect-metric-metricfilterbooleancondition-comparison

Type:: see

MetricFilterNumberConditionProperty

class CfnMetricPropsMixin.MetricFilterNumberConditionProperty(*, comparison=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
values (Union[Sequence[Union[int, float]], IResolvable, None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilternumbercondition.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_connect as connect

metric_filter_number_condition_property = connect.CfnMetricPropsMixin.MetricFilterNumberConditionProperty(
    comparison="comparison",
    values=[123]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilternumbercondition.html#cfn-connect-metric-metricfilternumbercondition-comparison

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilternumbercondition.html#cfn-connect-metric-metricfilternumbercondition-values

Type:: see

MetricFilterProperty

class CfnMetricPropsMixin.MetricFilterProperty(*, boolean_condition=None, metric_filter_key=None, negate=None, number_condition=None, string_condition=None)

Bases: object

Parameters:

boolean_condition (Union[IResolvable, MetricFilterBooleanConditionProperty, Dict[str, Any], None])
metric_filter_key (Optional[str])
negate (Union[bool, IResolvable, None])
number_condition (Union[IResolvable, MetricFilterNumberConditionProperty, Dict[str, Any], None])
string_condition (Union[IResolvable, MetricFilterStringConditionProperty, Dict[str, Any], None])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.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_connect as connect

metric_filter_property = connect.CfnMetricPropsMixin.MetricFilterProperty(
    boolean_condition=connect.CfnMetricPropsMixin.MetricFilterBooleanConditionProperty(
        comparison="comparison"
    ),
    metric_filter_key="metricFilterKey",
    negate=False,
    number_condition=connect.CfnMetricPropsMixin.MetricFilterNumberConditionProperty(
        comparison="comparison",
        values=[123]
    ),
    string_condition=connect.CfnMetricPropsMixin.MetricFilterStringConditionProperty(
        comparison="comparison",
        values=["values"]
    )
)

Attributes

boolean_condition

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.html#cfn-connect-metric-metricfilter-booleancondition

Type:: see

metric_filter_key

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.html#cfn-connect-metric-metricfilter-metricfilterkey

Type:: see

negate

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.html#cfn-connect-metric-metricfilter-negate

Type:: see

number_condition

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.html#cfn-connect-metric-metricfilter-numbercondition

Type:: see

string_condition

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilter.html#cfn-connect-metric-metricfilter-stringcondition

Type:: see

MetricFilterStringConditionProperty

class CfnMetricPropsMixin.MetricFilterStringConditionProperty(*, comparison=None, values=None)

Bases: object

Parameters:

comparison (Optional[str])
values (Optional[Sequence[str]])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilterstringcondition.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_connect as connect

metric_filter_string_condition_property = connect.CfnMetricPropsMixin.MetricFilterStringConditionProperty(
    comparison="comparison",
    values=["values"]
)

Attributes

comparison

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilterstringcondition.html#cfn-connect-metric-metricfilterstringcondition-comparison

Type:: see

values

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-metric-metricfilterstringcondition.html#cfn-connect-metric-metricfilterstringcondition-values

Type:: see