Skip to content
v2.273.0

HostedConfigurationProps Struct ​

Properties for HostedConfiguration.

Example ​

ts
declare const application: appconfig.Application;
declare const fn: lambda.Function;

new appconfig.HostedConfiguration(this, 'MyHostedConfiguration', {
  application,
  content: appconfig.ConfigurationContent.fromInlineText('This is my configuration content.'),
  validators: [
    appconfig.JsonSchemaValidator.fromFile('schema.json'),
    appconfig.LambdaValidator.fromFunction(fn),
  ],
});

Properties ​

applicationIApplicationapplicationIApplicationapplicationIApplicationApplicationIApplicationApplicationIApplicationrequired#
The application associated with the configuration.
The content of the hosted configuration.
deletionProtectionCheckDeletionProtectionCheckdeletion_protection_checkDeletionProtectionCheckdeletionProtectionCheckDeletionProtectionCheckDeletionProtectionCheckDeletionProtectionCheckDeletionProtectionCheckDeletionProtectionCheck= DeletionProtectionCheck.ACCOUNT_…#
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.

default

Default: DeletionProtectionCheck.ACCOUNT_DEFAULT

deploymentKeyIKeydeployment_keyIKeydeploymentKeyIKeyDeploymentKeyIKeyDeploymentKeyIKey= None.#
The deployment key of the configuration.
deploymentStrategyIDeploymentStrategyRefdeployment_strategyIDeploymentStrategyRefdeploymentStrategyIDeploymentStrategyRefDeploymentStrategyIDeploymentStrategyRefDeploymentStrategyIDeploymentStrategyRef= A deployment strategy with the r…#
The deployment strategy for the configuration.
default

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

deployToIEnvironment[]deploy_totyping.List[IEnvironment]deployToList<IEnvironment>DeployToIEnvironment[]DeployTo*[]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.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= No description.#
The description of the configuration.
kmsKeyIKeyRefkms_keyIKeyRefkmsKeyIKeyRefKmsKeyIKeyRefKmsKeyIKeyRef= None#
The customer managed key to encrypt hosted configuration.
latestVersionNumbernumberlatest_version_numberint | floatlatestVersionNumberNumberLatestVersionNumberdoubleLatestVersionNumber*float64= None.#
The latest version number of the hosted configuration.
namestringnamestrnameStringNamestringName*string= A name is generated.#
The name of the configuration.
The type of configuration.
validatorsIValidator[]validatorstyping.List[IValidator]validatorsList<IValidator>ValidatorsIValidator[]Validators*[]IValidator= No validators.#
The validators for the configuration.
versionLabelstringversion_labelstrversionLabelStringVersionLabelstringVersionLabel*string= None.#
The version label of the hosted configuration.

Used as props by ​