CfnQueuePropsMixin

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

Bases: Mixin

Contains information about a queue.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-queue.html
CloudformationResource:: AWS::Connect::Queue
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_queue_props_mixin = connect_mixins.CfnQueuePropsMixin(connect_mixins.CfnQueueMixinProps(
    description="description",
    hours_of_operation_arn="hoursOfOperationArn",
    instance_arn="instanceArn",
    max_contacts=123,
    name="name",
    outbound_caller_config=connect_mixins.CfnQueuePropsMixin.OutboundCallerConfigProperty(
        outbound_caller_id_name="outboundCallerIdName",
        outbound_caller_id_number_arn="outboundCallerIdNumberArn",
        outbound_flow_arn="outboundFlowArn"
    ),
    outbound_email_config=connect_mixins.CfnQueuePropsMixin.OutboundEmailConfigProperty(
        outbound_email_address_id="outboundEmailAddressId"
    ),
    quick_connect_arns=["quickConnectArns"],
    status="status",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnQueueMixinProps, 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', 'hoursOfOperationArn', 'instanceArn', 'maxContacts', 'name', 'outboundCallerConfig', 'outboundEmailConfig', 'quickConnectArns', 'status', '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

OutboundCallerConfigProperty

class CfnQueuePropsMixin.OutboundCallerConfigProperty(*, outbound_caller_id_name=None, outbound_caller_id_number_arn=None, outbound_flow_arn=None)

Bases: object

The outbound caller ID name, number, and outbound whisper flow.

Parameters:

outbound_caller_id_name (Optional[str]) – The caller ID name.
outbound_caller_id_number_arn (Optional[str]) – The Amazon Resource Name (ARN) of the outbound caller ID number. .. epigraph:: Only use the phone number ARN format that doesn’t contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.
outbound_flow_arn (Optional[str]) – The Amazon Resource Name (ARN) of the outbound flow.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundcallerconfig.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

outbound_caller_config_property = connect_mixins.CfnQueuePropsMixin.OutboundCallerConfigProperty(
    outbound_caller_id_name="outboundCallerIdName",
    outbound_caller_id_number_arn="outboundCallerIdNumberArn",
    outbound_flow_arn="outboundFlowArn"
)

Attributes

outbound_caller_id_name

The caller ID name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundcallerconfig.html#cfn-connect-queue-outboundcallerconfig-outboundcalleridname

outbound_caller_id_number_arn

The Amazon Resource Name (ARN) of the outbound caller ID number.

Only use the phone number ARN format that doesn’t contain instance in the path, for example, arn:aws:connect:us-east-1:1234567890:phone-number/uuid . This is the same ARN format that is returned when you create a phone number using CloudFormation , or when you call the ListPhoneNumbersV2 API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundcallerconfig.html#cfn-connect-queue-outboundcallerconfig-outboundcalleridnumberarn

outbound_flow_arn

The Amazon Resource Name (ARN) of the outbound flow.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundcallerconfig.html#cfn-connect-queue-outboundcallerconfig-outboundflowarn

OutboundEmailConfigProperty

class CfnQueuePropsMixin.OutboundEmailConfigProperty(*, outbound_email_address_id=None)

Bases: object

The outbound email address ID.

Parameters:: outbound_email_address_id (Optional[str]) – The identifier of the email address.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundemailconfig.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

outbound_email_config_property = connect_mixins.CfnQueuePropsMixin.OutboundEmailConfigProperty(
    outbound_email_address_id="outboundEmailAddressId"
)

Attributes

outbound_email_address_id

The identifier of the email address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-connect-queue-outboundemailconfig.html#cfn-connect-queue-outboundemailconfig-outboundemailaddressid