Package software.amazon.awscdk.services.cases

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.cases.CfnDomain
All Implemented Interfaces:
IInspectable, IDomainRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-09T10:20:13.549Z") @Stability(Stable) public class CfnDomain extends CfnResource implements IInspectable, IDomainRef, ITaggableV2
Creates a domain, which is a container for all case data, such as cases, fields, templates and layouts.

Each Amazon Connect instance can be associated with only one Cases domain.

This will not associate your connect instance to Cases domain. Instead, use the Amazon Connect CreateIntegrationAssociation API. You need specific IAM permissions to successfully associate the Cases domain. For more information, see Onboard to Cases .

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.cases.*;
 CfnDomain cfnDomain = CfnDomain.Builder.create(this, "MyCfnDomain")
         .name("name")
         // the properties below are optional
         .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::Cases::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.

    • 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.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The timestamp when the Cases domain was created.

    • getAttrDomainArn

      @Stability(Stable) @NotNull public String getAttrDomainArn()
      The Amazon Resource Name (ARN) for the Cases domain.

    • getAttrDomainId

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

    • getAttrDomainStatus

      @Stability(Stable) @NotNull public String getAttrDomainStatus()
      The status of the Cases domain.

    • getCdkTagManager

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

    • 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

    • getName

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

    • setName

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

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.