Skip to content
v2.278.0

CfnPredefinedAttributeProps Struct ​

Properties for defining a CfnPredefinedAttribute.

Example ​

ts
// 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'],
  },
};
python
# 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"]
    )
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.connect.*;

CfnPredefinedAttributeProps cfnPredefinedAttributeProps = CfnPredefinedAttributeProps.builder()
        .instanceArn("instanceArn")
        .name("name")

        // the properties below are optional
        .attributeConfiguration(AttributeConfigurationProperty.builder()
                .enableValueValidationOnAssociation(false)
                .isReadOnly(false)
                .build())
        .purposes(List.of("purposes"))
        .values(ValuesProperty.builder()
                .stringList(List.of("stringList"))
                .build())
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Connect;

var cfnPredefinedAttributeProps = new CfnPredefinedAttributeProps {
    InstanceArn = "instanceArn",
    Name = "name",

    // the properties below are optional
    AttributeConfiguration = new AttributeConfigurationProperty {
        EnableValueValidationOnAssociation = false,
        IsReadOnly = false
    },
    Purposes = new [] { "purposes" },
    Values = new ValuesProperty {
        StringList = new [] { "stringList" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnPredefinedAttributeProps := &CfnPredefinedAttributeProps{
	InstanceArn: jsii.String("instanceArn"),
	Name: jsii.String("name"),

	// the properties below are optional
	AttributeConfiguration: &AttributeConfigurationProperty{
		EnableValueValidationOnAssociation: jsii.Boolean(false),
		IsReadOnly: jsii.Boolean(false),
	},
	Purposes: []*string{
		jsii.String("purposes"),
	},
	Values: &ValuesProperty{
		StringList: []*string{
			jsii.String("stringList"),
		},
	},
}

Properties ​

attributeConfigurationoptionalIResolvable | CfnPredefinedAttribute.AttributeConfigurationPropertyattribute_configurationoptionaltyping.Union[IResolvable, AttributeConfigurationProperty]attributeConfigurationoptionalIResolvableAttributeConfigurationoptionalIResolvableAttributeConfigurationoptionalinterface{} #
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*string required #
The Amazon Resource Name (ARN) of the instance.
namestringnamestrnameStringNamestringName*string required #
The name of the predefined attribute.
purposesoptionalstring[]purposesoptionaltyping.List[str]purposesoptionalList<String>Purposesoptionalstring[]Purposesoptional*[]*string #
Values that enable you to categorize your predefined attributes.

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

valuesoptionalIResolvable | CfnPredefinedAttribute.ValuesPropertyvaluesoptionaltyping.Union[IResolvable, ValuesProperty]valuesoptionalIResolvableValuesoptionalIResolvableValuesoptionalinterface{} #
The values of a predefined attribute.