aws-cdk-lib.aws_connect.CfnPredefinedAttributeProps

CfnPredefinedAttributeProps Struct

Properties for defining a CfnPredefinedAttribute.

CfnPredefinedAttributeProps

used as props by

• CfnPredefinedAttribute

Source

Generated code

Type last changed

v2.214.0 · 2 Sep 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_connect as connect } from 'aws-cdk-lib';
const cfnPredefinedAttributeProps: connect.CfnPredefinedAttributeProps = {
  instanceArn: 'instanceArn',
  name: 'name',

  // the properties below are optional
  attributeConfiguration: {
    enableValueValidationOnAssociation: false,
    isReadOnly: false,
  },
  purposes: ['purposes'],
  values: {
    stringList: ['stringList'],
  },
};

Properties

attributeConfiguration?optionalIResolvable | CfnPredefinedAttribute.AttributeConfigurationPropertyattribute_configuration?optionaltyping.Union[IResolvable, AttributeConfigurationProperty]attributeConfiguration?optionalIResolvableAttributeConfiguration?optionalIResolvableAttributeConfiguration?optionalinterface{}#

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.

instanceArnstringinstance_arnstrinstanceArnStringInstanceArnstringInstanceArn*stringrequired#

The Amazon Resource Name (ARN) of the instance.

namestringnamestrnameStringNamestringName*stringrequired#

The name of the predefined attribute.

purposes?optionalstring[]purposes?optionaltyping.List[str]purposes?optionalList<String>Purposes?optionalstring[]Purposes?optional*[]*string#

Values that enable you to categorize your predefined attributes.

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

values?optionalIResolvable | CfnPredefinedAttribute.ValuesPropertyvalues?optionaltyping.Union[IResolvable, ValuesProperty]values?optionalIResolvableValues?optionalIResolvableValues?optionalinterface{}#

The values of a predefined attribute.