CfnLayoutPropsMixin

class aws_cdk.mixins_preview.aws_cases.mixins.CfnLayoutPropsMixin(props, *, strategy=None)

Bases: Mixin

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.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-layout.html
CloudformationResource:: AWS::Cases::Layout
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

cfn_layout_props_mixin = cases_mixins.CfnLayoutPropsMixin(cases_mixins.CfnLayoutMixinProps(
    content=cases_mixins.CfnLayoutPropsMixin.LayoutContentProperty(
        basic=cases_mixins.CfnLayoutPropsMixin.BasicLayoutProperty(
            more_info=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
                sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
                    field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                        fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                            id="id"
                        )],
                        name="name"
                    )
                )]
            ),
            top_panel=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
                sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
                    field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                        fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                            id="id"
                        )],
                        name="name"
                    )
                )]
            )
        )
    ),
    domain_id="domainId",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Cases::Layout.

Parameters:

props (Union[CfnLayoutMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['content', 'domainId', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

BasicLayoutProperty

class CfnLayoutPropsMixin.BasicLayoutProperty(*, more_info=None, top_panel=None)

Bases: object

Content specific to BasicLayout type.

It configures fields in the top panel and More Info tab of agent application.

Parameters:

more_info (Union[IResolvable, LayoutSectionsProperty, Dict[str, Any], None]) – This represents sections in a tab of the page layout.
top_panel (Union[IResolvable, LayoutSectionsProperty, Dict[str, Any], None]) – This represents sections in a panel of the page layout.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-basiclayout.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

basic_layout_property = cases_mixins.CfnLayoutPropsMixin.BasicLayoutProperty(
    more_info=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
        sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
            field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                    id="id"
                )],
                name="name"
            )
        )]
    ),
    top_panel=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
        sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
            field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                    id="id"
                )],
                name="name"
            )
        )]
    )
)

Attributes

more_info

This represents sections in a tab of the page layout.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-basiclayout.html#cfn-cases-layout-basiclayout-moreinfo

top_panel

This represents sections in a panel of the page layout.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-basiclayout.html#cfn-cases-layout-basiclayout-toppanel

FieldGroupProperty

class CfnLayoutPropsMixin.FieldGroupProperty(*, fields=None, name=None)

Bases: object

Object for a group of fields and associated properties.

Parameters:

fields (Union[IResolvable, Sequence[Union[IResolvable, FieldItemProperty, Dict[str, Any]]], None]) – Represents an ordered list containing field related information.
name (Optional[str]) – Name of the field group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-fieldgroup.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

field_group_property = cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
    fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
        id="id"
    )],
    name="name"
)

Attributes

fields

Represents an ordered list containing field related information.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-fieldgroup.html#cfn-cases-layout-fieldgroup-fields

name

Name of the field group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-fieldgroup.html#cfn-cases-layout-fieldgroup-name

FieldItemProperty

class CfnLayoutPropsMixin.FieldItemProperty(*, id=None)

Bases: object

Object for field related information.

Parameters:: id (Optional[str]) – Unique identifier of a field.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-fielditem.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

field_item_property = cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
    id="id"
)

Attributes

id

Unique identifier of a field.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-fielditem.html#cfn-cases-layout-fielditem-id

LayoutContentProperty

class CfnLayoutPropsMixin.LayoutContentProperty(*, basic=None)

Bases: object

Object to store union of different versions of layout content.

Parameters:: basic (Union[IResolvable, BasicLayoutProperty, Dict[str, Any], None]) – Content specific to BasicLayout type. It configures fields in the top panel and More Info tab of agent application.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-layoutcontent.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

layout_content_property = cases_mixins.CfnLayoutPropsMixin.LayoutContentProperty(
    basic=cases_mixins.CfnLayoutPropsMixin.BasicLayoutProperty(
        more_info=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
            sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
                field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                    fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                        id="id"
                    )],
                    name="name"
                )
            )]
        ),
        top_panel=cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
            sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
                field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
                    fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                        id="id"
                    )],
                    name="name"
                )
            )]
        )
    )
)

Attributes

basic

Content specific to BasicLayout type.

It configures fields in the top panel and More Info tab of agent application.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-layoutcontent.html#cfn-cases-layout-layoutcontent-basic

LayoutSectionsProperty

class CfnLayoutPropsMixin.LayoutSectionsProperty(*, sections=None)

Bases: object

Ordered list containing different kinds of sections that can be added.

A LayoutSections object can only contain one section.

Parameters:: sections (Union[IResolvable, Sequence[Union[IResolvable, SectionProperty, Dict[str, Any]]], None]) – Ordered list containing different kinds of sections that can be added. A LayoutSections object can only contain one section.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-layoutsections.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

layout_sections_property = cases_mixins.CfnLayoutPropsMixin.LayoutSectionsProperty(
    sections=[cases_mixins.CfnLayoutPropsMixin.SectionProperty(
        field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
            fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
                id="id"
            )],
            name="name"
        )
    )]
)

Attributes

sections

Ordered list containing different kinds of sections that can be added.

A LayoutSections object can only contain one section.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-layoutsections.html#cfn-cases-layout-layoutsections-sections

SectionProperty

class CfnLayoutPropsMixin.SectionProperty(*, field_group=None)

Bases: object

This represents a sections within a panel or tab of the page layout.

Parameters:: field_group (Union[IResolvable, FieldGroupProperty, Dict[str, Any], None]) – Consists of a group of fields and associated properties.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-section.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_cases import mixins as cases_mixins

section_property = cases_mixins.CfnLayoutPropsMixin.SectionProperty(
    field_group=cases_mixins.CfnLayoutPropsMixin.FieldGroupProperty(
        fields=[cases_mixins.CfnLayoutPropsMixin.FieldItemProperty(
            id="id"
        )],
        name="name"
    )
)

Attributes

field_group

Consists of a group of fields and associated properties.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-layout-section.html#cfn-cases-layout-section-fieldgroup