Uses of Annotation Interface
com.cloudforge.core.annotation.ConfigField
Packages that use ConfigField
-
Uses of ConfigField in com.cloudforge.core.config
Fields in com.cloudforge.core.config with annotations of type ConfigFieldModifier and TypeFieldDescriptionDeploymentConfig.additionalProtectedPathsAdditional URL path patterns requiring authentication, added on top of whichever base list (DeploymentConfig.protectedPathsor the application default) is in effect.DeploymentConfig.albAccessLoggingEnable ALB access logs to S3.DeploymentConfig.antiMalwareEnabledEnable anti-malware scanningDeploymentConfig.applicationIdApplication identifier (e.g., "jenkins", "gitlab", "vault")DeploymentConfig.applicationNameHuman-readable application nameDeploymentConfig.artifactsBucketS3 bucket for artifactsDeploymentConfig.artifactsPrefixS3 prefix for artifactsDeploymentConfig.auditManagerEnabledEnable AWS Audit ManagerDeploymentConfig.auditManagerFrameworkIdLegacy single-framework override, superseded byDeploymentConfig.complianceFrameworks(which supports multiple).DeploymentConfig.auditManagerServiceEnabledEnable the AWS Audit Manager service itself (null = use security profile default).DeploymentConfig.authModeAuthentication modeDeploymentConfig.automatedBackupEnabledEnable automated backups (null = use security profile default)DeploymentConfig.autoProvisionIdentityCenterAuto-provision SAML application in IAM Identity CenterString[]DeploymentConfig.availabilityZonesAvailability zone suffixes for deployment (region-relative — "a" means whichever zone the deploy's own region calls "a", not a specific full zone name, since the same suffix set is valid regardless of which region gets picked elsewhere in the form).DeploymentConfig.awsConfigEnabledEnable AWS ConfigDeploymentConfig.backupCrossRegionVaultArnARN of the AWS Backup vault, in another region, that backups are copied to.DeploymentConfig.backupVaultLockEnabledEnable AWS Backup Vault Lock (null = profile default: false except when the compliance matrix requires BACKUP_RECOVERY).DeploymentConfig.backupVaultRetentionEnabledRetain the AWS Backup vault on stack deletion (null = profile default).DeploymentConfig.bastionCidrCIDR for bastion/VPN SSH accessDeploymentConfig.certificateArnARN of an existing ACM certificate to use for the ALB's HTTPS listener, instead of provisioning a new one.DeploymentConfig.certificateExpirationMonitoringCertificate expiration monitoring enabledDeploymentConfig.cloudforgeManagerIssuerUrlCloudForge Manager's own public URL, used as the OIDC issuer when this app trusts a CloudForge Manager install as its identity provider (see com.cloudforgeci.manager.auth.oidcprovider's own package javadoc).DeploymentConfig.cloudfrontEnabledEnable CloudFront CDNDeploymentConfig.cloudTrailEnabledEnable CloudTrail for API audit loggingDeploymentConfig.cloudTrailInsightsEnabledEnable CloudTrail InsightsDeploymentConfig.cloudWatchLogsKmsEncryptionEnabledEnable CloudWatch Logs KMS encryptionDeploymentConfig.cognitoAdminGroupNameAdmin group nameDeploymentConfig.cognitoAppClientIdExisting Cognito App Client IDDeploymentConfig.cognitoAutoProvisionAuto-provision new Cognito User PoolDeploymentConfig.cognitoCreateGroupsCreate admin and user groups in CognitoDeploymentConfig.cognitoDomainPrefixCognito domain prefix (must be globally unique)DeploymentConfig.cognitoInitialAdminEmailInitial admin email addressDeploymentConfig.cognitoInitialAdminPhoneInitial admin phone number (E.164 format)DeploymentConfig.cognitoMfaEnabledEnable MFA for CognitoDeploymentConfig.cognitoMfaMethodCognito MFA methodDeploymentConfig.cognitoSelfSignupEnabledOverrides the security-profile default for whether users can self-register on the Cognito hosted UI (development defaults to allowed, staging/production to admin-only).DeploymentConfig.cognitoUserGroupNameUser group nameDeploymentConfig.cognitoUserPoolClientIdManually configured Cognito app client ID, for a client that wasn't auto-provisioned.DeploymentConfig.cognitoUserPoolIdExisting Cognito User Pool IDDeploymentConfig.cognitoUserPoolNameCognito User Pool nameDeploymentConfig.complianceFrameworksCompliance frameworks to enable.DeploymentConfig.complianceModeCompliance validation mode controlling how validation failures are handled.DeploymentConfig.containerImageOverride container image tagDeploymentConfig.containerImageScanningEnable container image vulnerability scanningDeploymentConfig.containerRuntimeSecurityEnable container runtime security monitoringintDeploymentConfig.cpuFargate CPU units (256, 512, 1024, 2048, 4096)intDeploymentConfig.cpuTargetUtilizationCPU target utilization percentage for auto-scalingDeploymentConfig.createConfigInfrastructureCreate AWS Config infrastructure — an account+region-wide singleton (AWS allows exactly one recorder and one delivery channel per account per region), so this must stay an explicit, single-stack-only opt-in.DeploymentConfig.createGuardDutyDetectorCreate GuardDuty detector (account-region singleton).DeploymentConfig.createZoneCreate Route53 hosted zoneDeploymentConfig.crossRegionBackupEnabledEnable cross-region backups (null = use security profile default)DeploymentConfig.databaseAllocatedStorageGBAllocated storage in GB.DeploymentConfig.databaseBackupRetentionDaysBackup retention period in days.DeploymentConfig.databaseEngineDatabase engine (e.g., postgres, mysql, mariadb).DeploymentConfig.databaseInstanceClassRDS instance class (e.g., db.t3.small, db.m5.large).DeploymentConfig.databaseMultiAzEnable Multi-AZ deployment for high availability.DeploymentConfig.databaseNameDatabase name.DeploymentConfig.databaseReadReplicaCountOptional number of RDS read replicas.DeploymentConfig.databaseVersionDatabase engine version.DeploymentConfig.domainPrimary domain (e.g., "example.com")DeploymentConfig.ebsEncryptionEnabledEnable EBS volume encryption (null = profile default: PRODUCTION/STAGING=true unless the compliance matrix already requires it, DEV=true).DeploymentConfig.efsEncryptionAtRestEnabledEnable EFS at-rest encryption (null = profile default).DeploymentConfig.efsEncryptionInTransitEnabledEnable EFS encryption in transitbooleanDeploymentConfig.enableAgentsEnable JNLP build agent port (Jenkins: 50000)DeploymentConfig.enableAutoScalingEnable auto-scalingDeploymentConfig.enableCloudTrailBucketAccessRemediationEnable CloudTrail bucket access logging remediationbooleanDeploymentConfig.enableClusterEnable Redis Cluster bus port (Redis: 16379)booleanDeploymentConfig.enableClusteringEnable clustering ports (Mattermost: 8074-8075, Vault: 8201)booleanDeploymentConfig.enableDockerRegistryEnable container registry port (GitLab: 5050, Nexus: 5000-5002)DeploymentConfig.enableEncryptionEnable encryption at restDeploymentConfig.enableFlowlogsEnable VPC flow logsDeploymentConfig.enableGuardDutyRemediationEnable GuardDuty finding remediation (null = profile default: auto-enabled in PRODUCTION, same pattern asDeploymentConfig.imdsv2Required-- ComplianceFactory's consumers treatnullas "PRODUCTION enables it, otherwise off" and an explicit value as an override either way, so this must NOT get a static default or that fallback can never trigger.DeploymentConfig.enableInspectorRemediationEnable Inspector finding remediation.DeploymentConfig.enableMacieRemediationEnable Macie finding remediation.booleanDeploymentConfig.enableMetricsEnable Prometheus metrics port (GitLab: 9090)DeploymentConfig.enableMonitoringEnable CloudWatch monitoringbooleanDeploymentConfig.enableNotaryEnable Notary content trust port (Harbor: 4443)DeploymentConfig.enableRdsAutoMinorVersionUpgradeRemediationEnable RDS auto minor version upgrade remediationDeploymentConfig.enableRdsDeletionProtectionRemediationEnable RDS deletion protection remediationDeploymentConfig.enableS3VersioningRemediationEnable S3 versioning remediationDeploymentConfig.enableSecurityHubRemediationEnable Security Hub finding remediation.booleanDeploymentConfig.enableSentinelEnable Redis Sentinel port (Redis: 26379)booleanDeploymentConfig.enableSmtpEnable SMTP email port (Mattermost: 587)booleanDeploymentConfig.enableSmtpsEnable SMTP TLS email port (Mattermost: 465)booleanDeploymentConfig.enableSshEnable Git SSH port (GitLab: 22, Gitea: 2222)DeploymentConfig.enableSslEnable SSL certificate via ACMbooleanDeploymentConfig.enableTrivyEnable Trivy vulnerability scanner port (Harbor: 8080)DeploymentConfig.environmentEnvironment name (e.g., "dev", "staging", "production")DeploymentConfig.existingFileSystemIdReuse existing EFS by ID (for disaster recovery workflows)DeploymentConfig.fileIntegrityMonitoringEnable file integrity monitoringDeploymentConfig.fqdnFully qualified domain name — alwayssubdomain + "." + domainonce both are set; this field only matters when you need to override that computed result directly (e.g.DeploymentConfig.gdprDataTransferApprovedGDPR data transfer approval flag for non-EU deployments.DeploymentConfig.guardDutyAlertsConfiguredGuardDuty alerts configured (EventBridge to SNS/SIEM)DeploymentConfig.guardDutyEnabledEnable GuardDuty threat detection.intDeploymentConfig.healthCheckGracePeriodintDeploymentConfig.healthCheckIntervalintDeploymentConfig.healthCheckTimeoutintDeploymentConfig.healthyThresholdDeploymentConfig.httpsStrictEnabledHTTPS-only mode (no HTTP listener when SSL enabled)DeploymentConfig.identityCenterGroupNameIdentity Center group name for user assignmentDeploymentConfig.imdsv2RequiredRequire IMDSv2 on EC2 instances (null = profile default: PRODUCTION/STAGING=true unless the compliance matrix requires EC2_IMDSV2, DEV=false).DeploymentConfig.inspectorEc2ScanningEnable Inspector EC2 instance scanningDeploymentConfig.inspectorEcrScanningEnable Inspector ECR image scanningDeploymentConfig.inspectorEnabledEnable Amazon Inspector for vulnerability scanning.DeploymentConfig.instanceTypeEC2 instance type (e.g., "t3.micro", "t3.small")DeploymentConfig.lbTypeLoad balancer typeDeploymentConfig.logRetentionDaysCloudWatch Logs retention daysDeploymentConfig.macieAutomatedDiscoveryEnable Macie automated discovery jobsDeploymentConfig.macieEnabledEnable Amazon Macie for PII/PHI discovery (HIPAA/GDPR).DeploymentConfig.managerDirectDeployEnabledOpt-in: grants CloudForge Manager's own task/instance role the direct-deploy IAM capability (CFN_DEPLOY— seeManagerAwsCapabilityCatalog), condition-scoped to CloudForge-tagged resources.DeploymentConfig.managerLicenseKeyA customer's LicenseSeat license key (CFC-XXXX-XXXX-XXXX-XXXX), injected at deploy time so an install activates immediately instead of requiring a follow-up visit to the owner-only License settings screen after the stack comes up.intDeploymentConfig.maxInstanceCapacityMaximum instance capacity for auto-scalingintDeploymentConfig.memoryFargate memory in MBintDeploymentConfig.minInstanceCapacityMinimum instance capacity for auto-scalingDeploymentConfig.networkModeNetwork mode for VPC topologyDeploymentConfig.oidcAuthorizationEndpointOIDC authorization endpointDeploymentConfig.oidcClientIdOIDC client ID — shared by external-idp and cloudforge-manager, both providers where an admin registers this app's client credentials by hand (external IdP's own console, or CloudForge Manager's Trusted Apps settings page) rather than CloudForge auto-provisioning them, so the field means the same thing either way.DeploymentConfig.oidcClientSecretNameOIDC client secret name in Secrets Manager — same sharing rationale asDeploymentConfig.oidcClientId.DeploymentConfig.oidcIssuerOIDC issuer URLDeploymentConfig.oidcProviderOIDC provider (none, cognito, identity-center, external-idp)DeploymentConfig.oidcTokenEndpointOIDC token endpointDeploymentConfig.oidcUserInfoEndpointOIDC user info endpointDeploymentConfig.performanceInsightsEnabledRDS Performance Insights (query-level performance monitoring).DeploymentConfig.protectedPathsURL path patterns that require authentication, replacing the application's own default list (ApplicationSpec#protectedPaths()) when set.DeploymentConfig.provisionDatabaseProvision RDS database for application.DeploymentConfig.provisionManagerAccountCipherKeyProvision a dedicated AWS Secrets Manager entry holding the AES cipher key CloudForge Manager uses to encrypt cross-account connection secrets (external IDs) at rest — seeSecretCipher/AesGcmSecretCipherin cloudforge-manager.DeploymentConfig.provisionManagerRedisSessionsProvision an ElastiCache Redis cluster and bind CloudForge Manager's own container to it as a shared session store (CFC_MANAGER_SESSION_MODE=redis), so every Manager instance behind the same ALB recognizes sessions any of the others created — the missing piece for running Manager itself horizontally scaled.DeploymentConfig.publicPathsURL path patterns explicitly excluded from authentication, removed from the effective protected-paths list afterDeploymentConfig.protectedPaths/DeploymentConfig.additionalProtectedPathsand the application's own defaults are combined.DeploymentConfig.rdsAutoMinorVersionUpgradeAutomatic minor-version upgrades for the RDS instance.DeploymentConfig.rdsDatabaseMultiAzEnabledEnable RDS Multi-AZ (null = profile default: PRODUCTION=true, STAGING/DEV=false unless the compliance matrix requires DATABASE_MULTI_AZ).DeploymentConfig.rdsDeletionProtectionEnabledEnable RDS deletion protection (null = profile default: PRODUCTION=false unless the compliance matrix requires DELETION_PROTECTION, STAGING/DEV=false).DeploymentConfig.rdsEnhancedMonitoringEnabledRDS Enhanced Monitoring (OS-level metrics at a configurable interval).DeploymentConfig.regionAWS region (e.g., "us-east-1", "us-west-2")DeploymentConfig.restrictSecurityGroupEgressRestrict security group egress to VPC CIDR only (requires VPC endpoints for AWS service access)DeploymentConfig.retainStorageRetain EFS/EBS volumes on stack deletionDeploymentConfig.route53QueryLoggingEnabledEnable Route53 Query LoggingDeploymentConfig.runtimeRuntime type (FARGATE or EC2)DeploymentConfig.s3EncryptionEnabledEnable S3 bucket encryption (null = profile default).DeploymentConfig.s3ObjectLockEnabledEnable S3 Object Lock for audit buckets (HIPAA/PCI-DSS immutability requirement)DeploymentConfig.scopeConfigRulesToDeploymentScope AWS Config rules to only monitor this deployment's own resources (by stack name) instead of every resource in the account/region.DeploymentConfig.securityHubAwsFoundationalEnabledEnable the AWS Foundational Security Best Practices standard in Security HubDeploymentConfig.securityHubCisEnabledEnable the CIS AWS Foundations Benchmark standard in Security HubDeploymentConfig.securityHubCisVersionCIS AWS Foundations Benchmark version to enable.DeploymentConfig.securityHubEnabledEnable AWS Security Hub for centralized security findings.DeploymentConfig.securityHubFsbpVersionAWS Foundational Security Best Practices version to enable.DeploymentConfig.securityHubPciDssEnabledEnable the PCI DSS standard in Security HubDeploymentConfig.securityHubPciDssVersionPCI DSS version to enable.DeploymentConfig.securityMonitoringEnabledEnable security monitoringDeploymentConfig.securityProfileSecurity profile (DEV, STAGING, PRODUCTION)DeploymentConfig.snsKmsEncryptionEnabledEnable SNS topic KMS encryption (null = profile default: false unless the compliance matrix requires SNS_KMS_ENCRYPTION).DeploymentConfig.ssoGroupIdSSO Group IDDeploymentConfig.ssoInstanceArnIAM Identity Center (SSO) Instance ARNDeploymentConfig.ssoTargetAccountIdSSO Target Account IDDeploymentConfig.stackNameCloudFormation stack nameDeploymentConfig.subdomainSubdomain prefix (e.g., "ci", "gitlab") — ordered ahead ofDeploymentConfig.domain: you pick what this app is called (the subdomain) before which domain it hangs off of, and the combined result (subdomain + "." + domain) is what gets requested, not the other way around.DeploymentConfig.topologyTopology type — user-selectable, not just an auto-derived display value, so a future topology (or an app implementing more than one applicable interface) isn't locked out of being chosen explicitly.intDeploymentConfig.unhealthyThresholdDeploymentConfig.wafEnabledEnable AWS WAF