CfnFieldPropsMixin

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

Bases: Mixin

Creates a field in the Cases domain.

This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cases-field.html
CloudformationResource:: AWS::Cases::Field
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_field_props_mixin = cases_mixins.CfnFieldPropsMixin(cases_mixins.CfnFieldMixinProps(
    attributes=cases_mixins.CfnFieldPropsMixin.FieldAttributesProperty(
        text=cases_mixins.CfnFieldPropsMixin.TextAttributesProperty(
            is_multiline=False
        )
    ),
    description="description",
    domain_id="domainId",
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    type="type"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnFieldMixinProps, 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:: None

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['attributes', 'description', 'domainId', 'name', 'tags', 'type']

Static Methods

classmethod is_mixin(x)

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.

FieldAttributesProperty

class CfnFieldPropsMixin.FieldAttributesProperty(*, text=None)

Bases: object

Union of field attributes.

Parameters:: text (Union[IResolvable, TextAttributesProperty, Dict[str, Any], None]) – Field attributes for Text field type.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-field-fieldattributes.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_attributes_property = cases_mixins.CfnFieldPropsMixin.FieldAttributesProperty(
    text=cases_mixins.CfnFieldPropsMixin.TextAttributesProperty(
        is_multiline=False
    )
)

Attributes

text

Field attributes for Text field type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-field-fieldattributes.html#cfn-cases-field-fieldattributes-text

TextAttributesProperty

class CfnFieldPropsMixin.TextAttributesProperty(*, is_multiline=None)

Bases: object

Field attributes for Text field type.

Parameters:: is_multiline (Union[bool, IResolvable, None]) – Attribute that defines rendering component and validation.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-field-textattributes.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

text_attributes_property = cases_mixins.CfnFieldPropsMixin.TextAttributesProperty(
    is_multiline=False
)

Attributes

is_multiline

Attribute that defines rendering component and validation.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cases-field-textattributes.html#cfn-cases-field-textattributes-ismultiline