Class SourcedConfigurationOptions
Options for SourcedConfiguration.
Inheritance
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SourcedConfigurationOptions : Object, ISourcedConfigurationOptions, IConfigurationOptions
Syntax (vb)
Public Class SourcedConfigurationOptions
Inherits Object
Implements ISourcedConfigurationOptions, 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.IAM;
using Amazon.CDK.AWS.KMS;
ConfigurationSource configurationSource;
DeploymentStrategy deploymentStrategy;
Environment environment;
Key key;
Role role;
IValidator validator;
var sourcedConfigurationOptions = new SourcedConfigurationOptions {
Location = configurationSource,
// the properties below are optional
DeploymentKey = key,
DeploymentStrategy = deploymentStrategy,
DeployTo = new [] { environment },
Description = "description",
Name = "name",
RetrievalRole = role,
Type = ConfigurationType.FREEFORM,
Validators = new [] { validator },
VersionNumber = "versionNumber"
};
Synopsis
Constructors
SourcedConfigurationOptions() |
Properties
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. |
Location | The location where the configuration is stored. |
Name | The name of the configuration. |
RetrievalRole | The IAM role to retrieve the configuration. |
Type | The type of configuration. |
Validators | The validators for the configuration. |
VersionNumber | The version number of the sourced configuration to deploy. |
Constructors
SourcedConfigurationOptions()
public SourcedConfigurationOptions()
Properties
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.
Location
The location where the configuration is stored.
public ConfigurationSource Location { get; set; }
Property Value
Name
The name of the configuration.
public string Name { get; set; }
Property Value
System.String
Remarks
Default: - A name is generated.
RetrievalRole
The IAM role to retrieve the configuration.
public IRole RetrievalRole { get; set; }
Property Value
Remarks
Default: - A role 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.
VersionNumber
The version number of the sourced configuration to deploy.
public string VersionNumber { get; set; }
Property Value
System.String
Remarks
If this is not specified, then there will be no deployment.
Default: - None.