Package software.amazon.awscdk.services.voiceid

Class CfnDomain

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.voiceid.CfnDomain
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDomainRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.085Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable, IDomainRef, ITaggable

End of support notice: On May 20, 2026, AWS will end support for Amazon Connect Voice ID.

After May 20, 2026, you will no longer be able to access Voice ID on the Amazon Connect console, access Voice ID features on the Amazon Connect admin website or Contact Control Panel, or access Voice ID resources. For more information, visit Amazon Connect Voice ID end of support .

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints. Every domain is created with a default watchlist that fraudsters can be a part of.

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.voiceid.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .name("name")
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .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

    • CfnDomain

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

    • CfnDomain

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

    • CfnDomain

      @Stability(Stable) public CfnDomain(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDomainProps props)
      Create a new AWS::VoiceID::Domain.

      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

    • arnForDomain

      @Stability(Stable) @NotNull public static String arnForDomain(@NotNull IDomainRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDomainId

      @Stability(Stable) @NotNull public static IDomainRef fromDomainId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String domainId)
      Creates a new IDomainRef from a domainId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      domainId - This parameter is required.

    • isCfnDomain

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

      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.

    • getAttrDomainId

      @Stability(Stable) @NotNull public String getAttrDomainId()
      The identifier of the domain.

    • getCfnProperties

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

    • getDomainRef

      @Stability(Stable) @NotNull public DomainReference getDomainRef()
      A reference to a Domain resource.
      Specified by:
      getDomainRef in interface IDomainRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name for the domain.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name for the domain.

    • getServerSideEncryptionConfiguration

      @Stability(Stable) @NotNull public Object getServerSideEncryptionConfiguration()
      The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

      Returns union: either IResolvable or CfnDomain.ServerSideEncryptionConfigurationProperty

    • setServerSideEncryptionConfiguration

      @Stability(Stable) public void setServerSideEncryptionConfiguration(@NotNull IResolvable value)
      The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

    • setServerSideEncryptionConfiguration

      @Stability(Stable) public void setServerSideEncryptionConfiguration(@NotNull CfnDomain.ServerSideEncryptionConfigurationProperty value)
      The server-side encryption configuration containing the KMS key identifier you want Voice ID to use to encrypt your data.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the domain.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the domain.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags used to organize, track, or control access for this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags used to organize, track, or control access for this resource.