MDAA TS Docs
    Preparing search index...

    Interface MdaaDatazoneFormTypeProps

    interface MdaaDatazoneFormTypeProps {
        createOutputs?: boolean;
        createParams?: boolean;
        description?: string;
        domainIdentifier: string;
        fields: { [fieldName: string]: FormFieldProps };
        formName: string;
        handlerRole: IRole;
        naming: IMdaaResourceNaming;
        owningProjectIdentifier: string;
        status?: "DISABLED" | "ENABLED";
    }

    Hierarchy (View Summary)

    Index

    Properties

    createOutputs? createParams? description? domainIdentifier fields formName handlerRole naming owningProjectIdentifier status?

    Properties

    createOutputs?: boolean

    Flag controlling CloudFormation output and stack export creation for construct resources

    createParams?: boolean

    Flag controlling SSM parameter creation for construct resource references enabling

    description?: string

    Human-readable description of the form type.

    - no description
    domainIdentifier: string

    The DataZone (SMUS) domain ID in which the form type is created. Passed as the CreateFormType domainIdentifier and used to derive the Smithy model namespace (the lambda replaces hyphens with underscores, which Smithy namespaces require).

    fields: { [fieldName: string]: FormFieldProps }

    Field definitions for the form. Each entry becomes a member of the generated Smithy structure. Declaration order is preserved.

    formName: string

    The form type name. Must be a valid Smithy structure name and is used verbatim as both the CreateFormType name and the generated structure <name>. MDAA naming prefixes are intentionally NOT applied — the service requires the name to match the structure declared in the model.

    handlerRole: IRole

    IAM role used to create the form type via the DataZone API. DataZone requires the CreateFormType caller to be an owner/member of the owning project, which the default CloudFormation execution role is not. This role must be a PROJECT_OWNER of owningProjectIdentifier — the domain custom-resource role (which MDAA already makes a project owner) satisfies this.

    naming: IMdaaResourceNaming

    MDAA naming implementation for consistent resource naming across all MDAA constructs

    owningProjectIdentifier: string

    The DataZone project ID that owns the form type. Form types are always owned by a project even though they are usable across the domain.

    status?: "DISABLED" | "ENABLED"

    Form type status.

    ENABLED

    Settings

    Member Visibility

    On This Page

    Properties