SourcedConfigurationOptions Struct
Options for SourcedConfiguration.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
import { aws_appconfig as interfaces_appconfig } from 'aws-cdk-lib/interfaces';
import { aws_iam as interfaces_iam } from 'aws-cdk-lib/interfaces';
declare const configurationSource: appconfig.ConfigurationSource;
declare const deploymentStrategyRef: interfaces_appconfig.IDeploymentStrategyRef;
declare const environment: appconfig.Environment;
declare const key: kms.Key;
declare const roleRef: interfaces_iam.IRoleRef;
declare const validator: appconfig.IValidator;
const sourcedConfigurationOptions: appconfig.SourcedConfigurationOptions = {
location: configurationSource,
// the properties below are optional
deletionProtectionCheck: appconfig.DeletionProtectionCheck.ACCOUNT_DEFAULT,
deploymentKey: key,
deploymentStrategy: deploymentStrategyRef,
deployTo: [environment],
description: 'description',
name: 'name',
retrievalRole: roleRef,
type: appconfig.ConfigurationType.FREEFORM,
validators: [validator],
versionNumber: 'versionNumber',
};
Properties
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.
The name of the configuration.
Default: A name is generated.
retrievalRoleoptionalIRoleRefretrieval_roleoptionalIRoleRefretrievalRoleoptionalIRoleRefRetrievalRoleoptionalIRoleRefRetrievalRoleoptionalIRoleRef#The IAM role to retrieve the configuration.
Default: A role is generated.
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.