CfnQuickConnectPropsMixin

class aws_cdk.mixins_preview.aws_connect.mixins.CfnQuickConnectPropsMixin(props, *, strategy=None)

Bases: Mixin

Specifies a quick connect for an Amazon Connect instance.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-quickconnect.html
CloudformationResource:: AWS::Connect::QuickConnect
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_connect import mixins as connect_mixins

cfn_quick_connect_props_mixin = connect_mixins.CfnQuickConnectPropsMixin(connect_mixins.CfnQuickConnectMixinProps(
    description="description",
    instance_arn="instanceArn",
    name="name",
    quick_connect_config=connect_mixins.CfnQuickConnectPropsMixin.QuickConnectConfigProperty(
        phone_config=connect_mixins.CfnQuickConnectPropsMixin.PhoneNumberQuickConnectConfigProperty(
            phone_number="phoneNumber"
        ),
        queue_config=connect_mixins.CfnQuickConnectPropsMixin.QueueQuickConnectConfigProperty(
            contact_flow_arn="contactFlowArn",
            queue_arn="queueArn"
        ),
        quick_connect_type="quickConnectType",
        user_config=connect_mixins.CfnQuickConnectPropsMixin.UserQuickConnectConfigProperty(
            contact_flow_arn="contactFlowArn",
            user_arn="userArn"
        )
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnQuickConnectMixinProps, 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 = ['description', 'instanceArn', 'name', 'quickConnectConfig', '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

PhoneNumberQuickConnectConfigProperty

class CfnQuickConnectPropsMixin.PhoneNumberQuickConnectConfigProperty(*, phone_number=None)

Bases: object

Contains information about a phone number for a quick connect.

Parameters:: phone_number (Optional[str]) – The phone number in E.164 format.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-phonenumberquickconnectconfig.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_connect import mixins as connect_mixins

phone_number_quick_connect_config_property = connect_mixins.CfnQuickConnectPropsMixin.PhoneNumberQuickConnectConfigProperty(
    phone_number="phoneNumber"
)

Attributes

phone_number

The phone number in E.164 format.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-phonenumberquickconnectconfig.html#cfn-connect-quickconnect-phonenumberquickconnectconfig-phonenumber

QueueQuickConnectConfigProperty

class CfnQuickConnectPropsMixin.QueueQuickConnectConfigProperty(*, contact_flow_arn=None, queue_arn=None)

Bases: object

Contains information about a queue for a quick connect.

The flow must be of type Transfer to Queue.

Parameters:

contact_flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the flow.
queue_arn (Optional[str]) – The Amazon Resource Name (ARN) of the queue.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-queuequickconnectconfig.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_connect import mixins as connect_mixins

queue_quick_connect_config_property = connect_mixins.CfnQuickConnectPropsMixin.QueueQuickConnectConfigProperty(
    contact_flow_arn="contactFlowArn",
    queue_arn="queueArn"
)

Attributes

contact_flow_arn

The Amazon Resource Name (ARN) of the flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-queuequickconnectconfig.html#cfn-connect-quickconnect-queuequickconnectconfig-contactflowarn

queue_arn

The Amazon Resource Name (ARN) of the queue.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-queuequickconnectconfig.html#cfn-connect-quickconnect-queuequickconnectconfig-queuearn

QuickConnectConfigProperty

class CfnQuickConnectPropsMixin.QuickConnectConfigProperty(*, phone_config=None, queue_config=None, quick_connect_type=None, user_config=None)

Bases: object

Contains configuration settings for a quick connect.

Parameters:

phone_config (Union[IResolvable, PhoneNumberQuickConnectConfigProperty, Dict[str, Any], None]) – The phone configuration. This is required only if QuickConnectType is PHONE_NUMBER.
queue_config (Union[IResolvable, QueueQuickConnectConfigProperty, Dict[str, Any], None]) – The queue configuration. This is required only if QuickConnectType is QUEUE.
quick_connect_type (Optional[str]) – The type of quick connect. In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).
user_config (Union[IResolvable, UserQuickConnectConfigProperty, Dict[str, Any], None]) – The user configuration. This is required only if QuickConnectType is USER.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.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_connect import mixins as connect_mixins

quick_connect_config_property = connect_mixins.CfnQuickConnectPropsMixin.QuickConnectConfigProperty(
    phone_config=connect_mixins.CfnQuickConnectPropsMixin.PhoneNumberQuickConnectConfigProperty(
        phone_number="phoneNumber"
    ),
    queue_config=connect_mixins.CfnQuickConnectPropsMixin.QueueQuickConnectConfigProperty(
        contact_flow_arn="contactFlowArn",
        queue_arn="queueArn"
    ),
    quick_connect_type="quickConnectType",
    user_config=connect_mixins.CfnQuickConnectPropsMixin.UserQuickConnectConfigProperty(
        contact_flow_arn="contactFlowArn",
        user_arn="userArn"
    )
)

Attributes

phone_config

The phone configuration.

This is required only if QuickConnectType is PHONE_NUMBER.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.html#cfn-connect-quickconnect-quickconnectconfig-phoneconfig

queue_config

The queue configuration.

This is required only if QuickConnectType is QUEUE.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.html#cfn-connect-quickconnect-quickconnectconfig-queueconfig

quick_connect_type

The type of quick connect.

In the Amazon Connect console, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.html#cfn-connect-quickconnect-quickconnectconfig-quickconnecttype

user_config

The user configuration.

This is required only if QuickConnectType is USER.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-quickconnectconfig.html#cfn-connect-quickconnect-quickconnectconfig-userconfig

UserQuickConnectConfigProperty

class CfnQuickConnectPropsMixin.UserQuickConnectConfigProperty(*, contact_flow_arn=None, user_arn=None)

Bases: object

Contains information about the quick connect configuration settings for a user.

The contact flow must be of type Transfer to Agent.

Parameters:

contact_flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the flow.
user_arn (Optional[str]) – The Amazon Resource Name (ARN) of the user.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-userquickconnectconfig.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_connect import mixins as connect_mixins

user_quick_connect_config_property = connect_mixins.CfnQuickConnectPropsMixin.UserQuickConnectConfigProperty(
    contact_flow_arn="contactFlowArn",
    user_arn="userArn"
)

Attributes

contact_flow_arn

The Amazon Resource Name (ARN) of the flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-userquickconnectconfig.html#cfn-connect-quickconnect-userquickconnectconfig-contactflowarn

user_arn

The Amazon Resource Name (ARN) of the user.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-quickconnect-userquickconnectconfig.html#cfn-connect-quickconnect-userquickconnectconfig-userarn