Package software.amazon.awscdk.services.connect

Interface CfnPredefinedAttributeProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPredefinedAttributeProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:48.386Z")
@Stability(Stable)
public interface CfnPredefinedAttributeProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPredefinedAttribute.

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnPredefinedAttributeProps.Builder	A builder for CfnPredefinedAttributeProps
static final class	CfnPredefinedAttributeProps.Jsii$Proxy	An implementation for CfnPredefinedAttributeProps

Method Summary

Modifier and Type	Method	Description
static CfnPredefinedAttributeProps.Builder	builder()
default Object	getAttributeConfiguration()	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.
String	getInstanceArn()	The Amazon Resource Name (ARN) of the instance.
String	getName()	The name of the predefined attribute.
default List<String>	getPurposes()	Values that enable you to categorize your predefined attributes.
default Object	getValues()	The values of a predefined attribute.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInstanceArn

@Stability(Stable)
@NotNull
String getInstanceArn()

The Amazon Resource Name (ARN) of the instance.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the predefined attribute.

See Also:

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

getAttributeConfiguration

@Stability(Stable)
@Nullable
default Object getAttributeConfiguration()

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.

Returns union: either IResolvable or CfnPredefinedAttribute.AttributeConfigurationProperty

See Also:

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

getPurposes

@Stability(Stable)
@Nullable
default List<String> getPurposes()

Values that enable you to categorize your predefined attributes.

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

See Also:

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

getValues

@Stability(Stable)
@Nullable
default Object getValues()

The values of a predefined attribute.

Returns union: either IResolvable or CfnPredefinedAttribute.ValuesProperty

See Also:

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

builder

@Stability(Stable)
static CfnPredefinedAttributeProps.Builder builder()

Returns:

a CfnPredefinedAttributeProps.Builder of CfnPredefinedAttributeProps