Package software.amazon.awscdk.services.connect

Class CfnPredefinedAttribute

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.connect.CfnPredefinedAttribute
All Implemented Interfaces:
IInspectable, IPredefinedAttributeRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:17.657Z") @Stability(Stable) public class CfnPredefinedAttribute extends CfnResource implements IInspectable, IPredefinedAttributeRef
Textual or numeric value that describes an attribute.

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.*;
 CfnPredefinedAttribute cfnPredefinedAttribute = CfnPredefinedAttribute.Builder.create(this, "MyCfnPredefinedAttribute")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnPredefinedAttribute

      protected CfnPredefinedAttribute(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnPredefinedAttribute

      protected CfnPredefinedAttribute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnPredefinedAttribute

      @Stability(Stable) public CfnPredefinedAttribute(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnPredefinedAttributeProps props)
      Create a new AWS::Connect::PredefinedAttribute.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnPredefinedAttribute

      @Stability(Stable) @NotNull public static Boolean isCfnPredefinedAttribute(@NotNull Object x)
      Checks whether the given object is a CfnPredefinedAttribute.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrLastModifiedRegion

      @Stability(Stable) @NotNull public String getAttrLastModifiedRegion()
      Last modified region.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public IResolvable getAttrLastModifiedTime()
      Last modified time.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getPredefinedAttributeRef

      @Stability(Stable) @NotNull public PredefinedAttributeReference getPredefinedAttributeRef()
      A reference to a PredefinedAttribute resource.
      Specified by:
      getPredefinedAttributeRef in interface IPredefinedAttributeRef

    • getInstanceArn

      @Stability(Stable) @NotNull public String getInstanceArn()
      The Amazon Resource Name (ARN) of the instance.

    • setInstanceArn

      @Stability(Stable) public void setInstanceArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the instance.

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the predefined attribute.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the predefined attribute.

    • getAttributeConfiguration

      @Stability(Stable) @Nullable public 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

    • setAttributeConfiguration

      @Stability(Stable) public void setAttributeConfiguration(@Nullable IResolvable value)
      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.

    • setAttributeConfiguration

      @Stability(Stable) public void setAttributeConfiguration(@Nullable CfnPredefinedAttribute.AttributeConfigurationProperty value)
      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.

    • getPurposes

      @Stability(Stable) @Nullable public List<String> getPurposes()
      Values that enable you to categorize your predefined attributes.

    • setPurposes

      @Stability(Stable) public void setPurposes(@Nullable List<String> value)
      Values that enable you to categorize your predefined attributes.

    • getValues

      @Stability(Stable) @Nullable public Object getValues()
      The values of a predefined attribute.

      Returns union: either IResolvable or CfnPredefinedAttribute.ValuesProperty

    • setValues

      @Stability(Stable) public void setValues(@Nullable IResolvable value)
      The values of a predefined attribute.

    • setValues

      @Stability(Stable) public void setValues(@Nullable CfnPredefinedAttribute.ValuesProperty value)
      The values of a predefined attribute.