HostedConfigurationOptions Struct
Options for HostedConfiguration.
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';
declare const configurationContent: appconfig.ConfigurationContent;
declare const deploymentStrategyRef: interfaces_appconfig.IDeploymentStrategyRef;
declare const environment: appconfig.Environment;
declare const key: kms.Key;
declare const validator: appconfig.IValidator;
const hostedConfigurationOptions: appconfig.HostedConfigurationOptions = {
content: configurationContent,
// the properties below are optional
deletionProtectionCheck: appconfig.DeletionProtectionCheck.ACCOUNT_DEFAULT,
deploymentKey: key,
deploymentStrategy: deploymentStrategyRef,
deployTo: [environment],
description: 'description',
latestVersionNumber: 123,
name: 'name',
type: appconfig.ConfigurationType.FREEFORM,
validators: [validator],
versionLabel: 'versionLabel',
};
Properties
contentConfigurationContentcontentConfigurationContentcontentConfigurationContentContentConfigurationContentContentConfigurationContentrequired#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
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.
latestVersionNumbernumberlatest_version_numberint | floatlatestVersionNumberNumberLatestVersionNumberdoubleLatestVersionNumber*float64= None.#The latest version number of the hosted configuration.
The name of the configuration.
typeConfigurationTypetypeConfigurationTypetypeConfigurationTypeTypeConfigurationTypeTypeConfigurationType= ConfigurationType.FREEFORM#The type of configuration.
validatorsIValidator[]validatorstyping.List[IValidator]validatorsList<IValidator>ValidatorsIValidator[]Validators*[]IValidator= No validators.#The validators for the configuration.
The version label of the hosted configuration.