interface HostedConfigurationProps

Language	Type name
.NET	Amazon.CDK.AWS.AppConfig.HostedConfigurationProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#HostedConfigurationProps
Java	software.amazon.awscdk.services.appconfig.HostedConfigurationProps
Python	aws_cdk.aws_appconfig.HostedConfigurationProps
TypeScript (source)	aws-cdk-lib » aws_appconfig » HostedConfigurationProps

Properties for HostedConfiguration.

Example

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

Name	Type	Description
application	IApplication	The application associated with the configuration.
content	ConfigurationContent	The content of the hosted configuration.
deletionProtectionCheck?	DeletionProtectionCheck	A parameter to configure deletion protection.
deployTo?	IEnvironment[]	The list of environments to deploy the configuration to.
deploymentKey?	IKey	The deployment key of the configuration.
deploymentStrategy?	IDeploymentStrategy	The deployment strategy for the configuration.
description?	string	The description of the configuration.
kmsKey?	IKeyRef	The customer managed key to encrypt hosted configuration.
latestVersionNumber?	number	The latest version number of the hosted configuration.
name?	string	The name of the configuration.
type?	ConfigurationType	The type of configuration.
validators?	IValidator[]	The validators for the configuration.
versionLabel?	string	The version label of the hosted configuration.

---

application

Type: IApplication

The application associated with the configuration.

---

content

Type: ConfigurationContent

The content of the hosted configuration.

---

deletionProtectionCheck?

Type: DeletionProtectionCheck (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: IDeploymentStrategy (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.

---

kmsKey?

Type: IKeyRef (optional, default: None)

The customer managed key to encrypt hosted configuration.

---

latestVersionNumber?

Type: number (optional, default: None.)

The latest version number of the hosted configuration.

---

name?

Type: string (optional, default: A name is generated.)

The name of the configuration.

---

type?

Type: ConfigurationType (optional, default: ConfigurationType.FREEFORM)

The type of configuration.

---

validators?

Type: IValidator[] (optional, default: No validators.)

The validators for the configuration.

---

versionLabel?

Type: string (optional, default: None.)

The version label of the hosted configuration.