interface ConfigurationProps

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

Properties for the Configuration construct.

Example

// 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';

declare const application: appconfig.Application;
declare const deploymentStrategy: appconfig.DeploymentStrategy;
declare const environment: appconfig.Environment;
declare const key: kms.Key;
declare const validator: appconfig.IValidator;
const configurationProps: appconfig.ConfigurationProps = {
  application: application,

  // the properties below are optional
  deletionProtectionCheck: appconfig.DeletionProtectionCheck.ACCOUNT_DEFAULT,
  deploymentKey: key,
  deploymentStrategy: deploymentStrategy,
  deployTo: [environment],
  description: 'description',
  name: 'name',
  type: appconfig.ConfigurationType.FREEFORM,
  validators: [validator],
};

Properties

Name	Type	Description
application	IApplication	The application associated with the 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.
name?	string	The name of the configuration.
type?	ConfigurationType	The type of configuration.
validators?	IValidator[]	The validators for the configuration.

---

application

Type: IApplication

The application associated with the 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.

---

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.