Package software.amazon.awscdk.services.cases

Class CfnLayout

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.CfnLayout
All Implemented Interfaces:
IInspectable, ILayoutRef, 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.554Z") @Stability(Stable) public class CfnLayout extends CfnResource implements IInspectable, ILayoutRef, ITaggableV2
Creates a layout in the Cases domain.

Layouts define the following configuration in the top section and More Info tab of the Cases user interface:

  • Fields to display to the users
  • Field ordering

Title and Status fields cannot be part of layouts since they are not configurable.

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.*;
 CfnLayout cfnLayout = CfnLayout.Builder.create(this, "MyCfnLayout")
         .content(LayoutContentProperty.builder()
                 .basic(BasicLayoutProperty.builder()
                         .moreInfo(LayoutSectionsProperty.builder()
                                 .sections(List.of(SectionProperty.builder()
                                         .fieldGroup(FieldGroupProperty.builder()
                                                 .fields(List.of(FieldItemProperty.builder()
                                                         .id("id")
                                                         .build()))
                                                 // the properties below are optional
                                                 .name("name")
                                                 .build())
                                         .build()))
                                 .build())
                         .topPanel(LayoutSectionsProperty.builder()
                                 .sections(List.of(SectionProperty.builder()
                                         .fieldGroup(FieldGroupProperty.builder()
                                                 .fields(List.of(FieldItemProperty.builder()
                                                         .id("id")
                                                         .build()))
                                                 // the properties below are optional
                                                 .name("name")
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 .build())
         .name("name")
         // the properties below are optional
         .domainId("domainId")
         .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

    • CfnLayout

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

    • CfnLayout

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

    • CfnLayout

      @Stability(Stable) public CfnLayout(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLayoutProps props)
      Create a new AWS::Cases::Layout.

      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

    • arnForLayout

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

    • isCfnLayout

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

      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()
      Timestamp at which the resource was created.

    • getAttrLastModifiedTime

      @Stability(Stable) @NotNull public String getAttrLastModifiedTime()
      Timestamp at which the resource was created or last modified.

    • getAttrLayoutArn

      @Stability(Stable) @NotNull public String getAttrLayoutArn()
      The Amazon Resource Name (ARN) of the newly created layout.

    • getAttrLayoutId

      @Stability(Stable) @NotNull public String getAttrLayoutId()
      The unique identifier of the layout.

    • 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

    • getLayoutRef

      @Stability(Stable) @NotNull public LayoutReference getLayoutRef()
      A reference to a Layout resource.
      Specified by:
      getLayoutRef in interface ILayoutRef

    • getContent

      @Stability(Stable) @NotNull public Object getContent()
      Object to store union of different versions of layout content.

      Returns union: either IResolvable or CfnLayout.LayoutContentProperty

    • setContent

      @Stability(Stable) public void setContent(@NotNull IResolvable value)
      Object to store union of different versions of layout content.

    • setContent

      @Stability(Stable) public void setContent(@NotNull CfnLayout.LayoutContentProperty value)
      Object to store union of different versions of layout content.

    • getName

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

    • setName

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

    • getDomainId

      @Stability(Stable) @Nullable public String getDomainId()
      The unique identifier of the Cases domain.

    • setDomainId

      @Stability(Stable) public void setDomainId(@Nullable String value)
      The unique identifier of the Cases 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.