CfnPredefinedAttributeProps

class aws_cdk.aws_connect.CfnPredefinedAttributeProps(*, instance_arn, name, attribute_configuration=None, purposes=None, values=None)

Bases: object

Properties for defining a CfnPredefinedAttribute.

Parameters:

  • instance_arn (str) – The Amazon Resource Name (ARN) of the instance.

  • name (str) – The name of the predefined attribute.

  • attribute_configuration (Union[IResolvable, AttributeConfigurationProperty, Dict[str, Any], None]) – Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

  • purposes (Optional[Sequence[str]]) – Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.

  • values (Union[IResolvable, ValuesProperty, Dict[str, Any], None]) – The values of a predefined attribute.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-connect-predefinedattribute.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 import aws_connect as connect

cfn_predefined_attribute_props = connect.CfnPredefinedAttributeProps(
    instance_arn="instanceArn",
    name="name",

    # the properties below are optional
    attribute_configuration=connect.CfnPredefinedAttribute.AttributeConfigurationProperty(
        enable_value_validation_on_association=False,
        is_read_only=False
    ),
    purposes=["purposes"],
    values=connect.CfnPredefinedAttribute.ValuesProperty(
        string_list=["stringList"]
    )
)

Attributes

attribute_configuration

Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.

See:

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

instance_arn

The Amazon Resource Name (ARN) of the instance.

See:

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

name

The name of the predefined attribute.

See:

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

purposes

Values that enable you to categorize your predefined attributes.

You can use them in custom UI elements across the Amazon Connect admin website.

See:

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

values

The values of a predefined attribute.

See:

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