SourcedConfiguration
A sourced configuration represents configuration stored in an Amazon S3 bucket, AWS Secrets Manager secret, Systems Manager (SSM) Parameter Store parameter, SSM document, or AWS CodePipeline.
Import
import { SourcedConfiguration } from 'aws-cdk-lib/aws-appconfig';Or use the module namespace:
import * as appconfig from 'aws-cdk-lib/aws-appconfig';
// appconfig.SourcedConfigurationProperties
Configuration passed to the constructor as SourcedConfigurationProps.
locationRequiredConfigurationSourceThe location where the configuration is stored.
retrievalRoleOptionalIRoleRefThe IAM role to retrieve the configuration.
Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.
versionNumberOptionalstringThe version number of the sourced configuration to deploy. If this is not specified, then there will be no deployment.
Default: - None.
1 property inherited from ConfigurationProps
applicationRequiredinherited from ConfigurationPropsIApplicationThe application associated with the configuration.
8 properties inherited from ConfigurationOptions
deletionProtectionCheckOptionalinherited from ConfigurationOptionsDeletionProtectionCheckA parameter to configure deletion protection. 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.
Default: DeletionProtectionCheck.ACCOUNT_DEFAULT
deploymentKeyOptionalinherited from ConfigurationOptionsIKeyThe deployment key of the configuration.
Default: - None.
deploymentStrategyOptionalinherited from ConfigurationOptionsIDeploymentStrategyRefThe deployment strategy for the configuration.
Default: - A deployment strategy with the rollout strategy set to
RolloutStrategy.CANARY_10_PERCENT_20_MINUTES
deployToOptionalinherited from ConfigurationOptionsIEnvironment[]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.
Default: - None.
descriptionOptionalinherited from ConfigurationOptionsstringThe description of the configuration.
Default: - No description.
nameOptionalinherited from ConfigurationOptionsstringThe name of the configuration.
Default: - A name is generated.
typeOptionalinherited from ConfigurationOptionsConfigurationTypeThe type of configuration.
Default: ConfigurationType.FREEFORM
validatorsOptionalinherited from ConfigurationOptionsIValidator[]The validators for the configuration.
Default: - No validators.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-appconfig