Class HostedConfigurationProps
Properties for HostedConfiguration.
Inheritance
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HostedConfigurationProps : Object, IHostedConfigurationProps, IConfigurationProps, IConfigurationOptions
Syntax (vb)
Public Class HostedConfigurationProps
Inherits Object
Implements IHostedConfigurationProps, IConfigurationProps, IConfigurationOptions
Remarks
ExampleMetadata: infused
Examples
var app = new Application(this, "MyApp");
var env = new Environment(this, "MyEnv", new EnvironmentProps {
Application = app
});
new HostedConfiguration(this, "MyHostedConfig", new HostedConfigurationProps {
Application = app,
DeployTo = new [] { env },
Content = ConfigurationContent.FromInlineText("This is my configuration content.")
});
Synopsis
Constructors
HostedConfigurationProps() |
Properties
Application | The application associated with the configuration. |
Content | The content of the hosted 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. |
LatestVersionNumber | The latest version number of the hosted configuration. |
Name | The name of the configuration. |
Type | The type of configuration. |
Validators | The validators for the configuration. |
VersionLabel | The version label of the hosted configuration. |
Constructors
HostedConfigurationProps()
public HostedConfigurationProps()
Properties
Application
The application associated with the configuration.
public IApplication Application { get; set; }
Property Value
Content
The content of the hosted configuration.
public ConfigurationContent Content { 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.
LatestVersionNumber
The latest version number of the hosted configuration.
public Nullable<double> LatestVersionNumber { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - None.
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.
VersionLabel
The version label of the hosted configuration.
public string VersionLabel { get; set; }
Property Value
System.String
Remarks
Default: - None.