interface SourcedConfigurationProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.AppConfig.SourcedConfigurationProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#SourcedConfigurationProps |
 Java | software.amazon.awscdk.services.appconfig.SourcedConfigurationProps |
 Python | aws_cdk.aws_appconfig.SourcedConfigurationProps |
 TypeScript (source) | aws-cdk-lib » aws_appconfig » SourcedConfigurationProps |
Properties for SourcedConfiguration.
Example
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
| Name | Type | Description |
|---|---|---|
| application | IApplication | The application associated with the configuration. |
| location | Configuration | The location where the configuration is stored. |
| deletion | Deletion | A parameter to configure deletion protection. |
| deploy | IEnvironment[] | The list of environments to deploy the configuration to. |
| deployment | IKey | The deployment key of the configuration. |
| deployment | IDeployment | The deployment strategy for the configuration. |
| description? | string | The description of the configuration. |
| name? | string | The name of the configuration. |
| retrieval | IRole | The IAM role to retrieve the configuration. |
| type? | Configuration | The type of configuration. |
| validators? | IValidator[] | The validators for the configuration. |
| version | string | The version number of the sourced configuration to deploy. |
application
Type:
IApplication
The application associated with the configuration.
location
Type:
Configuration
The location where the configuration is stored.
deletionProtectionCheck?
Type:
Deletion
(optional, default: DeletionProtectionCheck.ACCOUNT_DEFAULT)
A 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.
See also: https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
deployTo?
Type:
IEnvironment[]
(optional, default: 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.
deploymentKey?
Type:
IKey
(optional, default: None.)
The deployment key of the configuration.
deploymentStrategy?
Type:
IDeployment
(optional, default: A deployment strategy with the rollout strategy set to
RolloutStrategy.CANARY_10_PERCENT_20_MINUTES)
The deployment strategy for the configuration.
description?
Type:
string
(optional, default: No description.)
The description of the configuration.
name?
Type:
string
(optional, default: A name is generated.)
The name of the configuration.
retrievalRole?
Type:
IRole
(optional, default: Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.)
The IAM role to retrieve the configuration.
type?
Type:
Configuration
(optional, default: ConfigurationType.FREEFORM)
The type of configuration.
validators?
Type:
IValidator[]
(optional, default: No validators.)
The validators for the configuration.
versionNumber?
Type:
string
(optional, default: None.)
The version number of the sourced configuration to deploy.
If this is not specified, then there will be no deployment.