@pipeline-builder/api-core 4.1.6 → 4.1.8

package/lib/types/metadata-keys.d.ts

@@ -0,0 +1,543 @@
+/**
+ * The pipeline METADATA KEY catalog — the single source of truth for both
+ * sides of the product.
+ *
+ * Key format: `aws:cdk:{namespace}:{property}` (all lowercase). These match the
+ * keys produced by `getCustomKey(namespace, property)` and looked up by
+ * `buildConfigFromMetadata` in pipeline-core.
+ *
+ * One table drives everything: `MetadataKeys` (the synth-time constants
+ * re-exported by `@pipeline-builder/pipeline-core`) and `METADATA_KEY_GROUPS`
+ * (the grouped picker the pipeline form builder renders) are BOTH derived from
+ * `METADATA_KEY_CATALOG`, so a key can never exist on one side only.
+ *
+ * This module is dependency-free so the browser can import it through the
+ * `@pipeline-builder/api-core/metadata-keys` subpath.
+ *
+ * @example
+ * ```typescript
+ * const metadata = {
+ *   [MetadataKeys.SELF_MUTATION]: true,
+ *   [MetadataKeys.PUBLISH_ASSETS_IN_PARALLEL]: true
+ * };
+ * ```
+ */
+/** The value shape a metadata key accepts in the form builder. */
+export type MetadataKeyType = 'boolean' | 'string';
+/** One catalog entry: the wire key plus everything the picker needs to render it. */
+export interface MetadataKeyEntry {
+    /** The `aws:cdk:…` key written into a pipeline's metadata. */
+    readonly key: string;
+    /** Picker group heading. */
+    readonly category: string;
+    /** Human label shown in the picker. */
+    readonly label: string;
+    /** Value editor to render. */
+    readonly type: MetadataKeyType;
+}
+/**
+ * Every supported metadata key, keyed by its `MetadataKeys` constant name and
+ * listed in picker order.
+ */
+export declare const METADATA_KEY_CATALOG: {
+    readonly SELF_MUTATION: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:selfmutation';
+        readonly category: 'CodePipeline';
+        readonly label: 'Self Mutation';
+        readonly type: 'boolean';
+    };
+    readonly CROSS_ACCOUNT_KEYS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:crossaccountkeys';
+        readonly category: 'CodePipeline';
+        readonly label: 'Cross Account Keys';
+        readonly type: 'boolean';
+    };
+    readonly DOCKER_ENABLED_FOR_SELF_MUTATION: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:dockerenabledforselfmutation';
+        readonly category: 'CodePipeline';
+        readonly label: 'Docker Enabled for Self Mutation';
+        readonly type: 'boolean';
+    };
+    readonly DOCKER_ENABLED_FOR_SYNTH: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:dockerenabledforsynth';
+        readonly category: 'CodePipeline';
+        readonly label: 'Docker Enabled for Synth';
+        readonly type: 'boolean';
+    };
+    readonly ENABLE_KEY_ROTATION: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:enablekeyrotation';
+        readonly category: 'CodePipeline';
+        readonly label: 'Enable Key Rotation';
+        readonly type: 'boolean';
+    };
+    readonly PUBLISH_ASSETS_IN_PARALLEL: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:publishassetsinparallel';
+        readonly category: 'CodePipeline';
+        readonly label: 'Publish Assets in Parallel';
+        readonly type: 'boolean';
+    };
+    readonly REUSE_CROSS_REGION_SUPPORT_STACKS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:reusecrossregionsupportstacks';
+        readonly category: 'CodePipeline';
+        readonly label: 'Reuse Cross Region Support Stacks';
+        readonly type: 'boolean';
+    };
+    readonly USE_CHANGE_SETS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:usechangesets';
+        readonly category: 'CodePipeline';
+        readonly label: 'Use Change Sets';
+        readonly type: 'boolean';
+    };
+    readonly USE_PIPELINE_ROLE_FOR_ACTIONS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:usepipelineroleforactions';
+        readonly category: 'CodePipeline';
+        readonly label: 'Use Pipeline Role for Actions';
+        readonly type: 'boolean';
+    };
+    readonly ARTIFACT_BUCKET: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:artifactbucket';
+        readonly category: 'CodePipeline';
+        readonly label: 'Artifact Bucket';
+        readonly type: 'string';
+    };
+    readonly ASSET_PUBLISHING_CODE_BUILD_DEFAULTS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:assetpublishingcodebuilddefaults';
+        readonly category: 'CodePipeline';
+        readonly label: 'Asset Publishing CodeBuild Defaults';
+        readonly type: 'string';
+    };
+    readonly CDK_ASSETS_CLI_VERSION: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:cdkassetscliversion';
+        readonly category: 'CodePipeline';
+        readonly label: 'CDK Assets CLI Version';
+        readonly type: 'string';
+    };
+    readonly CLI_VERSION: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:cliversion';
+        readonly category: 'CodePipeline';
+        readonly label: 'CLI Version';
+        readonly type: 'string';
+    };
+    readonly CODE_BUILD_DEFAULTS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:codebuilddefaults';
+        readonly category: 'CodePipeline';
+        readonly label: 'CodeBuild Defaults';
+        readonly type: 'string';
+    };
+    readonly CODE_PIPELINE: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:codepipeline';
+        readonly category: 'CodePipeline';
+        readonly label: 'CodePipeline';
+        readonly type: 'string';
+    };
+    readonly CROSS_REGION_REPLICATION_BUCKETS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:crossregionreplicationbuckets';
+        readonly category: 'CodePipeline';
+        readonly label: 'Cross Region Replication Buckets';
+        readonly type: 'string';
+    };
+    readonly DOCKER_CREDENTIALS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:dockercredentials';
+        readonly category: 'CodePipeline';
+        readonly label: 'Docker Credentials';
+        readonly type: 'string';
+    };
+    readonly PIPELINE_NAME: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:pipelinename';
+        readonly category: 'CodePipeline';
+        readonly label: 'Pipeline Name';
+        readonly type: 'string';
+    };
+    readonly PIPELINE_TYPE: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:pipelinetype';
+        readonly category: 'CodePipeline';
+        readonly label: 'Pipeline Type';
+        readonly type: 'string';
+    };
+    readonly PIPELINE_ROLE: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:role';
+        readonly category: 'CodePipeline';
+        readonly label: 'Pipeline Role';
+        readonly type: 'string';
+    };
+    readonly SELF_MUTATION_CODE_BUILD_DEFAULTS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:selfmutationcodebuilddefaults';
+        readonly category: 'CodePipeline';
+        readonly label: 'Self Mutation CodeBuild Defaults';
+        readonly type: 'string';
+    };
+    readonly SYNTH: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:synth';
+        readonly category: 'CodePipeline';
+        readonly label: 'Synth';
+        readonly type: 'string';
+    };
+    readonly SYNTH_CODE_BUILD_DEFAULTS: {
+        readonly key: 'aws:cdk:pipelines:codepipeline:synthcodebuilddefaults';
+        readonly category: 'CodePipeline';
+        readonly label: 'Synth CodeBuild Defaults';
+        readonly type: 'string';
+    };
+    readonly ACTION_ROLE: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:actionrole';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Action Role';
+        readonly type: 'string';
+    };
+    readonly ADDITIONAL_INPUTS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:additionalinputs';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Additional Inputs';
+        readonly type: 'string';
+    };
+    readonly BUILD_ENVIRONMENT: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:buildenvironment';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Build Environment';
+        readonly type: 'string';
+    };
+    readonly CACHE: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:cache';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Cache';
+        readonly type: 'string';
+    };
+    readonly COMMANDS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:commands';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Commands';
+        readonly type: 'string';
+    };
+    readonly CODE_BUILD_ENV: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:env';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Environment';
+        readonly type: 'string';
+    };
+    readonly ENV_FROM_CFN_OUTPUTS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:envfromcfnoutputs';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Env from CFN Outputs';
+        readonly type: 'string';
+    };
+    readonly FILE_SYSTEM_LOCATIONS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:filesystemlocations';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'File System Locations';
+        readonly type: 'string';
+    };
+    readonly INPUT: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:input';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Input';
+        readonly type: 'string';
+    };
+    readonly INSTALL_COMMANDS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:installcommands';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Install Commands';
+        readonly type: 'string';
+    };
+    readonly LOGGING: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:logging';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Logging';
+        readonly type: 'string';
+    };
+    readonly PARTIAL_BUILD_SPEC: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:partialbuildspec';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Partial Build Spec';
+        readonly type: 'string';
+    };
+    readonly PRIMARY_OUTPUT_DIRECTORY: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:primaryoutputdirectory';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Primary Output Directory';
+        readonly type: 'string';
+    };
+    readonly PROJECT_NAME: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:projectname';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Project Name';
+        readonly type: 'string';
+    };
+    readonly STEP_ROLE: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:role';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Step Role';
+        readonly type: 'string';
+    };
+    readonly ROLE_POLICY_STATEMENTS: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:rolepolicystatements';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Role Policy Statements';
+        readonly type: 'string';
+    };
+    readonly TIMEOUT: {
+        readonly key: 'aws:cdk:pipelines:codebuildstep:timeout';
+        readonly category: 'CodeBuildStep';
+        readonly label: 'Timeout';
+        readonly type: 'string';
+    };
+    readonly SHELL_ADDITIONAL_INPUTS: {
+        readonly key: 'aws:cdk:pipelines:shellstep:additionalinputs';
+        readonly category: 'ShellStep';
+        readonly label: 'Additional Inputs';
+        readonly type: 'string';
+    };
+    readonly SHELL_COMMANDS: {
+        readonly key: 'aws:cdk:pipelines:shellstep:commands';
+        readonly category: 'ShellStep';
+        readonly label: 'Commands';
+        readonly type: 'string';
+    };
+    readonly SHELL_ENV: {
+        readonly key: 'aws:cdk:pipelines:shellstep:env';
+        readonly category: 'ShellStep';
+        readonly label: 'Environment';
+        readonly type: 'string';
+    };
+    readonly SHELL_ENV_FROM_CFN_OUTPUTS: {
+        readonly key: 'aws:cdk:pipelines:shellstep:envfromcfnoutputs';
+        readonly category: 'ShellStep';
+        readonly label: 'Env from CFN Outputs';
+        readonly type: 'string';
+    };
+    readonly SHELL_INPUT: {
+        readonly key: 'aws:cdk:pipelines:shellstep:input';
+        readonly category: 'ShellStep';
+        readonly label: 'Input';
+        readonly type: 'string';
+    };
+    readonly SHELL_INSTALL_COMMANDS: {
+        readonly key: 'aws:cdk:pipelines:shellstep:installcommands';
+        readonly category: 'ShellStep';
+        readonly label: 'Install Commands';
+        readonly type: 'string';
+    };
+    readonly SHELL_PRIMARY_OUTPUT_DIRECTORY: {
+        readonly key: 'aws:cdk:pipelines:shellstep:primaryoutputdirectory';
+        readonly category: 'ShellStep';
+        readonly label: 'Primary Output Directory';
+        readonly type: 'string';
+    };
+    readonly PRIVILEGED: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:privileged';
+        readonly category: 'Build Environment';
+        readonly label: 'Privileged';
+        readonly type: 'boolean';
+    };
+    readonly BUILD_IMAGE: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:buildimage';
+        readonly category: 'Build Environment';
+        readonly label: 'Build Image';
+        readonly type: 'string';
+    };
+    readonly CERTIFICATE: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:certificate';
+        readonly category: 'Build Environment';
+        readonly label: 'Certificate';
+        readonly type: 'string';
+    };
+    readonly COMPUTE_TYPE: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:computetype';
+        readonly category: 'Build Environment';
+        readonly label: 'Compute Type';
+        readonly type: 'string';
+    };
+    readonly DOCKER_SERVER: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:dockerserver';
+        readonly category: 'Build Environment';
+        readonly label: 'Docker Server';
+        readonly type: 'string';
+    };
+    readonly ENVIRONMENT_VARIABLES: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:environmentvariables';
+        readonly category: 'Build Environment';
+        readonly label: 'Environment Variables';
+        readonly type: 'string';
+    };
+    readonly FLEET: {
+        readonly key: 'aws:cdk:codebuild:buildenvironment:fleet';
+        readonly category: 'Build Environment';
+        readonly label: 'Fleet';
+        readonly type: 'string';
+    };
+    readonly NETWORK_TYPE: {
+        readonly key: 'aws:cdk:ec2:network:type';
+        readonly category: 'Network';
+        readonly label: 'Network Type';
+        readonly type: 'string';
+    };
+    readonly NETWORK_VPC_ID: {
+        readonly key: 'aws:cdk:ec2:network:vpcid';
+        readonly category: 'Network';
+        readonly label: 'VPC ID';
+        readonly type: 'string';
+    };
+    readonly NETWORK_SUBNET_IDS: {
+        readonly key: 'aws:cdk:ec2:network:subnetids';
+        readonly category: 'Network';
+        readonly label: 'Subnet IDs';
+        readonly type: 'string';
+    };
+    readonly NETWORK_SUBNET_TYPE: {
+        readonly key: 'aws:cdk:ec2:network:subnettype';
+        readonly category: 'Network';
+        readonly label: 'Subnet Type';
+        readonly type: 'string';
+    };
+    readonly NETWORK_AVAILABILITY_ZONES: {
+        readonly key: 'aws:cdk:ec2:network:availabilityzones';
+        readonly category: 'Network';
+        readonly label: 'Availability Zones';
+        readonly type: 'string';
+    };
+    readonly NETWORK_SUBNET_GROUP_NAME: {
+        readonly key: 'aws:cdk:ec2:network:subnetgroupname';
+        readonly category: 'Network';
+        readonly label: 'Subnet Group Name';
+        readonly type: 'string';
+    };
+    readonly NETWORK_SECURITY_GROUP_IDS: {
+        readonly key: 'aws:cdk:ec2:network:securitygroupids';
+        readonly category: 'Network';
+        readonly label: 'Security Group IDs';
+        readonly type: 'string';
+    };
+    readonly NETWORK_TAGS: {
+        readonly key: 'aws:cdk:ec2:network:tags';
+        readonly category: 'Network';
+        readonly label: 'VPC Lookup Tags';
+        readonly type: 'string';
+    };
+    readonly NETWORK_VPC_NAME: {
+        readonly key: 'aws:cdk:ec2:network:vpcname';
+        readonly category: 'Network';
+        readonly label: 'VPC Name';
+        readonly type: 'string';
+    };
+    readonly NETWORK_REGION: {
+        readonly key: 'aws:cdk:ec2:network:region';
+        readonly category: 'Network';
+        readonly label: 'Region';
+        readonly type: 'string';
+    };
+    readonly ROLE_TYPE: {
+        readonly key: 'aws:cdk:iam:role:type';
+        readonly category: 'IAM Role';
+        readonly label: 'Role Type';
+        readonly type: 'string';
+    };
+    readonly ROLE_ARN: {
+        readonly key: 'aws:cdk:iam:role:rolearn';
+        readonly category: 'IAM Role';
+        readonly label: 'Role ARN';
+        readonly type: 'string';
+    };
+    readonly ROLE_NAME: {
+        readonly key: 'aws:cdk:iam:role:rolename';
+        readonly category: 'IAM Role';
+        readonly label: 'Role Name';
+        readonly type: 'string';
+    };
+    readonly ROLE_MUTABLE: {
+        readonly key: 'aws:cdk:iam:role:mutable';
+        readonly category: 'IAM Role';
+        readonly label: 'Mutable';
+        readonly type: 'boolean';
+    };
+    readonly SECURITY_GROUP_TYPE: {
+        readonly key: 'aws:cdk:ec2:securitygroup:type';
+        readonly category: 'Security Group';
+        readonly label: 'Security Group Type';
+        readonly type: 'string';
+    };
+    readonly SECURITY_GROUP_IDS: {
+        readonly key: 'aws:cdk:ec2:securitygroup:securitygroupids';
+        readonly category: 'Security Group';
+        readonly label: 'Security Group IDs';
+        readonly type: 'string';
+    };
+    readonly SECURITY_GROUP_MUTABLE: {
+        readonly key: 'aws:cdk:ec2:securitygroup:mutable';
+        readonly category: 'Security Group';
+        readonly label: 'Mutable';
+        readonly type: 'boolean';
+    };
+    readonly SECURITY_GROUP_NAME: {
+        readonly key: 'aws:cdk:ec2:securitygroup:securitygroupname';
+        readonly category: 'Security Group';
+        readonly label: 'Security Group Name';
+        readonly type: 'string';
+    };
+    readonly SECURITY_GROUP_VPC_ID: {
+        readonly key: 'aws:cdk:ec2:securitygroup:vpcid';
+        readonly category: 'Security Group';
+        readonly label: 'VPC ID';
+        readonly type: 'string';
+    };
+    readonly NOTIFICATION_TOPIC_ARN: {
+        readonly key: 'aws:cdk:notifications:topic:arn';
+        readonly category: 'Notifications';
+        readonly label: 'SNS Topic ARN';
+        readonly type: 'string';
+    };
+    readonly NOTIFICATION_EVENTS: {
+        readonly key: 'aws:cdk:notifications:events';
+        readonly category: 'Notifications';
+        readonly label: 'Notification Events';
+        readonly type: 'string';
+    };
+    readonly ENABLE_EXECUTION_EVENTS: {
+        readonly key: 'aws:cdk:operations:executionevents';
+        readonly category: 'Operations';
+        readonly label: 'Enable execution event tracking';
+        readonly type: 'boolean';
+    };
+    readonly ENABLE_METRICS: {
+        readonly key: 'aws:cdk:operations:metrics';
+        readonly category: 'Operations';
+        readonly label: 'Enable CloudWatch failure alarms';
+        readonly type: 'boolean';
+    };
+    readonly ARTIFACT_RETENTION_DAYS: {
+        readonly key: 'aws:cdk:operations:artifactretentiondays';
+        readonly category: 'Operations';
+        readonly label: 'Artifact retention in days';
+        readonly type: 'string';
+    };
+    readonly PIPELINE_VARIABLES: {
+        readonly key: 'aws:cdk:operations:variables';
+        readonly category: 'Operations';
+        readonly label: 'Pipeline runtime variables (JSON)';
+        readonly type: 'string';
+    };
+    readonly KMS_KEY_ARN: {
+        readonly key: 'aws:cdk:encryption:kmskeyarn';
+        readonly category: 'Encryption';
+        readonly label: 'Custom KMS key ARN for artifacts';
+        readonly type: 'string';
+    };
+};
+/** Constant name → `aws:cdk:…` key, for typo-free synth-time authoring. */
+export declare const MetadataKeys: { readonly [K in keyof typeof METADATA_KEY_CATALOG]: (typeof METADATA_KEY_CATALOG)[K]['key']; };
+/** Any supported metadata key. */
+export type MetadataKey = (typeof MetadataKeys)[keyof typeof MetadataKeys];
+/** One picker option. */
+export interface MetadataKeyOption {
+    key: string;
+    label: string;
+    type: MetadataKeyType;
+}
+/** One picker group. */
+export interface MetadataKeyGroup {
+    category: string;
+    keys: MetadataKeyOption[];
+}
+/**
+ * The catalog grouped by category, in declaration order — what the pipeline
+ * form builder's metadata picker renders.
+ */
+export declare const METADATA_KEY_GROUPS: readonly MetadataKeyGroup[];