Skip to content

WarningDetail

Source code in docs_src/capo_cloudformation/types/warning_detail.py
class WarningDetail(TypedDict, closed=True):
    type: NotRequired["capo_cloudformation.types.warning_type.WarningType"]
    """<p>The type of this warning. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/generate-IaC-write-only-properties.html">Resolve write-only properties</a> in the <i>CloudFormation User Guide</i>.</p> <ul> <li> <p> <code>MUTUALLY_EXCLUSIVE_PROPERTIES</code> - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix <code>OneOf</code> and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.</p> </li> <li> <p> <code>UNSUPPORTED_PROPERTIES</code> - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.</p> </li> <li> <p> <code>MUTUALLY_EXCLUSIVE_TYPES</code> - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.</p> </li> </ul> <note> <p>Currently the resource and property reference documentation does not indicate if a property uses a type of <code>oneOf</code> or <code>anyOf</code>. You need to look at the resource provider schema.</p> </note>"""
    properties: NotRequired[
        "capo_cloudformation.types.warning_properties.WarningProperties"
    ]
    """<p>The properties of the resource that are impacted by this warning.</p>"""

properties instance-attribute

properties: NotRequired[WarningProperties]

The properties of the resource that are impacted by this warning.

type instance-attribute

type: NotRequired[WarningType]

The type of this warning. For more information, see Resolve write-only properties in the CloudFormation User Guide.

  • MUTUALLY_EXCLUSIVE_PROPERTIES - The resource requires mutually-exclusive write-only properties. The IaC generator selects one set of mutually exclusive properties and converts the included properties into parameters. The parameter names have a suffix OneOf and the parameter descriptions indicate that the corresponding property can be replaced with other exclusive properties.

  • UNSUPPORTED_PROPERTIES - Unsupported properties are present in the resource. One example of unsupported properties would be a required write-only property that is an array, because a parameter cannot be an array. Another example is an optional write-only property.

  • MUTUALLY_EXCLUSIVE_TYPES - One or more required write-only properties are found in the resource, and the type of that property can be any of several types.

Currently the resource and property reference documentation does not indicate if a property uses a type of oneOf or anyOf. You need to look at the resource provider schema.