interface ConfigurationOptions
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppConfig.ConfigurationOptions |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#ConfigurationOptions |
![]() | software.amazon.awscdk.services.appconfig.ConfigurationOptions |
![]() | aws_cdk.aws_appconfig.ConfigurationOptions |
![]() | aws-cdk-lib » aws_appconfig » ConfigurationOptions |
Options 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 deploymentStrategy: appconfig.DeploymentStrategy;
declare const environment: appconfig.Environment;
declare const key: kms.Key;
declare const validator: appconfig.IValidator;
const configurationOptions: appconfig.ConfigurationOptions = {
deploymentKey: key,
deploymentStrategy: deploymentStrategy,
deployTo: [environment],
description: 'description',
name: 'name',
type: appconfig.ConfigurationType.FREEFORM,
validators: [validator],
};
Properties
Name | Type | Description |
---|---|---|
deploy | IEnvironment [] | The list of environments to deploy the configuration to. |
deployment | IKey | The deployment key of the configuration. |
deployment | IDeployment | The deployment strategy for the configuration. |
description? | string | The description of the configuration. |
name? | string | The name of the configuration. |
type? | Configuration | The type of configuration. |
validators? | IValidator [] | The validators for the configuration. |
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:
IDeployment
(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:
Configuration
(optional, default: ConfigurationType.FREEFORM)
The type of configuration.
validators?
Type:
IValidator
[]
(optional, default: No validators.)
The validators for the configuration.