Class ConfigurationProps
Properties for the Configuration construct.
Inheritance
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ConfigurationProps : Object, IConfigurationProps, IConfigurationOptions
Syntax (vb)
Public Class ConfigurationProps
Inherits Object
Implements IConfigurationProps, IConfigurationOptions
Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppConfig;
using Amazon.CDK.AWS.KMS;
Application application;
DeploymentStrategy deploymentStrategy;
Environment environment;
Key key;
IValidator validator;
var configurationProps = new ConfigurationProps {
Application = application,
// the properties below are optional
DeploymentKey = key,
DeploymentStrategy = deploymentStrategy,
DeployTo = new [] { environment },
Description = "description",
Name = "name",
Type = ConfigurationType.FREEFORM,
Validators = new [] { validator }
};
Synopsis
Constructors
ConfigurationProps() |
Properties
Application | The application associated with the configuration. |
DeploymentKey | The deployment key of the configuration. |
DeploymentStrategy | The deployment strategy for the configuration. |
DeployTo | The list of environments to deploy the configuration to. |
Description | The description of the configuration. |
Name | The name of the configuration. |
Type | The type of configuration. |
Validators | The validators for the configuration. |
Constructors
ConfigurationProps()
public ConfigurationProps()
Properties
Application
The application associated with the configuration.
public IApplication Application { get; set; }
Property Value
DeploymentKey
The deployment key of the configuration.
public IKey DeploymentKey { get; set; }
Property Value
Remarks
Default: - None.
DeploymentStrategy
The deployment strategy for the configuration.
public IDeploymentStrategy DeploymentStrategy { get; set; }
Property Value
Remarks
Default: - A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES
DeployTo
The list of environments to deploy the configuration to.
public IEnvironment[] DeployTo { get; set; }
Property Value
Remarks
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.
Default: - None.
Description
The description of the configuration.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - No description.
Name
The name of the configuration.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - A name is generated.
Type
The type of configuration.
public Nullable<ConfigurationType> Type { get; set; }
Property Value
System.Nullable<ConfigurationType>
Remarks
Default: ConfigurationType.FREEFORM
Validators
The validators for the configuration.
public IValidator[] Validators { get; set; }
Property Value
Remarks
Default: - No validators.