AWS CDK Reference

Appearance

v2.275.0

SourcedConfigurationProps Struct ​

Properties for SourcedConfiguration.

Source
aws-appconfig/lib/configuration.ts
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
declare const application: appconfig.Application;
declare const bucket: s3.Bucket;

new appconfig.SourcedConfiguration(this, 'MySourcedConfiguration', {
  application,
  location: appconfig.ConfigurationSource.fromBucket(bucket, 'path/to/file.json'),
  type: appconfig.ConfigurationType.FEATURE_FLAGS,
  name: 'MyConfig',
  description: 'This is my sourced configuration from CDK.',
});

Properties ​

applicationIApplicationapplicationIApplicationapplicationIApplicationApplicationIApplicationApplicationIApplicationrequired#
The application associated with the configuration.
deletionProtectionCheckoptionalDeletionProtectionCheckdeletion_protection_checkoptionalDeletionProtectionCheckdeletionProtectionCheckoptionalDeletionProtectionCheckDeletionProtectionCheckoptionalDeletionProtectionCheckDeletionProtectionCheckoptionalDeletionProtectionCheck#
A parameter to configure deletion protection.

Default: DeletionProtectionCheck.ACCOUNT_DEFAULT

Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.

deploymentKeyoptionalIKeydeployment_keyoptionalIKeydeploymentKeyoptionalIKeyDeploymentKeyoptionalIKeyDeploymentKeyoptionalIKey= None.#
The deployment key of the configuration.
deploymentStrategyoptionalIDeploymentStrategyRefdeployment_strategyoptionalIDeploymentStrategyRefdeploymentStrategyoptionalIDeploymentStrategyRefDeploymentStrategyoptionalIDeploymentStrategyRefDeploymentStrategyoptionalIDeploymentStrategyRef#
The deployment strategy for the configuration.

Default: A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

deployTooptionalIEnvironment[]deploy_tooptionaltyping.List[IEnvironment]deployTooptionalList<IEnvironment>DeployTooptionalIEnvironment[]DeployTooptional*[]IEnvironment= None.#
The list of environments to deploy the configuration to.

If this parameter is not specified, then there will be no deployment created alongside this configuration.

Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods.

descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the configuration.

Default: No description.

locationConfigurationSourcelocationConfigurationSourcelocationConfigurationSourceLocationConfigurationSourceLocationConfigurationSourcerequired#
The location where the configuration is stored.
nameoptionalstringnameoptionalstrnameoptionalStringNameoptionalstringNameoptional*string#
The name of the configuration.

Default: A name is generated.

retrievalRoleoptionalIRoleRefretrieval_roleoptionalIRoleRefretrievalRoleoptionalIRoleRefRetrievalRoleoptionalIRoleRefRetrievalRoleoptionalIRoleRef#
The IAM role to retrieve the configuration.

Default: Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.

typeoptionalConfigurationTypetypeoptionalConfigurationTypetypeoptionalConfigurationTypeTypeoptionalConfigurationTypeTypeoptionalConfigurationType= ConfigurationType.FREEFORM#
The type of configuration.
validatorsoptionalIValidator[]validatorsoptionaltyping.List[IValidator]validatorsoptionalList<IValidator>ValidatorsoptionalIValidator[]Validatorsoptional*[]IValidator#
The validators for the configuration.

Default: No validators.

versionNumberoptionalstringversion_numberoptionalstrversionNumberoptionalStringVersionNumberoptionalstringVersionNumberoptional*string= None.#
The version number of the sourced configuration to deploy.

If this is not specified, then there will be no deployment.