CfnInstanceProps

class aws_cdk.aws_connect.CfnInstanceProps(*, attributes, identity_management_type, directory_id=None, instance_alias=None)

Bases: object

Properties for defining a CfnInstance.

Parameters:

  • attributes (Union[IResolvable, AttributesProperty, Dict[str, Any]]) – A toggle for an individual feature at the instance level.

  • identity_management_type (str) – The identity management type.

  • directory_id (Optional[str]) – The identifier for the directory.

  • instance_alias (Optional[str]) – The alias of instance. InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML . InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_connect as connect

cfn_instance_props = connect.CfnInstanceProps(
    attributes=connect.CfnInstance.AttributesProperty(
        inbound_calls=False,
        outbound_calls=False,

        # the properties below are optional
        auto_resolve_best_voices=False,
        contactflow_logs=False,
        contact_lens=False,
        early_media=False,
        use_custom_tts_voices=False
    ),
    identity_management_type="identityManagementType",

    # the properties below are optional
    directory_id="directoryId",
    instance_alias="instanceAlias"
)

Attributes

attributes

A toggle for an individual feature at the instance level.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html#cfn-connect-instance-attributes

directory_id

The identifier for the directory.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html#cfn-connect-instance-directoryid

identity_management_type

The identity management type.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html#cfn-connect-instance-identitymanagementtype

instance_alias

The alias of instance.

InstanceAlias is only required when IdentityManagementType is CONNECT_MANAGED or SAML . InstanceAlias is not required when IdentityManagementType is EXISTING_DIRECTORY .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-instance.html#cfn-connect-instance-instancealias