MDAA TS Docs
    Preparing search index...

    Interface ProjectEnvironmentConfiguration

    interface ProjectEnvironmentConfiguration {
        environmentId?: string;
        parameters?: { [name: string]: string };
    }
    Index

    Properties

    environmentId?: string

    ID of an already-provisioned DataZone environment to target for this configuration, in place of addressing it by its configuration name. Required once the environment exists, since DataZone rejects an update that still addresses it by configuration name alone.

    The first deploy that creates this entry also resolves the environment's live ID and publishes it to an SSM parameter at <naming.ssmPath>/project/<name>-env-<configKey>/environment-id, within a short retry budget - best-effort, and a one-time attempt: the underlying custom resource has no way to tell CloudFormation to invoke it again on a later deploy, since none of its own properties change between deploys. If the environment is still provisioning once that budget runs out (environments commonly take several minutes), the parameter is left holding a placeholder (UNRESOLVED) rather than a real ID, permanently, until something else (e.g. a config change prompting the resource to run again) causes a re-resolution. Check the parameter's actual value - or look the ID up directly via aws datazone list-environments - before pointing this property at it with an ssm:<path> config value. Leave unset for first-time environment provisioning.

    Use cases: Updating environment parameters, or making any other change (including nameOverride), on an already-deployed project whose environments are ACTIVE

    AWS: AWS::DataZone::Project UserParameters EnvironmentId

    Validation: Optional; leave unset for first-time environment provisioning, where environmentConfigurationName is required instead. Find the value via the DataZone/SMUS console, aws datazone list-environments, or the published SSM parameter described above.

    parameters?: { [name: string]: string }