@codedrifters/configulator 0.0.318 → 0.0.320
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/index.d.mts +1700 -1
- package/lib/index.d.ts +1701 -2
- package/lib/index.js +926 -76
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +851 -41
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
package/lib/index.d.mts
CHANGED
|
@@ -6787,6 +6787,1201 @@ declare class AstroConfig extends Component {
|
|
|
6787
6787
|
private synthesizeConfig;
|
|
6788
6788
|
}
|
|
6789
6789
|
|
|
6790
|
+
/*******************************************************************************
|
|
6791
|
+
*
|
|
6792
|
+
* AWS CDK CLI Enums
|
|
6793
|
+
*
|
|
6794
|
+
* `as const` enums for the `cdk` CLI surface. Phase 1 covered `cdk deploy`;
|
|
6795
|
+
* Phase 2 adds the enum needed by `cdk diff`; Phase 3 adds the enums needed by
|
|
6796
|
+
* `cdk gc`; Phase 4 adds the enums needed by `cdk init` (and reused by `cdk
|
|
6797
|
+
* migrate`).
|
|
6798
|
+
*
|
|
6799
|
+
******************************************************************************/
|
|
6800
|
+
/**
|
|
6801
|
+
* `--require-approval` values accepted by `cdk deploy`.
|
|
6802
|
+
*/
|
|
6803
|
+
declare const CDK_REQUIRE_APPROVAL: {
|
|
6804
|
+
readonly Never: "never";
|
|
6805
|
+
readonly AnyChange: "any-change";
|
|
6806
|
+
readonly Broadening: "broadening";
|
|
6807
|
+
};
|
|
6808
|
+
/**
|
|
6809
|
+
* Type for {@link CDK_REQUIRE_APPROVAL} values.
|
|
6810
|
+
*/
|
|
6811
|
+
type CdkRequireApproval = (typeof CDK_REQUIRE_APPROVAL)[keyof typeof CDK_REQUIRE_APPROVAL];
|
|
6812
|
+
/**
|
|
6813
|
+
* `--method` values accepted by `cdk deploy`.
|
|
6814
|
+
*/
|
|
6815
|
+
declare const CDK_DEPLOY_METHOD: {
|
|
6816
|
+
readonly ChangeSet: "change-set";
|
|
6817
|
+
readonly Direct: "direct";
|
|
6818
|
+
readonly PrepareChangeSet: "prepare-change-set";
|
|
6819
|
+
readonly ExecuteChangeSet: "execute-change-set";
|
|
6820
|
+
};
|
|
6821
|
+
/**
|
|
6822
|
+
* Type for {@link CDK_DEPLOY_METHOD} values.
|
|
6823
|
+
*/
|
|
6824
|
+
type CdkDeployMethod = (typeof CDK_DEPLOY_METHOD)[keyof typeof CDK_DEPLOY_METHOD];
|
|
6825
|
+
/**
|
|
6826
|
+
* `--progress` values accepted by `cdk deploy`.
|
|
6827
|
+
*/
|
|
6828
|
+
declare const CDK_PROGRESS: {
|
|
6829
|
+
readonly Bar: "bar";
|
|
6830
|
+
readonly Events: "events";
|
|
6831
|
+
};
|
|
6832
|
+
/**
|
|
6833
|
+
* Type for {@link CDK_PROGRESS} values.
|
|
6834
|
+
*/
|
|
6835
|
+
type CdkProgress = (typeof CDK_PROGRESS)[keyof typeof CDK_PROGRESS];
|
|
6836
|
+
/**
|
|
6837
|
+
* `--method` values accepted by `cdk diff`.
|
|
6838
|
+
*/
|
|
6839
|
+
declare const CDK_DIFF_METHOD: {
|
|
6840
|
+
readonly Auto: "auto";
|
|
6841
|
+
readonly ChangeSet: "change-set";
|
|
6842
|
+
readonly Template: "template";
|
|
6843
|
+
};
|
|
6844
|
+
/**
|
|
6845
|
+
* Type for {@link CDK_DIFF_METHOD} values.
|
|
6846
|
+
*/
|
|
6847
|
+
type CdkDiffMethod = (typeof CDK_DIFF_METHOD)[keyof typeof CDK_DIFF_METHOD];
|
|
6848
|
+
/**
|
|
6849
|
+
* `--action` values accepted by `cdk gc`.
|
|
6850
|
+
*/
|
|
6851
|
+
declare const CDK_GC_ACTION: {
|
|
6852
|
+
readonly DeleteTagged: "delete-tagged";
|
|
6853
|
+
readonly Full: "full";
|
|
6854
|
+
readonly Print: "print";
|
|
6855
|
+
readonly Tag: "tag";
|
|
6856
|
+
};
|
|
6857
|
+
/**
|
|
6858
|
+
* Type for {@link CDK_GC_ACTION} values.
|
|
6859
|
+
*/
|
|
6860
|
+
type CdkGcAction = (typeof CDK_GC_ACTION)[keyof typeof CDK_GC_ACTION];
|
|
6861
|
+
/**
|
|
6862
|
+
* `--type` values accepted by `cdk gc`.
|
|
6863
|
+
*/
|
|
6864
|
+
declare const CDK_GC_TYPE: {
|
|
6865
|
+
readonly All: "all";
|
|
6866
|
+
readonly Ecr: "ecr";
|
|
6867
|
+
readonly S3: "s3";
|
|
6868
|
+
};
|
|
6869
|
+
/**
|
|
6870
|
+
* Type for {@link CDK_GC_TYPE} values.
|
|
6871
|
+
*/
|
|
6872
|
+
type CdkGcType = (typeof CDK_GC_TYPE)[keyof typeof CDK_GC_TYPE];
|
|
6873
|
+
/**
|
|
6874
|
+
* Positional `<template>` values accepted by `cdk init`.
|
|
6875
|
+
*/
|
|
6876
|
+
declare const CDK_INIT_TEMPLATE: {
|
|
6877
|
+
readonly App: "app";
|
|
6878
|
+
readonly Lib: "lib";
|
|
6879
|
+
readonly SampleApp: "sample-app";
|
|
6880
|
+
};
|
|
6881
|
+
/**
|
|
6882
|
+
* Type for {@link CDK_INIT_TEMPLATE} values.
|
|
6883
|
+
*/
|
|
6884
|
+
type CdkInitTemplate = (typeof CDK_INIT_TEMPLATE)[keyof typeof CDK_INIT_TEMPLATE];
|
|
6885
|
+
/**
|
|
6886
|
+
* `--language` values accepted by `cdk init`. Also reused by `cdk migrate`'s
|
|
6887
|
+
* `--language` flag, which accepts the same set of language identifiers.
|
|
6888
|
+
*/
|
|
6889
|
+
declare const CDK_INIT_LANGUAGE: {
|
|
6890
|
+
readonly CSharp: "csharp";
|
|
6891
|
+
readonly FSharp: "fsharp";
|
|
6892
|
+
readonly Go: "go";
|
|
6893
|
+
readonly Java: "java";
|
|
6894
|
+
readonly JavaScript: "javascript";
|
|
6895
|
+
readonly Python: "python";
|
|
6896
|
+
readonly TypeScript: "typescript";
|
|
6897
|
+
};
|
|
6898
|
+
/**
|
|
6899
|
+
* Type for {@link CDK_INIT_LANGUAGE} values.
|
|
6900
|
+
*/
|
|
6901
|
+
type CdkInitLanguage = (typeof CDK_INIT_LANGUAGE)[keyof typeof CDK_INIT_LANGUAGE];
|
|
6902
|
+
|
|
6903
|
+
/*******************************************************************************
|
|
6904
|
+
*
|
|
6905
|
+
* AWS CDK CLI Options
|
|
6906
|
+
*
|
|
6907
|
+
* Typed coverage of the `cdk` CLI surface. Phase 1 covered `deploy`; Phase 2
|
|
6908
|
+
* adds `synth`, `watch`, `destroy`, `diff`, `bootstrap`, and `list`; Phase 3
|
|
6909
|
+
* adds the maintenance / lifecycle commands `rollback`, `import`, `gc`,
|
|
6910
|
+
* `drift`, `refactor`, `publish-assets`, and `orphan`; Phase 4 adds the
|
|
6911
|
+
* inspection / scaffolding commands `init`, `migrate`, `context`, `metadata`,
|
|
6912
|
+
* `flags`, `acknowledge`, `notices`, `doctor`, and `docs`. Every
|
|
6913
|
+
* command-specific interface inherits {@link CdkGlobalOptions} so it carries
|
|
6914
|
+
* the same global flag surface.
|
|
6915
|
+
*
|
|
6916
|
+
* Every boolean field is tri-state (`boolean | undefined`):
|
|
6917
|
+
* - `undefined` → the renderer emits nothing, and the CLI's own default
|
|
6918
|
+
* applies.
|
|
6919
|
+
* - `true` → renders as `--flag`.
|
|
6920
|
+
* - `false` → renders as `--no-flag`.
|
|
6921
|
+
*
|
|
6922
|
+
******************************************************************************/
|
|
6923
|
+
/**
|
|
6924
|
+
* Global CLI flags accepted by every `cdk` subcommand. Command-specific option
|
|
6925
|
+
* interfaces extend this base so the global flag surface stays in lock-step
|
|
6926
|
+
* across commands.
|
|
6927
|
+
*/
|
|
6928
|
+
interface CdkGlobalOptions {
|
|
6929
|
+
/*****************************************************************************
|
|
6930
|
+
*
|
|
6931
|
+
* Global CLI flags
|
|
6932
|
+
*
|
|
6933
|
+
****************************************************************************/
|
|
6934
|
+
/**
|
|
6935
|
+
* `--app` — path to the CDK cloud assembly (or the synth command).
|
|
6936
|
+
*/
|
|
6937
|
+
readonly app?: string;
|
|
6938
|
+
/**
|
|
6939
|
+
* `--profile` — named AWS profile from `~/.aws/credentials`.
|
|
6940
|
+
*/
|
|
6941
|
+
readonly profile?: string;
|
|
6942
|
+
/**
|
|
6943
|
+
* `--lookups` — whether the CLI may perform context lookups against the
|
|
6944
|
+
* target environment.
|
|
6945
|
+
*/
|
|
6946
|
+
readonly lookups?: boolean;
|
|
6947
|
+
/**
|
|
6948
|
+
* `--context` — CDK context values. Repeats one `--context` flag per
|
|
6949
|
+
* `KEY=VALUE` entry.
|
|
6950
|
+
*/
|
|
6951
|
+
readonly context?: Record<string, string>;
|
|
6952
|
+
/**
|
|
6953
|
+
* `--output` — directory to read the cloud assembly from.
|
|
6954
|
+
*/
|
|
6955
|
+
readonly output?: string;
|
|
6956
|
+
/**
|
|
6957
|
+
* `--verbose` (`-v`) — verbosity level. The renderer emits `-v` repeated N
|
|
6958
|
+
* times.
|
|
6959
|
+
*/
|
|
6960
|
+
readonly verbose?: number;
|
|
6961
|
+
/**
|
|
6962
|
+
* `--debug` — enable debug output.
|
|
6963
|
+
*/
|
|
6964
|
+
readonly debug?: boolean;
|
|
6965
|
+
/**
|
|
6966
|
+
* `--ci` — non-interactive CI mode.
|
|
6967
|
+
*/
|
|
6968
|
+
readonly ci?: boolean;
|
|
6969
|
+
/**
|
|
6970
|
+
* `--yes` — auto-confirm prompts.
|
|
6971
|
+
*/
|
|
6972
|
+
readonly yes?: boolean;
|
|
6973
|
+
/**
|
|
6974
|
+
* `--role-arn` — IAM role to assume for CloudFormation deployments.
|
|
6975
|
+
*/
|
|
6976
|
+
readonly roleArn?: string;
|
|
6977
|
+
/**
|
|
6978
|
+
* `--proxy` — HTTP/HTTPS proxy URL.
|
|
6979
|
+
*/
|
|
6980
|
+
readonly proxy?: string;
|
|
6981
|
+
/**
|
|
6982
|
+
* `--ca-bundle-path` — path to a CA bundle for TLS verification.
|
|
6983
|
+
*/
|
|
6984
|
+
readonly caBundlePath?: string;
|
|
6985
|
+
/**
|
|
6986
|
+
* `--ec2creds` — force the SDK to obtain credentials from the EC2 instance
|
|
6987
|
+
* metadata service.
|
|
6988
|
+
*/
|
|
6989
|
+
readonly ec2creds?: boolean;
|
|
6990
|
+
/**
|
|
6991
|
+
* `--version-reporting` — include CDK library version reporting in the
|
|
6992
|
+
* synthesised template metadata.
|
|
6993
|
+
*/
|
|
6994
|
+
readonly versionReporting?: boolean;
|
|
6995
|
+
/**
|
|
6996
|
+
* `--path-metadata` — include path metadata in the synthesised template.
|
|
6997
|
+
*/
|
|
6998
|
+
readonly pathMetadata?: boolean;
|
|
6999
|
+
/**
|
|
7000
|
+
* `--asset-metadata` — include asset metadata in the synthesised template.
|
|
7001
|
+
*/
|
|
7002
|
+
readonly assetMetadata?: boolean;
|
|
7003
|
+
/**
|
|
7004
|
+
* `--staging` — copy assets to `cdk.out` for staging.
|
|
7005
|
+
*/
|
|
7006
|
+
readonly staging?: boolean;
|
|
7007
|
+
/**
|
|
7008
|
+
* `--notices` — show CDK notices.
|
|
7009
|
+
*/
|
|
7010
|
+
readonly notices?: boolean;
|
|
7011
|
+
/**
|
|
7012
|
+
* `--color` — force-enable coloured output.
|
|
7013
|
+
*/
|
|
7014
|
+
readonly color?: boolean;
|
|
7015
|
+
/**
|
|
7016
|
+
* `--no-color` — disable coloured output.
|
|
7017
|
+
*/
|
|
7018
|
+
readonly noColor?: boolean;
|
|
7019
|
+
/**
|
|
7020
|
+
* `--unstable` — opt into named unstable CLI features. Repeats one
|
|
7021
|
+
* `--unstable` flag per entry.
|
|
7022
|
+
*/
|
|
7023
|
+
readonly unstable?: Array<string>;
|
|
7024
|
+
/**
|
|
7025
|
+
* `--telemetry-file` — write CDK telemetry to the given path.
|
|
7026
|
+
*/
|
|
7027
|
+
readonly telemetryFile?: string;
|
|
7028
|
+
/**
|
|
7029
|
+
* `--trace` — print stack traces on errors.
|
|
7030
|
+
*/
|
|
7031
|
+
readonly trace?: boolean;
|
|
7032
|
+
/**
|
|
7033
|
+
* `--strict` — promote certain warnings to errors.
|
|
7034
|
+
*/
|
|
7035
|
+
readonly strict?: boolean;
|
|
7036
|
+
/**
|
|
7037
|
+
* `--ignore-errors` — proceed past non-fatal errors.
|
|
7038
|
+
*/
|
|
7039
|
+
readonly ignoreErrors?: boolean;
|
|
7040
|
+
/**
|
|
7041
|
+
* `--json` — emit JSON-formatted output.
|
|
7042
|
+
*/
|
|
7043
|
+
readonly json?: boolean;
|
|
7044
|
+
/**
|
|
7045
|
+
* `--plugin` — register one or more CDK CLI plugins. Repeats one `--plugin`
|
|
7046
|
+
* flag per entry.
|
|
7047
|
+
*/
|
|
7048
|
+
readonly plugin?: Array<string>;
|
|
7049
|
+
/**
|
|
7050
|
+
* `--build` — command to build the CDK app before deploy.
|
|
7051
|
+
*/
|
|
7052
|
+
readonly build?: string;
|
|
7053
|
+
/*****************************************************************************
|
|
7054
|
+
*
|
|
7055
|
+
* Trailing positional arguments
|
|
7056
|
+
*
|
|
7057
|
+
****************************************************************************/
|
|
7058
|
+
/**
|
|
7059
|
+
* Stack patterns passed as trailing positional arguments. Quoted by the
|
|
7060
|
+
* renderer to preserve glob characters across shells.
|
|
7061
|
+
*/
|
|
7062
|
+
readonly stackPatterns?: Array<string>;
|
|
7063
|
+
}
|
|
7064
|
+
/**
|
|
7065
|
+
* Options for the `cdk deploy` command.
|
|
7066
|
+
*/
|
|
7067
|
+
interface CdkDeployOptions extends CdkGlobalOptions {
|
|
7068
|
+
/*****************************************************************************
|
|
7069
|
+
*
|
|
7070
|
+
* Deploy-specific flags
|
|
7071
|
+
*
|
|
7072
|
+
****************************************************************************/
|
|
7073
|
+
/**
|
|
7074
|
+
* Deploy all stacks in the application.
|
|
7075
|
+
*/
|
|
7076
|
+
readonly all?: boolean;
|
|
7077
|
+
/**
|
|
7078
|
+
* `--require-approval` — when to prompt for security-related approvals.
|
|
7079
|
+
*/
|
|
7080
|
+
readonly requireApproval?: CdkRequireApproval;
|
|
7081
|
+
/**
|
|
7082
|
+
* `--rollback` / `--no-rollback` — roll back the stack on failure.
|
|
7083
|
+
*
|
|
7084
|
+
* Tri-state: `true` enables rollback, `false` disables it (useful in dev for
|
|
7085
|
+
* fast iteration), `undefined` defers to the CLI default.
|
|
7086
|
+
*/
|
|
7087
|
+
readonly rollback?: boolean;
|
|
7088
|
+
/**
|
|
7089
|
+
* `--hotswap` — apply changes directly to running resources without going
|
|
7090
|
+
* through CloudFormation when possible.
|
|
7091
|
+
*
|
|
7092
|
+
* @deprecated AWS recommends `--hotswap` strictly for development use; it
|
|
7093
|
+
* introduces drift relative to the deployed CloudFormation template and
|
|
7094
|
+
* should never be used in production deployments.
|
|
7095
|
+
*/
|
|
7096
|
+
readonly hotswap?: boolean;
|
|
7097
|
+
/**
|
|
7098
|
+
* `--hotswap-fallback` — fall back to a full CloudFormation deployment when a
|
|
7099
|
+
* hotswap is not possible.
|
|
7100
|
+
*/
|
|
7101
|
+
readonly hotswapFallback?: boolean;
|
|
7102
|
+
/**
|
|
7103
|
+
* `--method` — how the deployment is performed (change-set vs direct).
|
|
7104
|
+
*/
|
|
7105
|
+
readonly method?: CdkDeployMethod;
|
|
7106
|
+
/**
|
|
7107
|
+
* `--change-set-name` — name of the change set to create/execute.
|
|
7108
|
+
*/
|
|
7109
|
+
readonly changeSetName?: string;
|
|
7110
|
+
/**
|
|
7111
|
+
* `--force` — always deploy even if no changes are detected.
|
|
7112
|
+
*/
|
|
7113
|
+
readonly force?: boolean;
|
|
7114
|
+
/**
|
|
7115
|
+
* `--exclusively` — deploy only the requested stacks; do not include
|
|
7116
|
+
* dependencies.
|
|
7117
|
+
*/
|
|
7118
|
+
readonly exclusively?: boolean;
|
|
7119
|
+
/**
|
|
7120
|
+
* `--toolkit-stack-name` — name of the CDK toolkit stack used as the
|
|
7121
|
+
* environment bootstrap.
|
|
7122
|
+
*/
|
|
7123
|
+
readonly toolkitStackName?: string;
|
|
7124
|
+
/**
|
|
7125
|
+
* `--parameters` — CloudFormation parameters to pass to the stack. Each
|
|
7126
|
+
* entry is a `KEY=VALUE` string. Repeats one `--parameters` flag per entry.
|
|
7127
|
+
*/
|
|
7128
|
+
readonly parameters?: Array<string>;
|
|
7129
|
+
/**
|
|
7130
|
+
* `--outputs-file` — write CloudFormation outputs to a JSON file at the
|
|
7131
|
+
* given path.
|
|
7132
|
+
*/
|
|
7133
|
+
readonly outputsFile?: string;
|
|
7134
|
+
/**
|
|
7135
|
+
* `--previous-parameters` — use previous parameter values for any parameters
|
|
7136
|
+
* not explicitly supplied.
|
|
7137
|
+
*/
|
|
7138
|
+
readonly previousParameters?: boolean;
|
|
7139
|
+
/**
|
|
7140
|
+
* `--concurrency` — number of stacks to deploy in parallel.
|
|
7141
|
+
*/
|
|
7142
|
+
readonly concurrency?: number;
|
|
7143
|
+
/**
|
|
7144
|
+
* `--asset-parallelism` — upload assets in parallel.
|
|
7145
|
+
*/
|
|
7146
|
+
readonly assetParallelism?: boolean;
|
|
7147
|
+
/**
|
|
7148
|
+
* `--asset-prebuild` — pre-build assets before deploying.
|
|
7149
|
+
*/
|
|
7150
|
+
readonly assetPrebuild?: boolean;
|
|
7151
|
+
/**
|
|
7152
|
+
* `--watch` — continue watching for changes after the initial deploy.
|
|
7153
|
+
*/
|
|
7154
|
+
readonly watch?: boolean;
|
|
7155
|
+
/**
|
|
7156
|
+
* `--logs` — stream CloudWatch logs for resources updated by the deploy.
|
|
7157
|
+
*/
|
|
7158
|
+
readonly logs?: boolean;
|
|
7159
|
+
/**
|
|
7160
|
+
* `--build-exclude` — names of asset bundlers/build steps to skip. Repeats
|
|
7161
|
+
* one `--build-exclude` flag per entry.
|
|
7162
|
+
*/
|
|
7163
|
+
readonly buildExclude?: Array<string>;
|
|
7164
|
+
/**
|
|
7165
|
+
* `--notification-arns` — SNS topic ARNs to notify on stack events. Repeats
|
|
7166
|
+
* one `--notification-arns` flag per entry.
|
|
7167
|
+
*/
|
|
7168
|
+
readonly notificationArns?: Array<string>;
|
|
7169
|
+
/**
|
|
7170
|
+
* `--tags` — tags to apply to all stack resources. Repeats one `--tags` flag
|
|
7171
|
+
* per `KEY=VALUE` entry.
|
|
7172
|
+
*
|
|
7173
|
+
* @deprecated Tag declarations belong in the cloud assembly via
|
|
7174
|
+
* `Tags.of(scope).add(...)` rather than the CLI. The flag is modelled for
|
|
7175
|
+
* completeness, but consumers should prefer in-stack tagging.
|
|
7176
|
+
*/
|
|
7177
|
+
readonly tags?: Record<string, string>;
|
|
7178
|
+
/**
|
|
7179
|
+
* `--progress` — progress reporting style.
|
|
7180
|
+
*/
|
|
7181
|
+
readonly progress?: CdkProgress;
|
|
7182
|
+
/**
|
|
7183
|
+
* `--ignore-no-stacks` — succeed (with a warning) when no stacks match the
|
|
7184
|
+
* supplied pattern.
|
|
7185
|
+
*/
|
|
7186
|
+
readonly ignoreNoStacks?: boolean;
|
|
7187
|
+
/**
|
|
7188
|
+
* `--import-existing-resources` — generate a change set that imports
|
|
7189
|
+
* existing AWS resources into the stack.
|
|
7190
|
+
*/
|
|
7191
|
+
readonly importExistingResources?: boolean;
|
|
7192
|
+
/**
|
|
7193
|
+
* `--revert-drift` — revert any drift detected on the target stacks before
|
|
7194
|
+
* applying the new deployment.
|
|
7195
|
+
*/
|
|
7196
|
+
readonly revertDrift?: boolean;
|
|
7197
|
+
/**
|
|
7198
|
+
* `--execute` — execute the prepared change set immediately.
|
|
7199
|
+
*
|
|
7200
|
+
* @deprecated Replaced by `--method=prepare-change-set` and
|
|
7201
|
+
* `--method=execute-change-set`. Surfaced here only for completeness.
|
|
7202
|
+
*/
|
|
7203
|
+
readonly execute?: boolean;
|
|
7204
|
+
}
|
|
7205
|
+
/**
|
|
7206
|
+
* Options for the `cdk synth` command.
|
|
7207
|
+
*/
|
|
7208
|
+
interface CdkSynthOptions extends CdkGlobalOptions {
|
|
7209
|
+
/*****************************************************************************
|
|
7210
|
+
*
|
|
7211
|
+
* Synth-specific flags
|
|
7212
|
+
*
|
|
7213
|
+
****************************************************************************/
|
|
7214
|
+
/**
|
|
7215
|
+
* `--exclusively` — synthesize only the requested stacks; do not include
|
|
7216
|
+
* dependencies.
|
|
7217
|
+
*/
|
|
7218
|
+
readonly exclusively?: boolean;
|
|
7219
|
+
/**
|
|
7220
|
+
* `--quiet` (`-q`) — suppress the template output on stdout.
|
|
7221
|
+
*/
|
|
7222
|
+
readonly quiet?: boolean;
|
|
7223
|
+
/**
|
|
7224
|
+
* `--validation` — run additional cloud-assembly validation.
|
|
7225
|
+
*/
|
|
7226
|
+
readonly validation?: boolean;
|
|
7227
|
+
}
|
|
7228
|
+
/**
|
|
7229
|
+
* Options for the `cdk watch` command.
|
|
7230
|
+
*/
|
|
7231
|
+
interface CdkWatchOptions extends CdkGlobalOptions {
|
|
7232
|
+
/*****************************************************************************
|
|
7233
|
+
*
|
|
7234
|
+
* Watch-specific flags
|
|
7235
|
+
*
|
|
7236
|
+
****************************************************************************/
|
|
7237
|
+
/**
|
|
7238
|
+
* `--build-exclude` — names of asset bundlers/build steps to skip. Repeats
|
|
7239
|
+
* one `--build-exclude` flag per entry.
|
|
7240
|
+
*/
|
|
7241
|
+
readonly buildExclude?: Array<string>;
|
|
7242
|
+
/**
|
|
7243
|
+
* `--change-set-name` — name of the change set to create/execute.
|
|
7244
|
+
*/
|
|
7245
|
+
readonly changeSetName?: string;
|
|
7246
|
+
/**
|
|
7247
|
+
* `--concurrency` — number of stacks to deploy in parallel.
|
|
7248
|
+
*/
|
|
7249
|
+
readonly concurrency?: number;
|
|
7250
|
+
/**
|
|
7251
|
+
* `--exclusively` — deploy only the requested stacks; do not include
|
|
7252
|
+
* dependencies.
|
|
7253
|
+
*/
|
|
7254
|
+
readonly exclusively?: boolean;
|
|
7255
|
+
/**
|
|
7256
|
+
* `--force` — always deploy even if no changes are detected.
|
|
7257
|
+
*/
|
|
7258
|
+
readonly force?: boolean;
|
|
7259
|
+
/**
|
|
7260
|
+
* `--hotswap` — apply changes directly to running resources without going
|
|
7261
|
+
* through CloudFormation when possible. The CLI default for `cdk watch` is
|
|
7262
|
+
* `true`; supply `false` to disable.
|
|
7263
|
+
*/
|
|
7264
|
+
readonly hotswap?: boolean;
|
|
7265
|
+
/**
|
|
7266
|
+
* `--hotswap-fallback` — fall back to a full CloudFormation deployment when
|
|
7267
|
+
* a hotswap is not possible.
|
|
7268
|
+
*/
|
|
7269
|
+
readonly hotswapFallback?: boolean;
|
|
7270
|
+
/**
|
|
7271
|
+
* `--logs` — stream CloudWatch logs for resources updated by the deploy.
|
|
7272
|
+
*/
|
|
7273
|
+
readonly logs?: boolean;
|
|
7274
|
+
/**
|
|
7275
|
+
* `--progress` — progress reporting style.
|
|
7276
|
+
*/
|
|
7277
|
+
readonly progress?: CdkProgress;
|
|
7278
|
+
/**
|
|
7279
|
+
* `--rollback` / `--no-rollback` — roll back the stack on failure.
|
|
7280
|
+
*
|
|
7281
|
+
* Tri-state: `true` enables rollback, `false` disables it (useful in dev for
|
|
7282
|
+
* fast iteration), `undefined` defers to the CLI default.
|
|
7283
|
+
*/
|
|
7284
|
+
readonly rollback?: boolean;
|
|
7285
|
+
/**
|
|
7286
|
+
* `--toolkit-stack-name` — name of the CDK toolkit stack used as the
|
|
7287
|
+
* environment bootstrap.
|
|
7288
|
+
*/
|
|
7289
|
+
readonly toolkitStackName?: string;
|
|
7290
|
+
}
|
|
7291
|
+
/**
|
|
7292
|
+
* Options for the `cdk destroy` command.
|
|
7293
|
+
*/
|
|
7294
|
+
interface CdkDestroyOptions extends CdkGlobalOptions {
|
|
7295
|
+
/*****************************************************************************
|
|
7296
|
+
*
|
|
7297
|
+
* Destroy-specific flags
|
|
7298
|
+
*
|
|
7299
|
+
****************************************************************************/
|
|
7300
|
+
/**
|
|
7301
|
+
* `--all` — destroy all stacks in the application.
|
|
7302
|
+
*/
|
|
7303
|
+
readonly all?: boolean;
|
|
7304
|
+
/**
|
|
7305
|
+
* `--concurrency` — number of stacks to destroy in parallel.
|
|
7306
|
+
*/
|
|
7307
|
+
readonly concurrency?: number;
|
|
7308
|
+
/**
|
|
7309
|
+
* `--exclusively` — destroy only the requested stacks; do not include
|
|
7310
|
+
* dependencies.
|
|
7311
|
+
*/
|
|
7312
|
+
readonly exclusively?: boolean;
|
|
7313
|
+
/**
|
|
7314
|
+
* `--force` — skip the confirmation prompt before destroying.
|
|
7315
|
+
*/
|
|
7316
|
+
readonly force?: boolean;
|
|
7317
|
+
}
|
|
7318
|
+
/**
|
|
7319
|
+
* Options for the `cdk diff` command.
|
|
7320
|
+
*/
|
|
7321
|
+
interface CdkDiffOptions extends CdkGlobalOptions {
|
|
7322
|
+
/*****************************************************************************
|
|
7323
|
+
*
|
|
7324
|
+
* Diff-specific flags
|
|
7325
|
+
*
|
|
7326
|
+
****************************************************************************/
|
|
7327
|
+
/**
|
|
7328
|
+
* `--change-set` — use a CloudFormation change set to compute the diff.
|
|
7329
|
+
*
|
|
7330
|
+
* @deprecated Prefer the `--method` flag (e.g. `--method=change-set`).
|
|
7331
|
+
*/
|
|
7332
|
+
readonly changeSet?: boolean;
|
|
7333
|
+
/**
|
|
7334
|
+
* `--context-lines` — number of context lines to print around each change.
|
|
7335
|
+
*/
|
|
7336
|
+
readonly contextLines?: number;
|
|
7337
|
+
/**
|
|
7338
|
+
* `--exclusively` — diff only the requested stacks; do not include
|
|
7339
|
+
* dependencies.
|
|
7340
|
+
*/
|
|
7341
|
+
readonly exclusively?: boolean;
|
|
7342
|
+
/**
|
|
7343
|
+
* `--fail` — fail with a non-zero exit code when differences are detected.
|
|
7344
|
+
*/
|
|
7345
|
+
readonly fail?: boolean;
|
|
7346
|
+
/**
|
|
7347
|
+
* `--method` — how the diff is computed.
|
|
7348
|
+
*/
|
|
7349
|
+
readonly method?: CdkDiffMethod;
|
|
7350
|
+
/**
|
|
7351
|
+
* `--processed` — compare against the processed (CDK-augmented) template
|
|
7352
|
+
* rather than the raw user input.
|
|
7353
|
+
*/
|
|
7354
|
+
readonly processed?: boolean;
|
|
7355
|
+
/**
|
|
7356
|
+
* `--quiet` — suppress unchanged-resource output.
|
|
7357
|
+
*/
|
|
7358
|
+
readonly quiet?: boolean;
|
|
7359
|
+
/**
|
|
7360
|
+
* `--security-only` — restrict the diff to security-relevant changes only.
|
|
7361
|
+
*/
|
|
7362
|
+
readonly securityOnly?: boolean;
|
|
7363
|
+
/**
|
|
7364
|
+
* `--template` — diff against a specific template file path.
|
|
7365
|
+
*/
|
|
7366
|
+
readonly template?: string;
|
|
7367
|
+
}
|
|
7368
|
+
/**
|
|
7369
|
+
* Options for the `cdk bootstrap` command.
|
|
7370
|
+
*/
|
|
7371
|
+
interface CdkBootstrapOptions extends CdkGlobalOptions {
|
|
7372
|
+
/*****************************************************************************
|
|
7373
|
+
*
|
|
7374
|
+
* Bootstrap-specific flags
|
|
7375
|
+
*
|
|
7376
|
+
****************************************************************************/
|
|
7377
|
+
/**
|
|
7378
|
+
* `--bootstrap-bucket-name` / `--toolkit-bucket-name` — name of the S3
|
|
7379
|
+
* bucket used by the bootstrap stack to stage assets.
|
|
7380
|
+
*/
|
|
7381
|
+
readonly bootstrapBucketName?: string;
|
|
7382
|
+
/**
|
|
7383
|
+
* `--bootstrap-customer-key` — opt into a customer-managed KMS key for the
|
|
7384
|
+
* bootstrap bucket (creates the key as part of bootstrap).
|
|
7385
|
+
*/
|
|
7386
|
+
readonly bootstrapCustomerKey?: boolean;
|
|
7387
|
+
/**
|
|
7388
|
+
* `--bootstrap-kms-key-id` — supply an existing KMS key ID for the
|
|
7389
|
+
* bootstrap bucket.
|
|
7390
|
+
*/
|
|
7391
|
+
readonly bootstrapKmsKeyId?: string;
|
|
7392
|
+
/**
|
|
7393
|
+
* `--cloudformation-execution-policies` — managed-policy ARNs to attach to
|
|
7394
|
+
* the CloudFormation execution role. Repeats one
|
|
7395
|
+
* `--cloudformation-execution-policies` flag per entry.
|
|
7396
|
+
*/
|
|
7397
|
+
readonly cloudformationExecutionPolicies?: Array<string>;
|
|
7398
|
+
/**
|
|
7399
|
+
* `--custom-permissions-boundary` — name of an IAM permissions boundary to
|
|
7400
|
+
* attach to the bootstrap roles.
|
|
7401
|
+
*/
|
|
7402
|
+
readonly customPermissionsBoundary?: string;
|
|
7403
|
+
/**
|
|
7404
|
+
* `--example-permissions-boundary` — install the example permissions
|
|
7405
|
+
* boundary shipped with the CDK.
|
|
7406
|
+
*/
|
|
7407
|
+
readonly examplePermissionsBoundary?: boolean;
|
|
7408
|
+
/**
|
|
7409
|
+
* `--execute` — execute the bootstrap change set immediately.
|
|
7410
|
+
*/
|
|
7411
|
+
readonly execute?: boolean;
|
|
7412
|
+
/**
|
|
7413
|
+
* `--force` — force re-bootstrap even when the bootstrap stack is current.
|
|
7414
|
+
*/
|
|
7415
|
+
readonly force?: boolean;
|
|
7416
|
+
/**
|
|
7417
|
+
* `--previous-parameters` — use previous parameter values for any parameters
|
|
7418
|
+
* not explicitly supplied.
|
|
7419
|
+
*/
|
|
7420
|
+
readonly previousParameters?: boolean;
|
|
7421
|
+
/**
|
|
7422
|
+
* `--public-access-block-configuration` — enable S3 public access block on
|
|
7423
|
+
* the bootstrap bucket.
|
|
7424
|
+
*/
|
|
7425
|
+
readonly publicAccessBlockConfiguration?: boolean;
|
|
7426
|
+
/**
|
|
7427
|
+
* `--qualifier` — qualifier appended to bootstrap resource names so multiple
|
|
7428
|
+
* bootstraps can coexist in the same account/region.
|
|
7429
|
+
*/
|
|
7430
|
+
readonly qualifier?: string;
|
|
7431
|
+
/**
|
|
7432
|
+
* `--show-template` — emit the bootstrap template to stdout instead of
|
|
7433
|
+
* deploying it.
|
|
7434
|
+
*/
|
|
7435
|
+
readonly showTemplate?: boolean;
|
|
7436
|
+
/**
|
|
7437
|
+
* `--tags` — tags to apply to the bootstrap stack. Repeats one `--tags`
|
|
7438
|
+
* flag per `KEY=VALUE` entry.
|
|
7439
|
+
*/
|
|
7440
|
+
readonly tags?: Record<string, string>;
|
|
7441
|
+
/**
|
|
7442
|
+
* `--template` — bootstrap from a custom template file path.
|
|
7443
|
+
*/
|
|
7444
|
+
readonly template?: string;
|
|
7445
|
+
/**
|
|
7446
|
+
* `--termination-protection` — enable CloudFormation termination protection
|
|
7447
|
+
* on the bootstrap stack.
|
|
7448
|
+
*/
|
|
7449
|
+
readonly terminationProtection?: boolean;
|
|
7450
|
+
/**
|
|
7451
|
+
* `--toolkit-stack-name` — name of the CDK toolkit (bootstrap) stack.
|
|
7452
|
+
*/
|
|
7453
|
+
readonly toolkitStackName?: string;
|
|
7454
|
+
/**
|
|
7455
|
+
* `--trust` — AWS account IDs trusted to deploy into this bootstrap
|
|
7456
|
+
* environment. Repeats one `--trust` flag per entry.
|
|
7457
|
+
*/
|
|
7458
|
+
readonly trust?: Array<string>;
|
|
7459
|
+
/**
|
|
7460
|
+
* `--trust-for-lookup` — AWS account IDs trusted to perform context lookups
|
|
7461
|
+
* against this bootstrap environment. Repeats one `--trust-for-lookup` flag
|
|
7462
|
+
* per entry.
|
|
7463
|
+
*/
|
|
7464
|
+
readonly trustForLookup?: Array<string>;
|
|
7465
|
+
}
|
|
7466
|
+
/**
|
|
7467
|
+
* Options for the `cdk list` / `cdk ls` command.
|
|
7468
|
+
*/
|
|
7469
|
+
interface CdkListOptions extends CdkGlobalOptions {
|
|
7470
|
+
/*****************************************************************************
|
|
7471
|
+
*
|
|
7472
|
+
* List-specific flags
|
|
7473
|
+
*
|
|
7474
|
+
****************************************************************************/
|
|
7475
|
+
/**
|
|
7476
|
+
* `--long` — include extra columns (account, region, etc.) in the listing.
|
|
7477
|
+
*/
|
|
7478
|
+
readonly long?: boolean;
|
|
7479
|
+
/**
|
|
7480
|
+
* `--show-dependencies` — emit each stack's inter-stack dependencies.
|
|
7481
|
+
*/
|
|
7482
|
+
readonly showDependencies?: boolean;
|
|
7483
|
+
}
|
|
7484
|
+
/**
|
|
7485
|
+
* Options for the `cdk rollback` command.
|
|
7486
|
+
*/
|
|
7487
|
+
interface CdkRollbackOptions extends CdkGlobalOptions {
|
|
7488
|
+
/*****************************************************************************
|
|
7489
|
+
*
|
|
7490
|
+
* Rollback-specific flags
|
|
7491
|
+
*
|
|
7492
|
+
****************************************************************************/
|
|
7493
|
+
/**
|
|
7494
|
+
* `--all` — roll back every stack in the application.
|
|
7495
|
+
*/
|
|
7496
|
+
readonly all?: boolean;
|
|
7497
|
+
/**
|
|
7498
|
+
* `--force` — force the rollback even when CloudFormation reports the stack
|
|
7499
|
+
* is already in a stable state.
|
|
7500
|
+
*/
|
|
7501
|
+
readonly force?: boolean;
|
|
7502
|
+
/**
|
|
7503
|
+
* `--orphan` — logical IDs of resources to orphan (skip) during rollback.
|
|
7504
|
+
* Repeats one `--orphan` flag per entry.
|
|
7505
|
+
*/
|
|
7506
|
+
readonly orphan?: Array<string>;
|
|
7507
|
+
/**
|
|
7508
|
+
* `--toolkit-stack-name` — name of the CDK toolkit stack used as the
|
|
7509
|
+
* environment bootstrap.
|
|
7510
|
+
*/
|
|
7511
|
+
readonly toolkitStackName?: string;
|
|
7512
|
+
/**
|
|
7513
|
+
* `--validate-bootstrap-version` — require the bootstrap stack version on
|
|
7514
|
+
* the target environment to match the version the CLI was built against.
|
|
7515
|
+
*/
|
|
7516
|
+
readonly validateBootstrapVersion?: boolean;
|
|
7517
|
+
}
|
|
7518
|
+
/**
|
|
7519
|
+
* Options for the `cdk import` command.
|
|
7520
|
+
*/
|
|
7521
|
+
interface CdkImportOptions extends CdkGlobalOptions {
|
|
7522
|
+
/*****************************************************************************
|
|
7523
|
+
*
|
|
7524
|
+
* Import-specific flags
|
|
7525
|
+
*
|
|
7526
|
+
****************************************************************************/
|
|
7527
|
+
/**
|
|
7528
|
+
* `--change-set-name` — name of the import change set to create/execute.
|
|
7529
|
+
*/
|
|
7530
|
+
readonly changeSetName?: string;
|
|
7531
|
+
/**
|
|
7532
|
+
* `--execute` — execute the prepared import change set immediately.
|
|
7533
|
+
*/
|
|
7534
|
+
readonly execute?: boolean;
|
|
7535
|
+
/**
|
|
7536
|
+
* `--force` — proceed with the import even when CloudFormation warnings
|
|
7537
|
+
* would normally block it.
|
|
7538
|
+
*/
|
|
7539
|
+
readonly force?: boolean;
|
|
7540
|
+
/**
|
|
7541
|
+
* `--record-resource-mapping` — write the resolved logical-id → physical-id
|
|
7542
|
+
* mapping to the given path for later reuse.
|
|
7543
|
+
*/
|
|
7544
|
+
readonly recordResourceMapping?: string;
|
|
7545
|
+
/**
|
|
7546
|
+
* `--resource-mapping` — read the logical-id → physical-id mapping from the
|
|
7547
|
+
* given path instead of prompting interactively.
|
|
7548
|
+
*/
|
|
7549
|
+
readonly resourceMapping?: string;
|
|
7550
|
+
/**
|
|
7551
|
+
* `--rollback` / `--no-rollback` — roll back the stack on failure.
|
|
7552
|
+
*
|
|
7553
|
+
* Tri-state: `true` enables rollback, `false` disables it, `undefined`
|
|
7554
|
+
* defers to the CLI default.
|
|
7555
|
+
*/
|
|
7556
|
+
readonly rollback?: boolean;
|
|
7557
|
+
/**
|
|
7558
|
+
* `--toolkit-stack-name` — name of the CDK toolkit stack used as the
|
|
7559
|
+
* environment bootstrap.
|
|
7560
|
+
*/
|
|
7561
|
+
readonly toolkitStackName?: string;
|
|
7562
|
+
}
|
|
7563
|
+
/**
|
|
7564
|
+
* Options for the `cdk gc` command.
|
|
7565
|
+
*
|
|
7566
|
+
* `cdk gc` is gated behind the global `--unstable=gc` flag. Callers MUST
|
|
7567
|
+
* include `"gc"` in {@link CdkGlobalOptions.unstable} (modelled on this
|
|
7568
|
+
* interface as the inherited `unstable` field) for the CLI to accept the
|
|
7569
|
+
* command; the renderer surfaces `unstable` as a regular global flag and does
|
|
7570
|
+
* not validate the gate itself.
|
|
7571
|
+
*/
|
|
7572
|
+
interface CdkGcOptions extends CdkGlobalOptions {
|
|
7573
|
+
/*****************************************************************************
|
|
7574
|
+
*
|
|
7575
|
+
* GC-specific flags
|
|
7576
|
+
*
|
|
7577
|
+
****************************************************************************/
|
|
7578
|
+
/**
|
|
7579
|
+
* `--action` — which garbage-collection action to perform.
|
|
7580
|
+
*/
|
|
7581
|
+
readonly action?: CdkGcAction;
|
|
7582
|
+
/**
|
|
7583
|
+
* `--bootstrap-stack-name` — name of the bootstrap stack whose assets are
|
|
7584
|
+
* being garbage collected.
|
|
7585
|
+
*/
|
|
7586
|
+
readonly bootstrapStackName?: string;
|
|
7587
|
+
/**
|
|
7588
|
+
* `--confirm` / `--no-confirm` — prompt before deleting tagged assets.
|
|
7589
|
+
*/
|
|
7590
|
+
readonly confirm?: boolean;
|
|
7591
|
+
/**
|
|
7592
|
+
* `--created-buffer-days` — only consider assets created more than N days
|
|
7593
|
+
* ago for tagging.
|
|
7594
|
+
*/
|
|
7595
|
+
readonly createdBufferDays?: number;
|
|
7596
|
+
/**
|
|
7597
|
+
* `--rollback-buffer-days` — keep tagged assets for at least N days before
|
|
7598
|
+
* deleting them so a rollback can recover them.
|
|
7599
|
+
*/
|
|
7600
|
+
readonly rollbackBufferDays?: number;
|
|
7601
|
+
/**
|
|
7602
|
+
* `--type` — restrict garbage collection to a particular asset type.
|
|
7603
|
+
*/
|
|
7604
|
+
readonly type?: CdkGcType;
|
|
7605
|
+
}
|
|
7606
|
+
/**
|
|
7607
|
+
* Options for the `cdk drift` command.
|
|
7608
|
+
*/
|
|
7609
|
+
interface CdkDriftOptions extends CdkGlobalOptions {
|
|
7610
|
+
/*****************************************************************************
|
|
7611
|
+
*
|
|
7612
|
+
* Drift-specific flags
|
|
7613
|
+
*
|
|
7614
|
+
****************************************************************************/
|
|
7615
|
+
/**
|
|
7616
|
+
* `--fail` — exit with a non-zero status when drift is detected.
|
|
7617
|
+
*/
|
|
7618
|
+
readonly fail?: boolean;
|
|
7619
|
+
}
|
|
7620
|
+
/**
|
|
7621
|
+
* Options for the `cdk refactor` command.
|
|
7622
|
+
*/
|
|
7623
|
+
interface CdkRefactorOptions extends CdkGlobalOptions {
|
|
7624
|
+
/*****************************************************************************
|
|
7625
|
+
*
|
|
7626
|
+
* Refactor-specific flags
|
|
7627
|
+
*
|
|
7628
|
+
****************************************************************************/
|
|
7629
|
+
/**
|
|
7630
|
+
* `--additional-stack-name` — additional stack names to include in the
|
|
7631
|
+
* refactor scope. Repeats one `--additional-stack-name` flag per entry.
|
|
7632
|
+
*/
|
|
7633
|
+
readonly additionalStackName?: Array<string>;
|
|
7634
|
+
/**
|
|
7635
|
+
* `--dry-run` — preview the refactor plan without applying it.
|
|
7636
|
+
*/
|
|
7637
|
+
readonly dryRun?: boolean;
|
|
7638
|
+
/**
|
|
7639
|
+
* `--override-file` — path to a refactor override file that pins specific
|
|
7640
|
+
* resource moves.
|
|
7641
|
+
*/
|
|
7642
|
+
readonly overrideFile?: string;
|
|
7643
|
+
/**
|
|
7644
|
+
* `--revert` — apply the inverse of the refactor (undo a previous refactor
|
|
7645
|
+
* plan).
|
|
7646
|
+
*/
|
|
7647
|
+
readonly revert?: boolean;
|
|
7648
|
+
/**
|
|
7649
|
+
* `--force` — proceed even when the refactor planner would normally bail
|
|
7650
|
+
* out.
|
|
7651
|
+
*/
|
|
7652
|
+
readonly force?: boolean;
|
|
7653
|
+
}
|
|
7654
|
+
/**
|
|
7655
|
+
* Options for the `cdk publish-assets` command.
|
|
7656
|
+
*/
|
|
7657
|
+
interface CdkPublishAssetsOptions extends CdkGlobalOptions {
|
|
7658
|
+
/*****************************************************************************
|
|
7659
|
+
*
|
|
7660
|
+
* Publish-assets-specific flags
|
|
7661
|
+
*
|
|
7662
|
+
****************************************************************************/
|
|
7663
|
+
/**
|
|
7664
|
+
* `--all` — publish assets for every stack in the application.
|
|
7665
|
+
*/
|
|
7666
|
+
readonly all?: boolean;
|
|
7667
|
+
/**
|
|
7668
|
+
* `--exclusively` — publish only the requested stacks' assets; do not
|
|
7669
|
+
* include dependencies.
|
|
7670
|
+
*/
|
|
7671
|
+
readonly exclusively?: boolean;
|
|
7672
|
+
/**
|
|
7673
|
+
* `--force` — re-upload assets even when the target already has them.
|
|
7674
|
+
*/
|
|
7675
|
+
readonly force?: boolean;
|
|
7676
|
+
/**
|
|
7677
|
+
* `--concurrency` — number of asset uploads to run in parallel.
|
|
7678
|
+
*/
|
|
7679
|
+
readonly concurrency?: number;
|
|
7680
|
+
}
|
|
7681
|
+
/**
|
|
7682
|
+
* Options for the `cdk orphan` command.
|
|
7683
|
+
*
|
|
7684
|
+
* `cdk orphan` takes only positional `<logicalId>` arguments — there are no
|
|
7685
|
+
* command-specific flags beyond the inherited globals.
|
|
7686
|
+
*/
|
|
7687
|
+
interface CdkOrphanOptions extends CdkGlobalOptions {
|
|
7688
|
+
/*****************************************************************************
|
|
7689
|
+
*
|
|
7690
|
+
* Orphan-specific positional arguments
|
|
7691
|
+
*
|
|
7692
|
+
****************************************************************************/
|
|
7693
|
+
/**
|
|
7694
|
+
* Logical resource IDs to orphan. Rendered as quoted, space-separated
|
|
7695
|
+
* positional arguments after the command name.
|
|
7696
|
+
*/
|
|
7697
|
+
readonly logicalIds?: Array<string>;
|
|
7698
|
+
}
|
|
7699
|
+
/**
|
|
7700
|
+
* Options for the `cdk init` command.
|
|
7701
|
+
*
|
|
7702
|
+
* `cdk init` accepts a positional `<template>` argument and the
|
|
7703
|
+
* `--language` flag. Both are typed via the {@link CdkInitTemplate} and
|
|
7704
|
+
* {@link CdkInitLanguage} enums.
|
|
7705
|
+
*/
|
|
7706
|
+
interface CdkInitOptions extends CdkGlobalOptions {
|
|
7707
|
+
/*****************************************************************************
|
|
7708
|
+
*
|
|
7709
|
+
* Init-specific positional arguments
|
|
7710
|
+
*
|
|
7711
|
+
****************************************************************************/
|
|
7712
|
+
/**
|
|
7713
|
+
* Positional `<template>` argument — `app`, `lib`, or `sample-app`.
|
|
7714
|
+
* Rendered after the command name and any command-specific flags, before
|
|
7715
|
+
* the trailing tokens.
|
|
7716
|
+
*/
|
|
7717
|
+
readonly template?: CdkInitTemplate;
|
|
7718
|
+
/*****************************************************************************
|
|
7719
|
+
*
|
|
7720
|
+
* Init-specific flags
|
|
7721
|
+
*
|
|
7722
|
+
****************************************************************************/
|
|
7723
|
+
/**
|
|
7724
|
+
* `--language` — language to scaffold the new CDK project in.
|
|
7725
|
+
*/
|
|
7726
|
+
readonly language?: CdkInitLanguage;
|
|
7727
|
+
/**
|
|
7728
|
+
* `--list` — print the available templates and exit instead of
|
|
7729
|
+
* scaffolding.
|
|
7730
|
+
*/
|
|
7731
|
+
readonly list?: boolean;
|
|
7732
|
+
/**
|
|
7733
|
+
* `--generate-only` — generate the project files without performing
|
|
7734
|
+
* post-scaffold steps (e.g. `git init`, dependency install).
|
|
7735
|
+
*/
|
|
7736
|
+
readonly generateOnly?: boolean;
|
|
7737
|
+
}
|
|
7738
|
+
/**
|
|
7739
|
+
* Options for the `cdk migrate` command.
|
|
7740
|
+
*/
|
|
7741
|
+
interface CdkMigrateOptions extends CdkGlobalOptions {
|
|
7742
|
+
/*****************************************************************************
|
|
7743
|
+
*
|
|
7744
|
+
* Migrate-specific flags
|
|
7745
|
+
*
|
|
7746
|
+
****************************************************************************/
|
|
7747
|
+
/**
|
|
7748
|
+
* `--stack-name` — name of the CDK stack created from the migrated
|
|
7749
|
+
* resources.
|
|
7750
|
+
*/
|
|
7751
|
+
readonly stackName?: string;
|
|
7752
|
+
/**
|
|
7753
|
+
* `--language` — language to generate the migrated CDK app in. Reuses the
|
|
7754
|
+
* same enum as `cdk init`.
|
|
7755
|
+
*/
|
|
7756
|
+
readonly language?: CdkInitLanguage;
|
|
7757
|
+
/**
|
|
7758
|
+
* `--account` — AWS account ID hosting the source resources.
|
|
7759
|
+
*/
|
|
7760
|
+
readonly account?: string;
|
|
7761
|
+
/**
|
|
7762
|
+
* `--region` — AWS region hosting the source resources.
|
|
7763
|
+
*/
|
|
7764
|
+
readonly region?: string;
|
|
7765
|
+
/**
|
|
7766
|
+
* `--from-path` — path to a CloudFormation template file to migrate from.
|
|
7767
|
+
*/
|
|
7768
|
+
readonly fromPath?: string;
|
|
7769
|
+
/**
|
|
7770
|
+
* `--from-stack` — migrate from an existing CloudFormation stack by name.
|
|
7771
|
+
*/
|
|
7772
|
+
readonly fromStack?: boolean;
|
|
7773
|
+
/**
|
|
7774
|
+
* `--from-scan` — migrate by initiating a CloudFormation resource scan.
|
|
7775
|
+
*/
|
|
7776
|
+
readonly fromScan?: boolean;
|
|
7777
|
+
/**
|
|
7778
|
+
* `--output-path` — directory to write the generated CDK app into.
|
|
7779
|
+
*/
|
|
7780
|
+
readonly outputPath?: string;
|
|
7781
|
+
/**
|
|
7782
|
+
* `--filter` — resource filter expressions that narrow which resources
|
|
7783
|
+
* are included in the migration. Repeats one `--filter` flag per entry.
|
|
7784
|
+
*/
|
|
7785
|
+
readonly filter?: Array<string>;
|
|
7786
|
+
/**
|
|
7787
|
+
* `--compress` — compress the generated CDK app into a zip archive.
|
|
7788
|
+
*/
|
|
7789
|
+
readonly compress?: boolean;
|
|
7790
|
+
}
|
|
7791
|
+
/**
|
|
7792
|
+
* Options for the `cdk context` command.
|
|
7793
|
+
*/
|
|
7794
|
+
interface CdkContextOptions extends CdkGlobalOptions {
|
|
7795
|
+
/*****************************************************************************
|
|
7796
|
+
*
|
|
7797
|
+
* Context-specific flags
|
|
7798
|
+
*
|
|
7799
|
+
****************************************************************************/
|
|
7800
|
+
/**
|
|
7801
|
+
* `--clear` — clear all cached context values.
|
|
7802
|
+
*/
|
|
7803
|
+
readonly clear?: boolean;
|
|
7804
|
+
/**
|
|
7805
|
+
* `--force` — perform context operations without prompting.
|
|
7806
|
+
*/
|
|
7807
|
+
readonly force?: boolean;
|
|
7808
|
+
/**
|
|
7809
|
+
* `--reset=KEY` — clear a single cached context value by key. The CLI's
|
|
7810
|
+
* `--reset` flag is value-taking (it accepts the context key to reset),
|
|
7811
|
+
* so this field is typed as `string | undefined` rather than as a
|
|
7812
|
+
* tri-state boolean.
|
|
7813
|
+
*/
|
|
7814
|
+
readonly reset?: string;
|
|
7815
|
+
}
|
|
7816
|
+
/**
|
|
7817
|
+
* Options for the `cdk metadata` command.
|
|
7818
|
+
*
|
|
7819
|
+
* `cdk metadata` takes a single positional `<stack>` argument and has no
|
|
7820
|
+
* command-specific flags beyond the inherited globals.
|
|
7821
|
+
*/
|
|
7822
|
+
interface CdkMetadataOptions extends CdkGlobalOptions {
|
|
7823
|
+
/*****************************************************************************
|
|
7824
|
+
*
|
|
7825
|
+
* Metadata-specific positional arguments
|
|
7826
|
+
*
|
|
7827
|
+
****************************************************************************/
|
|
7828
|
+
/**
|
|
7829
|
+
* Positional `<stack>` argument naming the stack whose metadata to print.
|
|
7830
|
+
* Rendered after the command name and any command-specific flags, before
|
|
7831
|
+
* the trailing tokens.
|
|
7832
|
+
*/
|
|
7833
|
+
readonly stack?: string;
|
|
7834
|
+
}
|
|
7835
|
+
/**
|
|
7836
|
+
* Options for the `cdk flags` command.
|
|
7837
|
+
*/
|
|
7838
|
+
interface CdkFlagsOptions extends CdkGlobalOptions {
|
|
7839
|
+
/*****************************************************************************
|
|
7840
|
+
*
|
|
7841
|
+
* Flags-specific flags
|
|
7842
|
+
*
|
|
7843
|
+
****************************************************************************/
|
|
7844
|
+
/**
|
|
7845
|
+
* `--value=FLAG` — print the configured value of a single feature flag.
|
|
7846
|
+
* The CLI's `--value` flag is value-taking, so this field is typed as
|
|
7847
|
+
* `string | undefined`.
|
|
7848
|
+
*/
|
|
7849
|
+
readonly value?: string;
|
|
7850
|
+
/**
|
|
7851
|
+
* `--set=FLAG=VALUE` — set a feature flag to the given value. The CLI's
|
|
7852
|
+
* `--set` flag is value-taking, so this field is typed as
|
|
7853
|
+
* `string | undefined`.
|
|
7854
|
+
*/
|
|
7855
|
+
readonly set?: string;
|
|
7856
|
+
/**
|
|
7857
|
+
* `--all` — include every known feature flag in the output.
|
|
7858
|
+
*/
|
|
7859
|
+
readonly all?: boolean;
|
|
7860
|
+
/**
|
|
7861
|
+
* `--unconfigured` — include feature flags that have not been configured
|
|
7862
|
+
* yet.
|
|
7863
|
+
*/
|
|
7864
|
+
readonly unconfigured?: boolean;
|
|
7865
|
+
/**
|
|
7866
|
+
* `--recommended` — set feature flags to their recommended values.
|
|
7867
|
+
*/
|
|
7868
|
+
readonly recommended?: boolean;
|
|
7869
|
+
/**
|
|
7870
|
+
* `--default` — set feature flags to their default values.
|
|
7871
|
+
*/
|
|
7872
|
+
readonly default?: boolean;
|
|
7873
|
+
/**
|
|
7874
|
+
* `--interactive` — prompt interactively to confirm each flag change.
|
|
7875
|
+
*/
|
|
7876
|
+
readonly interactive?: boolean;
|
|
7877
|
+
/**
|
|
7878
|
+
* `--safe` — only apply changes that are safe (no resource replacement,
|
|
7879
|
+
* no destructive updates).
|
|
7880
|
+
*/
|
|
7881
|
+
readonly safe?: boolean;
|
|
7882
|
+
/**
|
|
7883
|
+
* `--concurrency` — number of concurrent operations to run when applying
|
|
7884
|
+
* flag changes.
|
|
7885
|
+
*/
|
|
7886
|
+
readonly concurrency?: number;
|
|
7887
|
+
}
|
|
7888
|
+
/**
|
|
7889
|
+
* Options for the `cdk acknowledge` (`ack`) command.
|
|
7890
|
+
*
|
|
7891
|
+
* `cdk acknowledge` takes a single positional `<id>` argument identifying
|
|
7892
|
+
* the notice to acknowledge. It has no command-specific flags beyond the
|
|
7893
|
+
* inherited globals.
|
|
7894
|
+
*/
|
|
7895
|
+
interface CdkAcknowledgeOptions extends CdkGlobalOptions {
|
|
7896
|
+
/*****************************************************************************
|
|
7897
|
+
*
|
|
7898
|
+
* Acknowledge-specific positional arguments
|
|
7899
|
+
*
|
|
7900
|
+
****************************************************************************/
|
|
7901
|
+
/**
|
|
7902
|
+
* Positional `<id>` argument — the notice ID to acknowledge. Rendered
|
|
7903
|
+
* after the command name and any command-specific flags, before the
|
|
7904
|
+
* trailing tokens.
|
|
7905
|
+
*/
|
|
7906
|
+
readonly id?: string;
|
|
7907
|
+
}
|
|
7908
|
+
/**
|
|
7909
|
+
* Options for the `cdk notices` command.
|
|
7910
|
+
*
|
|
7911
|
+
* `cdk notices` has no command-specific flags beyond the inherited globals.
|
|
7912
|
+
* Surfaced as an empty interface so the renderer signature stays uniform
|
|
7913
|
+
* with the rest of the command surface.
|
|
7914
|
+
*/
|
|
7915
|
+
interface CdkNoticesOptions extends CdkGlobalOptions {
|
|
7916
|
+
}
|
|
7917
|
+
/**
|
|
7918
|
+
* Options for the `cdk doctor` command.
|
|
7919
|
+
*
|
|
7920
|
+
* `cdk doctor` has no command-specific flags beyond the inherited globals.
|
|
7921
|
+
* Surfaced as an empty interface so the renderer signature stays uniform
|
|
7922
|
+
* with the rest of the command surface.
|
|
7923
|
+
*/
|
|
7924
|
+
interface CdkDoctorOptions extends CdkGlobalOptions {
|
|
7925
|
+
}
|
|
7926
|
+
/**
|
|
7927
|
+
* Options for the `cdk docs` (`doc`) command.
|
|
7928
|
+
*
|
|
7929
|
+
* `cdk docs` has no command-specific flags beyond the inherited globals.
|
|
7930
|
+
* Surfaced as an empty interface so the renderer signature stays uniform
|
|
7931
|
+
* with the rest of the command surface.
|
|
7932
|
+
*/
|
|
7933
|
+
interface CdkDocsOptions extends CdkGlobalOptions {
|
|
7934
|
+
}
|
|
7935
|
+
/**
|
|
7936
|
+
* Per-target / per-account override bundle for the `CdkCli` component.
|
|
7937
|
+
*
|
|
7938
|
+
* Used in two distinct positions in the override stack:
|
|
7939
|
+
*
|
|
7940
|
+
* - **Per-account** on `CdkCliOptions.accountOverrides[accountId]` —
|
|
7941
|
+
* applies to every {@link AwsDeploymentTarget} that resolves to the same
|
|
7942
|
+
* AWS account ID.
|
|
7943
|
+
* - **Per-target** on `AwsDeploymentTargetOptions.cdkOptions` — applies
|
|
7944
|
+
* only to that specific deployment target.
|
|
7945
|
+
*
|
|
7946
|
+
* Both layers slot into the precedence chain documented on {@link CdkCli};
|
|
7947
|
+
* per-target wins on collisions because it is the more specific layer.
|
|
7948
|
+
*
|
|
7949
|
+
* Every command field is optional so consumers can override one command
|
|
7950
|
+
* (e.g. just `deploy`) without restating the others.
|
|
7951
|
+
*/
|
|
7952
|
+
interface CdkTargetOverrides {
|
|
7953
|
+
/**
|
|
7954
|
+
* Overrides applied to `cdk deploy` invocations against the matching
|
|
7955
|
+
* target / account.
|
|
7956
|
+
*/
|
|
7957
|
+
readonly deploy?: Partial<CdkDeployOptions>;
|
|
7958
|
+
/**
|
|
7959
|
+
* Overrides applied to `cdk synth` invocations against the matching
|
|
7960
|
+
* target / account.
|
|
7961
|
+
*/
|
|
7962
|
+
readonly synth?: Partial<CdkSynthOptions>;
|
|
7963
|
+
/**
|
|
7964
|
+
* Overrides applied to `cdk watch` invocations against the matching
|
|
7965
|
+
* target / account.
|
|
7966
|
+
*/
|
|
7967
|
+
readonly watch?: Partial<CdkWatchOptions>;
|
|
7968
|
+
/**
|
|
7969
|
+
* Overrides applied to `cdk destroy` invocations against the matching
|
|
7970
|
+
* target / account.
|
|
7971
|
+
*/
|
|
7972
|
+
readonly destroy?: Partial<CdkDestroyOptions>;
|
|
7973
|
+
/**
|
|
7974
|
+
* Overrides applied to `cdk diff` invocations against the matching
|
|
7975
|
+
* target / account.
|
|
7976
|
+
*/
|
|
7977
|
+
readonly diff?: Partial<CdkDiffOptions>;
|
|
7978
|
+
/**
|
|
7979
|
+
* Overrides applied to `cdk bootstrap` invocations against the matching
|
|
7980
|
+
* target / account.
|
|
7981
|
+
*/
|
|
7982
|
+
readonly bootstrap?: Partial<CdkBootstrapOptions>;
|
|
7983
|
+
}
|
|
7984
|
+
|
|
6790
7985
|
/*******************************************************************************
|
|
6791
7986
|
*
|
|
6792
7987
|
* Git configs for this repo. This venn diagram has a great deal of overlap
|
|
@@ -6904,6 +8099,14 @@ interface AwsDeploymentTargetOptions {
|
|
|
6904
8099
|
*/
|
|
6905
8100
|
readonly ciDeployment?: boolean;
|
|
6906
8101
|
readonly ciDeploymentConfig?: CiDeploymentConfig;
|
|
8102
|
+
/**
|
|
8103
|
+
* Per-target overrides for `cdk` CLI options.
|
|
8104
|
+
*
|
|
8105
|
+
* Layered on top of the per-stage defaults and any per-account overrides
|
|
8106
|
+
* configured on {@link CdkCli}. See {@link CdkCli} for the full precedence
|
|
8107
|
+
* chain.
|
|
8108
|
+
*/
|
|
8109
|
+
readonly cdkOptions?: CdkTargetOverrides;
|
|
6907
8110
|
}
|
|
6908
8111
|
declare class AwsDeploymentTarget extends Component {
|
|
6909
8112
|
/**
|
|
@@ -6965,6 +8168,14 @@ declare class AwsDeploymentTarget extends Component {
|
|
|
6965
8168
|
* Configuration for the CDK output directory for this deployment target.
|
|
6966
8169
|
*/
|
|
6967
8170
|
awsDeploymentConfig: AwsDeploymentConfig;
|
|
8171
|
+
/**
|
|
8172
|
+
* Per-target overrides for `cdk` CLI options.
|
|
8173
|
+
*
|
|
8174
|
+
* Read by `CdkCli.*OptionsFor(target)` as the second-highest layer in the
|
|
8175
|
+
* precedence chain (below call-site explicit options, above per-account
|
|
8176
|
+
* overrides). See {@link CdkCli} for the full chain.
|
|
8177
|
+
*/
|
|
8178
|
+
cdkOptions?: CdkTargetOverrides;
|
|
6968
8179
|
constructor(project: AwsCdkTypeScriptApp, options: AwsDeploymentTargetOptions);
|
|
6969
8180
|
/*****************************************************************************
|
|
6970
8181
|
*
|
|
@@ -6985,6 +8196,197 @@ declare class AwsDeploymentTarget extends Component {
|
|
|
6985
8196
|
private configureWatchTask;
|
|
6986
8197
|
}
|
|
6987
8198
|
|
|
8199
|
+
/*******************************************************************************
|
|
8200
|
+
*
|
|
8201
|
+
* AWS CDK CLI Component
|
|
8202
|
+
*
|
|
8203
|
+
* Owns the per-project options that get layered into every `cdk` CLI
|
|
8204
|
+
* invocation the generated project makes. Phase 1 covered `cdk deploy`; Phase
|
|
8205
|
+
* 2 extended the component with `synth`, `watch`, `destroy`, `diff`, and
|
|
8206
|
+
* `bootstrap`. Phase 5 (this revision) wires in the full per-target /
|
|
8207
|
+
* per-account override surface and the generic {@link mergeCdkOptions} folder.
|
|
8208
|
+
*
|
|
8209
|
+
* ## Override precedence
|
|
8210
|
+
*
|
|
8211
|
+
* Each `*OptionsFor(target)` accessor folds the layers below in
|
|
8212
|
+
* **lowest-precedence-first** order; the rightmost (highest) layer wins on
|
|
8213
|
+
* scalar collisions, arrays concat-and-dedupe across layers, and record-valued
|
|
8214
|
+
* fields merge one level deep with the higher layer winning on key collisions.
|
|
8215
|
+
*
|
|
8216
|
+
* 1. **Per-stage built-in default** — from `CDK_*_DEFAULTS_BY_STAGE` for the
|
|
8217
|
+
* target's {@link AwsDeploymentTarget.awsStageType}.
|
|
8218
|
+
* 2. **Per-stage consumer override** — from this component's
|
|
8219
|
+
* `<command>Defaults[stage]` map.
|
|
8220
|
+
* 3. **Per-account override** — from `accountOverrides[target.account][<command>]`.
|
|
8221
|
+
* 4. **Per-target override** — from `target.cdkOptions.<command>`.
|
|
8222
|
+
* 5. **Call-site explicit option** — passed by the caller into the renderer
|
|
8223
|
+
* directly, after the accessor returns. The accessor does not see this
|
|
8224
|
+
* layer; the caller is responsible for spreading the accessor result first
|
|
8225
|
+
* and then the call-site option on top.
|
|
8226
|
+
*
|
|
8227
|
+
* Auto-instantiated by {@link AwsDeploymentConfig} when absent; consumers can
|
|
8228
|
+
* pre-instantiate it via `new CdkCli(project, options)` to register custom
|
|
8229
|
+
* per-stage defaults and per-account overrides.
|
|
8230
|
+
*
|
|
8231
|
+
******************************************************************************/
|
|
8232
|
+
/**
|
|
8233
|
+
* Options accepted by {@link CdkCli}.
|
|
8234
|
+
*/
|
|
8235
|
+
interface CdkCliOptions {
|
|
8236
|
+
/**
|
|
8237
|
+
* Consumer-supplied overrides for the built-in per-stage deploy defaults.
|
|
8238
|
+
*
|
|
8239
|
+
* Each entry is merged on top of
|
|
8240
|
+
* {@link CDK_DEPLOY_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8241
|
+
* {@link mergeCdkOptions}.
|
|
8242
|
+
*/
|
|
8243
|
+
readonly deployDefaults?: Partial<Record<AwsStageType, Partial<CdkDeployOptions>>>;
|
|
8244
|
+
/**
|
|
8245
|
+
* Consumer-supplied overrides for the built-in per-stage synth defaults.
|
|
8246
|
+
*
|
|
8247
|
+
* Each entry is merged on top of
|
|
8248
|
+
* {@link CDK_SYNTH_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8249
|
+
* {@link mergeCdkOptions}.
|
|
8250
|
+
*/
|
|
8251
|
+
readonly synthDefaults?: Partial<Record<AwsStageType, Partial<CdkSynthOptions>>>;
|
|
8252
|
+
/**
|
|
8253
|
+
* Consumer-supplied overrides for the built-in per-stage watch defaults.
|
|
8254
|
+
*
|
|
8255
|
+
* Each entry is merged on top of
|
|
8256
|
+
* {@link CDK_WATCH_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8257
|
+
* {@link mergeCdkOptions}.
|
|
8258
|
+
*/
|
|
8259
|
+
readonly watchDefaults?: Partial<Record<AwsStageType, Partial<CdkWatchOptions>>>;
|
|
8260
|
+
/**
|
|
8261
|
+
* Consumer-supplied overrides for the built-in per-stage destroy defaults.
|
|
8262
|
+
*
|
|
8263
|
+
* Each entry is merged on top of
|
|
8264
|
+
* {@link CDK_DESTROY_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8265
|
+
* {@link mergeCdkOptions}.
|
|
8266
|
+
*/
|
|
8267
|
+
readonly destroyDefaults?: Partial<Record<AwsStageType, Partial<CdkDestroyOptions>>>;
|
|
8268
|
+
/**
|
|
8269
|
+
* Consumer-supplied overrides for the built-in per-stage diff defaults.
|
|
8270
|
+
*
|
|
8271
|
+
* Each entry is merged on top of
|
|
8272
|
+
* {@link CDK_DIFF_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8273
|
+
* {@link mergeCdkOptions}.
|
|
8274
|
+
*/
|
|
8275
|
+
readonly diffDefaults?: Partial<Record<AwsStageType, Partial<CdkDiffOptions>>>;
|
|
8276
|
+
/**
|
|
8277
|
+
* Consumer-supplied overrides for the built-in per-stage bootstrap defaults.
|
|
8278
|
+
*
|
|
8279
|
+
* Each entry is merged on top of
|
|
8280
|
+
* {@link CDK_BOOTSTRAP_DEFAULTS_BY_STAGE} for the matching stage via
|
|
8281
|
+
* {@link mergeCdkOptions}.
|
|
8282
|
+
*/
|
|
8283
|
+
readonly bootstrapDefaults?: Partial<Record<AwsStageType, Partial<CdkBootstrapOptions>>>;
|
|
8284
|
+
/**
|
|
8285
|
+
* Per-account overrides keyed by AWS account ID.
|
|
8286
|
+
*
|
|
8287
|
+
* Each value is a {@link CdkTargetOverrides} bundle that applies to every
|
|
8288
|
+
* {@link AwsDeploymentTarget} whose `account` matches the key. Sits in the
|
|
8289
|
+
* precedence chain between per-stage overrides and per-target overrides —
|
|
8290
|
+
* see {@link CdkCli} for the full layer order.
|
|
8291
|
+
*
|
|
8292
|
+
* Example: pin `--no-rollback` on every deploy into a sandbox account
|
|
8293
|
+
* regardless of the target's stage:
|
|
8294
|
+
*
|
|
8295
|
+
* ```typescript
|
|
8296
|
+
* new CdkCli(project, {
|
|
8297
|
+
* accountOverrides: {
|
|
8298
|
+
* "111122223333": { deploy: { rollback: false } },
|
|
8299
|
+
* },
|
|
8300
|
+
* });
|
|
8301
|
+
* ```
|
|
8302
|
+
*/
|
|
8303
|
+
readonly accountOverrides?: Record<string, CdkTargetOverrides>;
|
|
8304
|
+
}
|
|
8305
|
+
declare class CdkCli extends Component {
|
|
8306
|
+
/**
|
|
8307
|
+
* Find the {@link CdkCli} component already attached to the project, if any.
|
|
8308
|
+
*/
|
|
8309
|
+
static of(project: AwsCdkTypeScriptApp): CdkCli | undefined;
|
|
8310
|
+
/**
|
|
8311
|
+
* The consumer-supplied per-stage deploy default overrides.
|
|
8312
|
+
*/
|
|
8313
|
+
readonly deployDefaults: Partial<Record<AwsStageType, Partial<CdkDeployOptions>>>;
|
|
8314
|
+
/**
|
|
8315
|
+
* The consumer-supplied per-stage synth default overrides.
|
|
8316
|
+
*/
|
|
8317
|
+
readonly synthDefaults: Partial<Record<AwsStageType, Partial<CdkSynthOptions>>>;
|
|
8318
|
+
/**
|
|
8319
|
+
* The consumer-supplied per-stage watch default overrides.
|
|
8320
|
+
*/
|
|
8321
|
+
readonly watchDefaults: Partial<Record<AwsStageType, Partial<CdkWatchOptions>>>;
|
|
8322
|
+
/**
|
|
8323
|
+
* The consumer-supplied per-stage destroy default overrides.
|
|
8324
|
+
*/
|
|
8325
|
+
readonly destroyDefaults: Partial<Record<AwsStageType, Partial<CdkDestroyOptions>>>;
|
|
8326
|
+
/**
|
|
8327
|
+
* The consumer-supplied per-stage diff default overrides.
|
|
8328
|
+
*/
|
|
8329
|
+
readonly diffDefaults: Partial<Record<AwsStageType, Partial<CdkDiffOptions>>>;
|
|
8330
|
+
/**
|
|
8331
|
+
* The consumer-supplied per-stage bootstrap default overrides.
|
|
8332
|
+
*/
|
|
8333
|
+
readonly bootstrapDefaults: Partial<Record<AwsStageType, Partial<CdkBootstrapOptions>>>;
|
|
8334
|
+
/**
|
|
8335
|
+
* The consumer-supplied per-account overrides, keyed by AWS account ID.
|
|
8336
|
+
*/
|
|
8337
|
+
readonly accountOverrides: Record<string, CdkTargetOverrides>;
|
|
8338
|
+
constructor(project: AwsCdkTypeScriptApp, options?: CdkCliOptions);
|
|
8339
|
+
/**
|
|
8340
|
+
* Resolve the `cdk deploy` options to use against a given target.
|
|
8341
|
+
*
|
|
8342
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8343
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8344
|
+
* override. The call-site explicit layer is applied by the caller after
|
|
8345
|
+
* this method returns. See {@link CdkCli} for the full chain.
|
|
8346
|
+
*/
|
|
8347
|
+
deployOptionsFor(target: AwsDeploymentTarget): CdkDeployOptions;
|
|
8348
|
+
/**
|
|
8349
|
+
* Resolve the `cdk synth` options to use against a given target.
|
|
8350
|
+
*
|
|
8351
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8352
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8353
|
+
* override. See {@link CdkCli} for the full chain.
|
|
8354
|
+
*/
|
|
8355
|
+
synthOptionsFor(target: AwsDeploymentTarget): CdkSynthOptions;
|
|
8356
|
+
/**
|
|
8357
|
+
* Resolve the `cdk watch` options to use against a given target.
|
|
8358
|
+
*
|
|
8359
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8360
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8361
|
+
* override. See {@link CdkCli} for the full chain.
|
|
8362
|
+
*/
|
|
8363
|
+
watchOptionsFor(target: AwsDeploymentTarget): CdkWatchOptions;
|
|
8364
|
+
/**
|
|
8365
|
+
* Resolve the `cdk destroy` options to use against a given target.
|
|
8366
|
+
*
|
|
8367
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8368
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8369
|
+
* override. See {@link CdkCli} for the full chain.
|
|
8370
|
+
*/
|
|
8371
|
+
destroyOptionsFor(target: AwsDeploymentTarget): CdkDestroyOptions;
|
|
8372
|
+
/**
|
|
8373
|
+
* Resolve the `cdk diff` options to use against a given target.
|
|
8374
|
+
*
|
|
8375
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8376
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8377
|
+
* override. See {@link CdkCli} for the full chain.
|
|
8378
|
+
*/
|
|
8379
|
+
diffOptionsFor(target: AwsDeploymentTarget): CdkDiffOptions;
|
|
8380
|
+
/**
|
|
8381
|
+
* Resolve the `cdk bootstrap` options to use against a given target.
|
|
8382
|
+
*
|
|
8383
|
+
* Folds the precedence chain via {@link mergeCdkOptions}: per-stage built-in
|
|
8384
|
+
* → per-stage consumer override → per-account override → per-target
|
|
8385
|
+
* override. See {@link CdkCli} for the full chain.
|
|
8386
|
+
*/
|
|
8387
|
+
bootstrapOptionsFor(target: AwsDeploymentTarget): CdkBootstrapOptions;
|
|
8388
|
+
}
|
|
8389
|
+
|
|
6988
8390
|
/*******************************************************************************
|
|
6989
8391
|
*
|
|
6990
8392
|
* AWS Deployment Configuration
|
|
@@ -7021,6 +8423,11 @@ declare class AwsDeploymentConfig extends Component {
|
|
|
7021
8423
|
* Array of targets for deployment.
|
|
7022
8424
|
*/
|
|
7023
8425
|
readonly awsDeploymentTargets: Array<AwsDeploymentTarget>;
|
|
8426
|
+
/**
|
|
8427
|
+
* The CDK CLI component that owns shared `cdk` invocation options for this
|
|
8428
|
+
* project.
|
|
8429
|
+
*/
|
|
8430
|
+
readonly cdkCli: CdkCli;
|
|
7024
8431
|
constructor(project: AwsCdkTypeScriptApp);
|
|
7025
8432
|
/*****************************************************************************
|
|
7026
8433
|
*
|
|
@@ -7125,6 +8532,226 @@ interface AwsOrganization {
|
|
|
7125
8532
|
accounts: Array<AwsAccount>;
|
|
7126
8533
|
}
|
|
7127
8534
|
|
|
8535
|
+
/*******************************************************************************
|
|
8536
|
+
*
|
|
8537
|
+
* AWS CDK CLI Defaults
|
|
8538
|
+
*
|
|
8539
|
+
* Per-stage default option sets the `CdkCli` component layers in when a
|
|
8540
|
+
* consumer asks for the options to use against a given deployment target.
|
|
8541
|
+
* Phase 1 registered defaults for `cdk deploy`; Phase 2 registers defaults for
|
|
8542
|
+
* `synth`, `watch`, `destroy`, `diff`, and `bootstrap`.
|
|
8543
|
+
*
|
|
8544
|
+
******************************************************************************/
|
|
8545
|
+
/**
|
|
8546
|
+
* Per-stage defaults for `cdk deploy`.
|
|
8547
|
+
*
|
|
8548
|
+
* - `dev` opts into `--no-rollback` for fast iteration.
|
|
8549
|
+
* - `stage` and `prod` deliberately omit `rollback` so the CLI default
|
|
8550
|
+
* (`true`, i.e. atomic deploys with rollback) applies — this is what allows
|
|
8551
|
+
* replacement-style updates to succeed in stage/prod.
|
|
8552
|
+
* - `prod` pins `--method=change-set` to leave a reviewable change-set trail.
|
|
8553
|
+
*/
|
|
8554
|
+
declare const CDK_DEPLOY_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDeployOptions>>;
|
|
8555
|
+
/**
|
|
8556
|
+
* Per-stage defaults for `cdk synth`.
|
|
8557
|
+
*
|
|
8558
|
+
* Every stage runs synth with `--quiet` so the synthesised template stays out
|
|
8559
|
+
* of normal task logs.
|
|
8560
|
+
*/
|
|
8561
|
+
declare const CDK_SYNTH_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkSynthOptions>>;
|
|
8562
|
+
/**
|
|
8563
|
+
* Per-stage defaults for `cdk watch`.
|
|
8564
|
+
*
|
|
8565
|
+
* Every stage uses `--progress=events` to stream CloudFormation events line by
|
|
8566
|
+
* line. The CLI default for `cdk watch --hotswap` is already `true`, so the
|
|
8567
|
+
* record leaves it unset.
|
|
8568
|
+
*/
|
|
8569
|
+
declare const CDK_WATCH_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkWatchOptions>>;
|
|
8570
|
+
/**
|
|
8571
|
+
* Per-stage defaults for `cdk destroy`.
|
|
8572
|
+
*
|
|
8573
|
+
* `dev` opts into `--force` so local teardown does not prompt; `stage` and
|
|
8574
|
+
* `prod` deliberately omit `force` so the CLI's confirmation prompt fires.
|
|
8575
|
+
*/
|
|
8576
|
+
declare const CDK_DESTROY_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDestroyOptions>>;
|
|
8577
|
+
/**
|
|
8578
|
+
* Per-stage defaults for `cdk diff`.
|
|
8579
|
+
*
|
|
8580
|
+
* Empty by default — diff has no flags whose stage-by-stage value is obvious.
|
|
8581
|
+
* Reserved for consumer overrides.
|
|
8582
|
+
*/
|
|
8583
|
+
declare const CDK_DIFF_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkDiffOptions>>;
|
|
8584
|
+
/**
|
|
8585
|
+
* Per-stage defaults for `cdk bootstrap`.
|
|
8586
|
+
*
|
|
8587
|
+
* `prod` opts into `--termination-protection` so the bootstrap stack cannot be
|
|
8588
|
+
* accidentally deleted; `dev` and `stage` omit it.
|
|
8589
|
+
*/
|
|
8590
|
+
declare const CDK_BOOTSTRAP_DEFAULTS_BY_STAGE: Record<AwsStageType, Partial<CdkBootstrapOptions>>;
|
|
8591
|
+
|
|
8592
|
+
/*******************************************************************************
|
|
8593
|
+
*
|
|
8594
|
+
* AWS CDK CLI Option Merge
|
|
8595
|
+
*
|
|
8596
|
+
* Generic helper that folds a precedence-ordered list of `CdkXxxOptions`
|
|
8597
|
+
* fragments into a single resolved option set. Used by every
|
|
8598
|
+
* `CdkCli.*OptionsFor(target)` accessor to assemble the documented 5-level
|
|
8599
|
+
* override stack (per-stage default → per-account override → per-target
|
|
8600
|
+
* override → consumer override → call-site explicit) without per-command merge
|
|
8601
|
+
* logic.
|
|
8602
|
+
*
|
|
8603
|
+
* Merge semantics (see also the `CdkCli` JSDoc):
|
|
8604
|
+
*
|
|
8605
|
+
* - **Scalars** (booleans, strings, numbers, enums): a non-`undefined` value in
|
|
8606
|
+
* a later (higher-precedence) layer overwrites the previous value. An
|
|
8607
|
+
* `undefined` value in a later layer is treated as "no opinion" and falls
|
|
8608
|
+
* through to whatever lower layers contributed.
|
|
8609
|
+
* - **Arrays**: concatenated low → high precedence, then deduplicated preserving
|
|
8610
|
+
* document order (first occurrence wins). This lets a per-stage default seed
|
|
8611
|
+
* a list and per-target/per-account layers append to it without losing the
|
|
8612
|
+
* seeded entries.
|
|
8613
|
+
* - **Records / maps** (plain object values, including `tags` and `context`
|
|
8614
|
+
* when modelled as `Record<string, string>`): merged one level deep; later
|
|
8615
|
+
* layers win on key collisions, earlier layers' keys survive otherwise.
|
|
8616
|
+
* - **`undefined` layers** and **`undefined` field values** short-circuit — no
|
|
8617
|
+
* field on the output is touched by a missing layer or a `undefined` entry.
|
|
8618
|
+
*
|
|
8619
|
+
******************************************************************************/
|
|
8620
|
+
/**
|
|
8621
|
+
* Fold a precedence-ordered list of partial CDK CLI option layers into a
|
|
8622
|
+
* single resolved option set.
|
|
8623
|
+
*
|
|
8624
|
+
* Layers are supplied in **lowest-precedence-first** order. Each subsequent
|
|
8625
|
+
* layer's non-`undefined` values overwrite the previous accumulator for
|
|
8626
|
+
* scalars; arrays are concatenated and deduped; record-valued fields are
|
|
8627
|
+
* merged one level deep.
|
|
8628
|
+
*
|
|
8629
|
+
* `undefined` layers are skipped entirely. `undefined` field values within a
|
|
8630
|
+
* layer are skipped per-field — they never clobber a previously set value.
|
|
8631
|
+
*
|
|
8632
|
+
* @typeParam TOptions - The fully resolved option interface (e.g.
|
|
8633
|
+
* `CdkDeployOptions`). The function returns `TOptions`, but the caller is
|
|
8634
|
+
* responsible for ensuring every field its consumers depend on is supplied
|
|
8635
|
+
* by at least one layer — the helper does not validate completeness.
|
|
8636
|
+
*/
|
|
8637
|
+
declare const mergeCdkOptions: <TOptions>(...layers: Array<Partial<TOptions> | undefined>) => TOptions;
|
|
8638
|
+
|
|
8639
|
+
/**
|
|
8640
|
+
* Render a `cdk deploy ...` command from the supplied options. Returns the
|
|
8641
|
+
* full command string (starting with `deploy`).
|
|
8642
|
+
*/
|
|
8643
|
+
declare const renderCdkDeploy: (opts: CdkDeployOptions) => string;
|
|
8644
|
+
/**
|
|
8645
|
+
* Render a `cdk synth ...` command from the supplied options.
|
|
8646
|
+
*/
|
|
8647
|
+
declare const renderCdkSynth: (opts: CdkSynthOptions) => string;
|
|
8648
|
+
/**
|
|
8649
|
+
* Render a `cdk watch ...` command from the supplied options.
|
|
8650
|
+
*/
|
|
8651
|
+
declare const renderCdkWatch: (opts: CdkWatchOptions) => string;
|
|
8652
|
+
/**
|
|
8653
|
+
* Render a `cdk destroy ...` command from the supplied options.
|
|
8654
|
+
*/
|
|
8655
|
+
declare const renderCdkDestroy: (opts: CdkDestroyOptions) => string;
|
|
8656
|
+
/**
|
|
8657
|
+
* Render a `cdk diff ...` command from the supplied options.
|
|
8658
|
+
*/
|
|
8659
|
+
declare const renderCdkDiff: (opts: CdkDiffOptions) => string;
|
|
8660
|
+
/**
|
|
8661
|
+
* Render a `cdk bootstrap ...` command from the supplied options.
|
|
8662
|
+
*/
|
|
8663
|
+
declare const renderCdkBootstrap: (opts: CdkBootstrapOptions) => string;
|
|
8664
|
+
/**
|
|
8665
|
+
* Render a `cdk list ...` command from the supplied options.
|
|
8666
|
+
*/
|
|
8667
|
+
declare const renderCdkList: (opts: CdkListOptions) => string;
|
|
8668
|
+
/**
|
|
8669
|
+
* Render a `cdk rollback ...` command from the supplied options.
|
|
8670
|
+
*/
|
|
8671
|
+
declare const renderCdkRollback: (opts: CdkRollbackOptions) => string;
|
|
8672
|
+
/**
|
|
8673
|
+
* Render a `cdk import ...` command from the supplied options.
|
|
8674
|
+
*/
|
|
8675
|
+
declare const renderCdkImport: (opts: CdkImportOptions) => string;
|
|
8676
|
+
/**
|
|
8677
|
+
* Render a `cdk gc ...` command from the supplied options.
|
|
8678
|
+
*
|
|
8679
|
+
* The CLI requires the global `--unstable=gc` flag for this command; callers
|
|
8680
|
+
* are responsible for including `"gc"` in {@link CdkGlobalOptions.unstable}.
|
|
8681
|
+
*/
|
|
8682
|
+
declare const renderCdkGc: (opts: CdkGcOptions) => string;
|
|
8683
|
+
/**
|
|
8684
|
+
* Render a `cdk drift ...` command from the supplied options.
|
|
8685
|
+
*/
|
|
8686
|
+
declare const renderCdkDrift: (opts: CdkDriftOptions) => string;
|
|
8687
|
+
/**
|
|
8688
|
+
* Render a `cdk refactor ...` command from the supplied options.
|
|
8689
|
+
*/
|
|
8690
|
+
declare const renderCdkRefactor: (opts: CdkRefactorOptions) => string;
|
|
8691
|
+
/**
|
|
8692
|
+
* Render a `cdk publish-assets ...` command from the supplied options.
|
|
8693
|
+
*/
|
|
8694
|
+
declare const renderCdkPublishAssets: (opts: CdkPublishAssetsOptions) => string;
|
|
8695
|
+
/**
|
|
8696
|
+
* Render a `cdk orphan ...` command from the supplied options. Positional
|
|
8697
|
+
* `logicalIds` render after the command name as quoted, space-separated
|
|
8698
|
+
* arguments.
|
|
8699
|
+
*/
|
|
8700
|
+
declare const renderCdkOrphan: (opts: CdkOrphanOptions) => string;
|
|
8701
|
+
/**
|
|
8702
|
+
* Render a `cdk init ...` command from the supplied options. The positional
|
|
8703
|
+
* `template` argument renders after the command-specific flags, before the
|
|
8704
|
+
* trailing tokens.
|
|
8705
|
+
*/
|
|
8706
|
+
declare const renderCdkInit: (opts: CdkInitOptions) => string;
|
|
8707
|
+
/**
|
|
8708
|
+
* Render a `cdk migrate ...` command from the supplied options.
|
|
8709
|
+
*/
|
|
8710
|
+
declare const renderCdkMigrate: (opts: CdkMigrateOptions) => string;
|
|
8711
|
+
/**
|
|
8712
|
+
* Render a `cdk context ...` command from the supplied options. The CLI's
|
|
8713
|
+
* `--reset` flag takes a context key as its value, so `reset` is rendered
|
|
8714
|
+
* as `--reset=KEY` rather than as a tri-state boolean.
|
|
8715
|
+
*/
|
|
8716
|
+
declare const renderCdkContext: (opts: CdkContextOptions) => string;
|
|
8717
|
+
/**
|
|
8718
|
+
* Render a `cdk metadata ...` command from the supplied options. The
|
|
8719
|
+
* positional `stack` argument renders after the command-specific flags
|
|
8720
|
+
* (there are none beyond the inherited globals), before the trailing
|
|
8721
|
+
* tokens.
|
|
8722
|
+
*/
|
|
8723
|
+
declare const renderCdkMetadata: (opts: CdkMetadataOptions) => string;
|
|
8724
|
+
/**
|
|
8725
|
+
* Render a `cdk flags ...` command from the supplied options. `--value` and
|
|
8726
|
+
* `--set` are value-taking string flags per the CLI surface; the remaining
|
|
8727
|
+
* flags are tri-state booleans.
|
|
8728
|
+
*/
|
|
8729
|
+
declare const renderCdkFlags: (opts: CdkFlagsOptions) => string;
|
|
8730
|
+
/**
|
|
8731
|
+
* Render a `cdk acknowledge ...` command from the supplied options. The
|
|
8732
|
+
* positional `id` argument renders after the command-specific flags (there
|
|
8733
|
+
* are none beyond the inherited globals), before the trailing tokens.
|
|
8734
|
+
*/
|
|
8735
|
+
declare const renderCdkAcknowledge: (opts: CdkAcknowledgeOptions) => string;
|
|
8736
|
+
/**
|
|
8737
|
+
* Render a `cdk notices ...` command from the supplied options. `notices`
|
|
8738
|
+
* has no command-specific flags; only the inherited globals and trailing
|
|
8739
|
+
* tokens contribute output.
|
|
8740
|
+
*/
|
|
8741
|
+
declare const renderCdkNotices: (opts: CdkNoticesOptions) => string;
|
|
8742
|
+
/**
|
|
8743
|
+
* Render a `cdk doctor ...` command from the supplied options. `doctor` has
|
|
8744
|
+
* no command-specific flags; only the inherited globals and trailing tokens
|
|
8745
|
+
* contribute output.
|
|
8746
|
+
*/
|
|
8747
|
+
declare const renderCdkDoctor: (opts: CdkDoctorOptions) => string;
|
|
8748
|
+
/**
|
|
8749
|
+
* Render a `cdk docs ...` command from the supplied options. `docs` has no
|
|
8750
|
+
* command-specific flags; only the inherited globals and trailing tokens
|
|
8751
|
+
* contribute output.
|
|
8752
|
+
*/
|
|
8753
|
+
declare const renderCdkDocs: (opts: CdkDocsOptions) => string;
|
|
8754
|
+
|
|
7128
8755
|
/**
|
|
7129
8756
|
* One row in the doc reference-extraction report — describes a single
|
|
7130
8757
|
* inline-code symbol mention found in a markdown page and whether
|
|
@@ -10736,6 +12363,78 @@ declare const COMPLETE_JOB_ID = "complete";
|
|
|
10736
12363
|
*/
|
|
10737
12364
|
declare function addBuildCompleteJob(buildWorkflow: BuildWorkflow): void;
|
|
10738
12365
|
|
|
12366
|
+
/**
|
|
12367
|
+
* Sets `with["include-hidden-files"] = true` on every build-artifact
|
|
12368
|
+
* `Upload artifact` step generated by projen's
|
|
12369
|
+
* {@code BuildWorkflow.renderBuildSteps()}.
|
|
12370
|
+
*
|
|
12371
|
+
* **Why this exists.** Projen's build workflow brackets the
|
|
12372
|
+
* `Upload artifact` step (for the `dist` build artifact) with a pair
|
|
12373
|
+
* of permission backup/restore steps:
|
|
12374
|
+
*
|
|
12375
|
+
* 1. `Backup artifact permissions` — runs
|
|
12376
|
+
* `cd dist && getfacl -R . > permissions-backup.acl` and captures
|
|
12377
|
+
* ACLs for **every** entry under `dist/`, including dotfiles
|
|
12378
|
+
* (`.pnpm`, `.travis.yml`, etc.).
|
|
12379
|
+
* 2. `Upload artifact` — uploads `dist` using `actions/upload-artifact`.
|
|
12380
|
+
* In `actions/upload-artifact` v4+, the default value of the
|
|
12381
|
+
* `include-hidden-files` input is `false`, so every hidden entry is
|
|
12382
|
+
* silently dropped from the artifact zip.
|
|
12383
|
+
* 3. `Restore build artifact permissions` (in each deploy job) — runs
|
|
12384
|
+
* `setfacl --restore=permissions-backup.acl`. The ACL backup
|
|
12385
|
+
* references hidden paths that no longer exist in the downloaded
|
|
12386
|
+
* artifact, so `setfacl` exits non-zero, producing a failure
|
|
12387
|
+
* annotation on every deploy job (`continue-on-error: true` masks
|
|
12388
|
+
* the job result but does not suppress the annotation).
|
|
12389
|
+
*
|
|
12390
|
+
* Setting `include-hidden-files: true` on the upload keeps the artifact
|
|
12391
|
+
* faithful to what `getfacl -R .` captured, eliminating the
|
|
12392
|
+
* `setfacl --restore` errors and preserving hidden files that CDK
|
|
12393
|
+
* assets legitimately depend on (e.g. the `.pnpm` store layout in a
|
|
12394
|
+
* bundled `node_modules/`).
|
|
12395
|
+
*
|
|
12396
|
+
* **Why this is a configulator patch instead of an upstream projen
|
|
12397
|
+
* change.** Projen exposed the `includeHiddenFiles` opt-in in
|
|
12398
|
+
* `actions/upload-artifact` via
|
|
12399
|
+
* [projen#3827](https://github.com/projen/projen/pull/3827) but never
|
|
12400
|
+
* plumbed it into its own `BuildWorkflow.renderBuildSteps()`
|
|
12401
|
+
* build-artifact upload. Until projen patches its own helper, this
|
|
12402
|
+
* helper is the downstream fix.
|
|
12403
|
+
*
|
|
12404
|
+
* **Why this is a separate helper.** Projen's BuildWorkflow stores
|
|
12405
|
+
* the build job's `steps` as a **lazy closure**
|
|
12406
|
+
* (`steps: () => this.renderBuildSteps(...)`), not an eager array, so
|
|
12407
|
+
* the `Upload artifact` step does not exist anywhere at
|
|
12408
|
+
* `preSynthesize` time. The two existing sibling helpers
|
|
12409
|
+
* ({@code pinPnpmActionSetup}, {@code pinSetupNodeVersion}) reach
|
|
12410
|
+
* lazy-closure steps by patching the component-level
|
|
12411
|
+
* `preBuildSteps` / `postBuildSteps` arrays the closure later
|
|
12412
|
+
* concatenates — that path does not work here because the build-
|
|
12413
|
+
* artifact upload is emitted **inside** `renderBuildSteps()` and is
|
|
12414
|
+
* never added to either component-level array.
|
|
12415
|
+
*
|
|
12416
|
+
* Instead, this helper wraps each job's `steps` closure: it replaces
|
|
12417
|
+
* the original `() => JobStep[]` with a new closure that invokes the
|
|
12418
|
+
* original and post-processes the rendered array to set
|
|
12419
|
+
* `with["include-hidden-files"] = true` on every matching step.
|
|
12420
|
+
* Eager (already-array) step lists are patched in place.
|
|
12421
|
+
*
|
|
12422
|
+
* **Matching rule.** A step is patched only when all three of the
|
|
12423
|
+
* following are true:
|
|
12424
|
+
*
|
|
12425
|
+
* - `step.name === "Upload artifact"`
|
|
12426
|
+
* - `step.uses` starts with `actions/upload-artifact@`
|
|
12427
|
+
* - `step.with.name === "build-artifact"`
|
|
12428
|
+
*
|
|
12429
|
+
* This deliberately misses other `actions/upload-artifact` steps in
|
|
12430
|
+
* the same workflow (e.g. the `turbo-runs` artifact, the `repo.patch`
|
|
12431
|
+
* self-mutation artifact) — those uploads do not source hidden files
|
|
12432
|
+
* and do not pair with a `setfacl --restore` restore step.
|
|
12433
|
+
*
|
|
12434
|
+
* @param project - The project whose GitHub workflows should be patched.
|
|
12435
|
+
*/
|
|
12436
|
+
declare function includeHiddenFilesInBuildArtifact(project: Project$1): void;
|
|
12437
|
+
|
|
10739
12438
|
/**
|
|
10740
12439
|
* Rewrites every `pnpm/action-setup@vX` step `uses` field reachable from
|
|
10741
12440
|
* a project's GitHub component (and its sub-projects) to the version
|
|
@@ -10812,4 +12511,4 @@ declare function pinPnpmActionSetup(project: Project$1): void;
|
|
|
10812
12511
|
*/
|
|
10813
12512
|
declare function pinSetupNodeVersion(project: Project$1): void;
|
|
10814
12513
|
|
|
10815
|
-
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_REGISTRY_ENTRIES, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AUDIT_CATEGORY_ORDER, type ActivateBranchNameEnvVarOptions, type AddStorybookOptions, type AgentCommand, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRegistryEntry, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, type ApiDiffCheckOptions, type ApiDiffFinding, type ApiDiffResult, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApiSurfaceEntry, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, AuditCategory, type AuditCheckRunner, type AuditCheckRunnerContext, type AuditFinding, type AuditFindingBase, type AuditLocation, AuditMode, type AuditReport, AuditSeverity, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, BUNDLE_OWNERSHIP, type BundleOwnership, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudeMdConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CompileFencedSamplesOptions, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_AUDIT_REPORT_DIR, DEFAULT_BUNDLE_OVERRIDES, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_PRIORITY, DEFAULT_ISSUE_STATUS, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_RESOLVED_ISSUE_DEFAULTS, DEFAULT_SAMPLE_COMPILER_OPTIONS, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TEMPORAL_FRAMING_CADENCES, DEFAULT_TEMPORAL_FRAMING_EMIT_CHECKER, DEFAULT_TEMPORAL_FRAMING_ENABLED, DEFAULT_TEMPORAL_FRAMING_PATHS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_UPSTREAM_CONFIGULATOR_ENABLED, DOCS_SYNC_AUDIT_SCHEMA_VERSION, type DeployWorkflowOptions, type DeploymentMetadata, type DocReferenceRecord, type EffectiveScopeThresholds, type ExtractDocReferencesOptions, type ExtractFencedSamplesOptions, type FencedSampleRecord, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueDefaultsConfig, type IssueDefaultsOverride, type IssueDefaultsPriority, type IssueDefaultsStatus, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, type LinkFailureFinding, MAX_LABEL_DESCRIPTION_LENGTH, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, Nvmrc, type OrganizationMetadata, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ReactViteSiteProject, type ReactViteSiteProjectOptions, type ReferenceMismatchCheckOptions, type ReferenceMismatchFinding, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueDefaults, type ResolvedIssueDefaultsEntry, type ResolvedIssueTemplates, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedScopeGateBundleOverride, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedTemporalFraming, type ResolvedUnblockDependents, type RunRatioConfig, type RunScanOptions, type RunScanResult, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, SUPPRESSED_WORKFLOW_RULE_NAMES, type SampleCompilationFailure, type SampleFailureFinding, SampleLang, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateBundleOverride, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, TEMPORAL_FRAMING_CATEGORY_VALUES, type TemplateResolveResult, type TemporalFramingCategory, type TemporalFramingConfig, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, TsdocConfig, type TsdocConfigOptions, type TsdocCoverageCheckOptions, type TsdocCoverageFinding, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, type UpstreamConfigulatorConfig, VALID_PRIORITY_VALUES, VALID_STATUS_VALUES, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addPlaywright, addStorybook, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, auditReportJsonSchema, awsCdkBundle, baseBundle, bcmWriterBundle, buildAgentRegistryRule, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildMeetingAnalysisBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildReport, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, bundleNameForWorkflowRule, businessModelsBundle, checkDocSamplesProcedure, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, compileFencedSamples, createApiDiffCheck, createReferenceMismatchCheck, createTsdocCoverageCheck, customerProfileBundle, diffApiRollups, docsSyncBundle, emptyCategoryBuckets, extractApiProcedure, extractDocReferences, extractFencedSamples, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, hasAnyDocsEmittingBundle, hasAnyDownstreamIssueKindBundle, industryDiscoveryBundle, isPhaseLabelOwnedByExcluded, isScheduledTaskOwnedByExcluded, isSuppressedWorkflowRule, isTypeLabelOwnedByExcluded, jestBundle, labelsForPhase, maintenanceAuditBundle, meetingAnalysisBundle, orchestratorBundle, parseApiRollup, peopleProfileBundle, persistAuditReport, pinPnpmActionSetup, pinSetupNodeVersion, pnpmBundle, prReviewBundle, projenBundle, referenceRecordToFinding, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCheckDocSamplesProcedure, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderStubIndexConventionRuleContent, renderTemporalFramingCheckerScript, renderTemporalFramingRuleContent, renderUnblockDependentsScript, renderUnblockDependentsSection, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueDefaults, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolveOverrideForLabels, resolveProgressFiles, resolveReactViteSiteProjectOutdir, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTemporalFraming, resolveTypeScriptProjectOutdir, resolveUnblockDependents, runScan, slackBundle, softwareProfileBundle, standardsResearchBundle, tsdocRecordToFindings, turborepoBundle, typescriptBundle, upstreamConfigulatorDocsBundle, validateAgentTierConfig, validateIssueDefaultsConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateTemporalFramingConfig, validateUnblockDependentsConfig, vitestBundle };
|
|
12514
|
+
export { AGENT_MODEL, AGENT_PLATFORM, AGENT_REGISTRY_ENTRIES, AGENT_RULE_SCOPE, AGENT_TIER_ROLES, AGENT_TIER_VALUES, AUDIT_CATEGORY_ORDER, type ActivateBranchNameEnvVarOptions, type AddStorybookOptions, type AgentCommand, AgentConfig, type AgentConfigOptions, type AgentExpansionRules, type AgentFeaturesConfig, type AgentModel, type AgentPathsConfig, type AgentPlatform, type AgentPlatformOverrides, type AgentProcedure, type AgentRegistryEntry, type AgentRule, type AgentRuleBundle, type AgentRuleScope, type AgentSkill, type AgentSubAgent, type AgentSubAgentPlatformOverrides, type AgentTier, type AgentTierConfig, type AgentTierEntry, type AnalyzeTsDocCoverageOptions, type ApiDiffCheckOptions, type ApiDiffFinding, type ApiDiffResult, ApiExtractor, type ApiExtractorOptions, type ApiExtractorReportOptions, type ApiSurfaceEntry, type ApproveMergeUpgradeOptions, AstroConfig, type AstroConfigOptions, type AstroIntegrationSpec, AstroOutput, AstroProject, type AstroProjectOptions, AuditCategory, type AuditCheckRunner, type AuditCheckRunnerContext, type AuditFinding, type AuditFindingBase, type AuditLocation, AuditMode, type AuditReport, AuditSeverity, type AwsAccount, AwsCdkProject, type AwsCdkProjectOptions, AwsDeployWorkflow, AwsDeploymentConfig, AwsDeploymentTarget, type AwsDeploymentTargetOptions, type AwsLocalDeploymentConfig, type AwsOrganization, type AwsRegion, AwsTeardownWorkflow, type AwsTeardownWorkflowOptions, BUILT_IN_BUNDLES, BUNDLE_OWNERSHIP, type BundleOwnership, CDK_BOOTSTRAP_DEFAULTS_BY_STAGE, CDK_DEPLOY_DEFAULTS_BY_STAGE, CDK_DEPLOY_METHOD, CDK_DESTROY_DEFAULTS_BY_STAGE, CDK_DIFF_DEFAULTS_BY_STAGE, CDK_DIFF_METHOD, CDK_GC_ACTION, CDK_GC_TYPE, CDK_INIT_LANGUAGE, CDK_INIT_TEMPLATE, CDK_PROGRESS, CDK_REQUIRE_APPROVAL, CDK_SYNTH_DEFAULTS_BY_STAGE, CDK_WATCH_DEFAULTS_BY_STAGE, CLAUDE_RULE_TARGET, COMPLETE_JOB_ID, type CdkAcknowledgeOptions, type CdkBootstrapOptions, CdkCli, type CdkCliOptions, type CdkContextOptions, type CdkDeployMethod, type CdkDeployOptions, type CdkDestroyOptions, type CdkDiffMethod, type CdkDiffOptions, type CdkDocsOptions, type CdkDoctorOptions, type CdkDriftOptions, type CdkFlagsOptions, type CdkGcAction, type CdkGcOptions, type CdkGcType, type CdkGlobalOptions, type CdkImportOptions, type CdkInitLanguage, type CdkInitOptions, type CdkInitTemplate, type CdkListOptions, type CdkMetadataOptions, type CdkMigrateOptions, type CdkNoticesOptions, type CdkOrphanOptions, type CdkProgress, type CdkPublishAssetsOptions, type CdkRefactorOptions, type CdkRequireApproval, type CdkRollbackOptions, type CdkSynthOptions, type CdkTargetOverrides, type CdkWatchOptions, type CiDeploymentConfig, type ClassTypeOptions, type ClaudeAutoModeConfig, type ClaudeHookAction, type ClaudeHookEntry, type ClaudeHooksConfig, type ClaudeMdConfig, type ClaudePermissionsConfig, type ClaudeRuleTarget, type ClaudeSandboxConfig, type ClaudeSettingsConfig, type CompileFencedSamplesOptions, type CopilotHandoff, type CursorHookAction, type CursorHooksConfig, type CursorSettingsConfig, type CustomDocSection, DEFAULT_AC_THRESHOLDS, DEFAULT_AGENT_PATHS, DEFAULT_AGENT_TIERS, DEFAULT_API_EXTRACTOR_CONFIG_FILE, DEFAULT_API_EXTRACTOR_ENTRY_POINT, DEFAULT_API_EXTRACTOR_REPORT_FILENAME, DEFAULT_API_EXTRACTOR_REPORT_FOLDER, DEFAULT_AUDIT_REPORT_DIR, DEFAULT_BUNDLE_OVERRIDES, DEFAULT_DECOMPOSITION_TEMPLATE, DEFAULT_DISPATCH_MODEL, DEFAULT_DISPATCH_TO_HOUSEKEEPING_RATIO, DEFAULT_HOUSEKEEPING_MODEL, DEFAULT_ISSUE_PRIORITY, DEFAULT_ISSUE_STATUS, DEFAULT_ISSUE_TEMPLATES_BUNDLE_PATH_PATTERNS, DEFAULT_ISSUE_TEMPLATES_EMIT_CHECKER, DEFAULT_ISSUE_TEMPLATES_EMIT_STARTER, DEFAULT_ISSUE_TEMPLATES_ENABLED, DEFAULT_ISSUE_TEMPLATES_PATH, DEFAULT_ISSUE_TEMPLATES_REQUIRE_REFERENCE, DEFAULT_OFF_PEAK_CRON_EXAMPLE, DEFAULT_PARTIAL_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_PRIORITY_LABELS, DEFAULT_PRODUCT_CONTEXT_PATH, DEFAULT_PROGRESS_FILES_ENABLED, DEFAULT_PROGRESS_FILES_FILENAME_PATTERN, DEFAULT_PROGRESS_FILES_FORMAT, DEFAULT_PROGRESS_FILES_STALE_AFTER_HOURS, DEFAULT_PROGRESS_FILES_STATE_DIR, DEFAULT_REQUIRE_PRODUCT_CONTEXT, DEFAULT_RESOLVED_ISSUE_DEFAULTS, DEFAULT_SAMPLE_COMPILER_OPTIONS, DEFAULT_SCHEDULED_TASKS_ROOT, DEFAULT_SCHEDULED_TASK_ENTRIES, DEFAULT_SHARED_EDITING_CONFLICT_STRATEGY, DEFAULT_SHARED_EDITING_EMIT_HELPER, DEFAULT_SHARED_EDITING_ENABLED, DEFAULT_SHARED_EDITING_VERIFY_COMMIT, DEFAULT_SHARED_INDEX_PATHS, DEFAULT_SKILL_EVALS_EMIT_RUNNER, DEFAULT_SKILL_EVALS_ENABLED, DEFAULT_SKILL_EVALS_SKILLS_ROOT, DEFAULT_SOURCES_THRESHOLDS, DEFAULT_STATE_FILE_PATH, DEFAULT_STATUS_LABELS, DEFAULT_TEARDOWN_BRANCH_PATTERNS, DEFAULT_TEMPORAL_FRAMING_CADENCES, DEFAULT_TEMPORAL_FRAMING_EMIT_CHECKER, DEFAULT_TEMPORAL_FRAMING_ENABLED, DEFAULT_TEMPORAL_FRAMING_PATHS, DEFAULT_TYPE_LABELS, DEFAULT_UNBLOCK_COMMENT_TEMPLATE, DEFAULT_UNBLOCK_DEPENDENTS_ENABLED, DEFAULT_UPSTREAM_CONFIGULATOR_ENABLED, DOCS_SYNC_AUDIT_SCHEMA_VERSION, type DeployWorkflowOptions, type DeploymentMetadata, type DocReferenceRecord, type EffectiveScopeThresholds, type ExtractDocReferencesOptions, type ExtractFencedSamplesOptions, type FencedSampleRecord, type FocusArea, type FocusAreaMatch, type FocusConfig, type GitBranch, type GitHubBoardMetadata, type GitHubProjectMetadata, type GitHubSprintMetadata, type IDependencyResolver, type IssueDefaultsConfig, type IssueDefaultsOverride, type IssueDefaultsPriority, type IssueDefaultsStatus, type IssueTemplatesConfig, JsiiFaker, LAYOUT_ENFORCEMENT, LAYOUT_ROOT_BY_PROJECT_TYPE, type LabelDefinition, type LayoutEnforcement, type LayoutViolation, type LinkFailureFinding, MAX_LABEL_DESCRIPTION_LENGTH, MCP_TRANSPORT, MERGE_METHODS, MIMIMUM_RELEASE_AGE, MINIMUM_RELEASE_AGE, MONOREPO_LAYOUT, type McpServerConfig, type McpTransport, type MeetingArea, type MeetingScope, type MeetingType, type MeetingTypeKind, type MeetingsConfig, type MergeMethod, type MonorepoLayoutRoot, MonorepoProject, type MonorepoProjectOptions, Nvmrc, type OrganizationMetadata, PROD_DEPLOY_NAME, PROGRESS_FILES_FORMAT_VALUES, PnpmWorkspace, type PnpmWorkspaceOptions, type PriorityRule, type ProgressFilesConfig, ProjectMetadata, type ProjectMetadataOptions, REQUIREMENTS_WRITER_PATHS, ROOT_CI_TASK_NAME, ROOT_TURBO_TASK_NAME, ReactViteSiteProject, type ReactViteSiteProjectOptions, type ReferenceMismatchCheckOptions, type ReferenceMismatchFinding, type RemoteCacheOptions, type RepositoryMetadata, ResetTask, type ResetTaskOptions, type ResolvedAgentPaths, type ResolvedAgentTier, type ResolvedIssueDefaults, type ResolvedIssueDefaultsEntry, type ResolvedIssueTemplates, type ResolvedProgressFiles, type ResolvedProjectMetadata, type ResolvedRunRatio, type ResolvedScheduledTask, type ResolvedScheduledTasks, type ResolvedScopeGate, type ResolvedScopeGateBundleOverride, type ResolvedSharedEditing, type ResolvedSkillEvals, type ResolvedTemporalFraming, type ResolvedUnblockDependents, type RunRatioConfig, type RunScanOptions, type RunScanResult, SCHEDULED_TASK_MODEL_VALUES, SCOPE_CLASS_VALUES, SHARED_EDITING_CONFLICT_STRATEGY_VALUES, STARLIGHT_ROLE, SUPPRESSED_WORKFLOW_RULE_NAMES, type SampleCompilationFailure, type SampleFailureFinding, SampleLang, type ScheduledTaskEntry, type ScheduledTaskModel, type ScheduledTaskOverride, type ScheduledTasksConfig, type ScopeClass, type ScopeGateBundleOverride, type ScopeGateConfig, type ScopeGateThresholds, type SharedEditingConfig, type SkillEvalsConfig, type SlackMetadata, type SourceTierExamples, type StarlightEditLink, type StarlightLogo, StarlightProject, type StarlightProjectOptions, type StarlightRole, type StarlightSidebarItem, type StarlightSingletonViolation, type StarlightSocialLink, type SyncLabelsOptions, TEMPORAL_FRAMING_CATEGORY_VALUES, type TemplateResolveResult, type TemporalFramingCategory, type TemporalFramingConfig, TestRunner, TsDocCoverageKind, type TsDocCoverageRecord, TsdocConfig, type TsdocConfigOptions, type TsdocCoverageCheckOptions, type TsdocCoverageFinding, TurboRepo, type TurboRepoOptions, TurboRepoTask, type TurboRepoTaskOptions, TypeScriptConfig, TypeScriptProject, type TypeScriptProjectOptions, UNKNOWN_TYPE_FALLBACK_TIER, type UnblockDependentsConfig, type UpstreamConfigulatorConfig, VALID_PRIORITY_VALUES, VALID_STATUS_VALUES, VERSION, VERSION_KEYS_SKIP, VERSION_NPM_PACKAGES, VSCodeConfig, type VersionKey, Vitest, type VitestConfigOptions, type VitestOptions, addApproveMergeUpgradeWorkflow, addBuildCompleteJob, addPlaywright, addStorybook, addSyncLabelsWorkflow, agendaBundle, analyzeTsDocCoverage, auditReportJsonSchema, awsCdkBundle, baseBundle, bcmWriterBundle, buildAgentRegistryRule, buildBaseBundle, buildBcmWriterBundle, buildBuiltInBundles, buildBusinessModelsBundle, buildCheckBlockedProcedure, buildCompanyProfileBundle, buildCustomerProfileBundle, buildDocsSyncBundle, buildIndustryDiscoveryBundle, buildMaintenanceAuditBundle, buildMeetingAnalysisBundle, buildOrchestratorConventionsContent, buildPeopleProfileBundle, buildRegulatoryResearchBundle, buildReport, buildRequirementsAnalystBundle, buildRequirementsReviewerBundle, buildRequirementsWriterBundle, buildResearchPipelineBundle, buildSoftwareProfileBundle, buildStandardsResearchBundle, buildUnblockDependentsProcedure, bundleNameForWorkflowRule, businessModelsBundle, checkDocSamplesProcedure, checkLinksProcedure, classifyIssueScope, classifyRun, companyProfileBundle, compileFencedSamples, createApiDiffCheck, createReferenceMismatchCheck, createTsdocCoverageCheck, customerProfileBundle, diffApiRollups, docsSyncBundle, emptyCategoryBuckets, extractApiProcedure, extractDocReferences, extractFencedSamples, formatLayoutViolation, formatStarlightSingletonViolation, getLatestEligibleVersion, githubWorkflowBundle, hasAnyDocsEmittingBundle, hasAnyDownstreamIssueKindBundle, includeHiddenFilesInBuildArtifact, industryDiscoveryBundle, isPhaseLabelOwnedByExcluded, isScheduledTaskOwnedByExcluded, isSuppressedWorkflowRule, isTypeLabelOwnedByExcluded, jestBundle, labelsForPhase, maintenanceAuditBundle, meetingAnalysisBundle, mergeCdkOptions, orchestratorBundle, parseApiRollup, peopleProfileBundle, persistAuditReport, pinPnpmActionSetup, pinSetupNodeVersion, pnpmBundle, prReviewBundle, projenBundle, referenceRecordToFinding, regulatoryResearchBundle, renderAgentTierCaseStatement, renderAgentTierSection, renderCdkAcknowledge, renderCdkBootstrap, renderCdkContext, renderCdkDeploy, renderCdkDestroy, renderCdkDiff, renderCdkDocs, renderCdkDoctor, renderCdkDrift, renderCdkFlags, renderCdkGc, renderCdkImport, renderCdkInit, renderCdkList, renderCdkMetadata, renderCdkMigrate, renderCdkNotices, renderCdkOrphan, renderCdkPublishAssets, renderCdkRefactor, renderCdkRollback, renderCdkSynth, renderCdkWatch, renderCheckDocSamplesProcedure, renderCheckLinksProcedure, renderCustomDocSectionBlock, renderCustomDocSections, renderExtractApiProcedure, renderFocusSection, renderIssueTemplatesBundleHook, renderIssueTemplatesCheckerScript, renderIssueTemplatesRuleContent, renderIssueTemplatesStarterPage, renderMeetingTypesSection, renderPriorityRulesSection, renderProgressFileName, renderProgressFilePath, renderProgressFilesBundleHook, renderProgressFilesRuleContent, renderRunRatioSection, renderRunRatioShellHelpers, renderScheduledTaskSkillFile, renderScheduledTasksSection, renderScopeGateSection, renderScopeGateShellHelpers, renderSharedEditingBundleHook, renderSharedEditingHelperScript, renderSharedEditingRuleContent, renderSkillEvalsBundleHook, renderSkillEvalsRuleContent, renderSkillEvalsRunnerScript, renderSourceTierExamples, renderStubIndexConventionRuleContent, renderTemporalFramingCheckerScript, renderTemporalFramingRuleContent, renderUnblockDependentsScript, renderUnblockDependentsSection, requirementsAnalystBundle, requirementsReviewerBundle, requirementsWriterBundle, researchPipelineBundle, resolveAgentPaths, resolveAgentTiers, resolveAstroProjectOutdir, resolveAwsCdkProjectOutdir, resolveIssueDefaults, resolveIssueTemplates, resolveModelAlias, resolveOrchestratorAssets, resolveOutdirFromPackageName, resolveOverrideForLabels, resolveProgressFiles, resolveReactViteSiteProjectOutdir, resolveRunRatio, resolveScheduledTasks, resolveScopeGate, resolveSharedEditing, resolveSkillEvals, resolveTemplateVariables, resolveTemporalFraming, resolveTypeScriptProjectOutdir, resolveUnblockDependents, runScan, slackBundle, softwareProfileBundle, standardsResearchBundle, tsdocRecordToFindings, turborepoBundle, typescriptBundle, upstreamConfigulatorDocsBundle, validateAgentTierConfig, validateIssueDefaultsConfig, validateIssueTemplatesConfig, validateMonorepoLayout, validateProgressFilesConfig, validateRunRatioConfig, validateScheduledTasksConfig, validateScopeGateConfig, validateSharedEditingConfig, validateSkillEvalsConfig, validateStarlightSingleton, validateTemporalFramingConfig, validateUnblockDependentsConfig, vitestBundle };
|