Class HostedConfiguration

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.

Inheritance
System.Object
HostedConfiguration
Implements
Constructs.IConstruct
Constructs.IDependable
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HostedConfiguration : Construct, IConfiguration, IExtensible
Syntax (vb)
Public Class HostedConfiguration
    Inherits Construct
    Implements IConfiguration, IExtensible
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

HostedConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference
HostedConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps
HostedConfiguration(Construct, String, IHostedConfigurationProps)

Properties

Application

The application associated with the configuration.
ApplicationId
ConfigurationProfileArn

The Amazon Resource Name (ARN) of the configuration profile.
ConfigurationProfileId

The ID of the configuration profile.
Content

The content of the hosted configuration.
ContentType

The content type of the hosted configuration.
DeploymentKey

The deployment key for the configuration.
DeploymentStrategy

The deployment strategy for the configuration.
DeployTo

The environments to deploy to.
Description

The description of the configuration.
Extensible
HostedConfigurationVersionArn

The Amazon Resource Name (ARN) of the hosted configuration version.
LatestVersionNumber

The latest version number of the hosted configuration.
Name

The name of the configuration.
Type

The configuration type.
Validators

The validators for the configuration.
VersionLabel

The version label of the hosted configuration.
VersionNumber

The version number of the hosted configuration.

Methods

AddExistingEnvironmentsToApplication()
AddExtension(IExtension)

Adds an extension association to the configuration profile.
AtDeploymentTick(IEventDestination, IExtensionOptions)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
DeployConfigToEnvironments()
On(ActionPoint, IEventDestination, IExtensionOptions)

Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.
OnDeploymentBaking(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.
OnDeploymentComplete(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.
OnDeploymentRolledBack(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.
OnDeploymentStart(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.
OnDeploymentStep(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions)

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.
PreStartDeployment(IEventDestination, IExtensionOptions)

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.

Constructors

HostedConfiguration(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected HostedConfiguration(ByRefValue reference)
Parameters
reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

HostedConfiguration(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected HostedConfiguration(DeputyBase.DeputyProps props)
Parameters
props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

HostedConfiguration(Construct, String, IHostedConfigurationProps)

public HostedConfiguration(Construct scope, string id, IHostedConfigurationProps props)
Parameters
scope Constructs.Construct
id System.String
props IHostedConfigurationProps

Properties

Application

The application associated with the configuration.

public virtual IApplication Application { get; }
Property Value

IApplication

ApplicationId

protected virtual string ApplicationId { get; set; }
Property Value

System.String

ConfigurationProfileArn

The Amazon Resource Name (ARN) of the configuration profile.

public virtual string ConfigurationProfileArn { get; }
Property Value

System.String

ConfigurationProfileId

The ID of the configuration profile.

public virtual string ConfigurationProfileId { get; }
Property Value

System.String

Content

The content of the hosted configuration.

public virtual string Content { get; }
Property Value

System.String

ContentType

The content type of the hosted configuration.

public virtual string ContentType { get; }
Property Value

System.String

DeploymentKey

The deployment key for the configuration.

public virtual IKey DeploymentKey { get; }
Property Value

IKey

DeploymentStrategy

The deployment strategy for the configuration.

public virtual IDeploymentStrategy DeploymentStrategy { get; }
Property Value

IDeploymentStrategy

DeployTo

The environments to deploy to.

public virtual IEnvironment[] DeployTo { get; }
Property Value

IEnvironment[]

Description

The description of the configuration.

public virtual string Description { get; }
Property Value

System.String

Extensible

protected virtual ExtensibleBase Extensible { get; set; }
Property Value

ExtensibleBase

HostedConfigurationVersionArn

The Amazon Resource Name (ARN) of the hosted configuration version.

public virtual string HostedConfigurationVersionArn { get; }
Property Value

System.String

LatestVersionNumber

The latest version number of the hosted configuration.

public virtual Nullable<double> LatestVersionNumber { get; }
Property Value

System.Nullable<System.Double>

Name

The name of the configuration.

public virtual string Name { get; }
Property Value

System.String

Type

The configuration type.

public virtual Nullable<ConfigurationType> Type { get; }
Property Value

System.Nullable<ConfigurationType>

Validators

The validators for the configuration.

public virtual IValidator[] Validators { get; }
Property Value

IValidator[]

VersionLabel

The version label of the hosted configuration.

public virtual string VersionLabel { get; }
Property Value

System.String

VersionNumber

The version number of the hosted configuration.

public virtual string VersionNumber { get; }
Property Value

System.String

Methods

AddExistingEnvironmentsToApplication()

protected virtual void AddExistingEnvironmentsToApplication()

AddExtension(IExtension)

Adds an extension association to the configuration profile.

public virtual void AddExtension(IExtension extension)
Parameters
extension IExtension

The extension to create an association for.

AtDeploymentTick(IEventDestination, IExtensionOptions)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.

public virtual void AtDeploymentTick(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

DeployConfigToEnvironments()

protected virtual void DeployConfigToEnvironments()

On(ActionPoint, IEventDestination, IExtensionOptions)

Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.

public virtual void On(ActionPoint actionPoint, IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
actionPoint ActionPoint

The action point which triggers the event.

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentBaking(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void OnDeploymentBaking(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentComplete(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void OnDeploymentComplete(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentRolledBack(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void OnDeploymentRolledBack(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStart(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void OnDeploymentStart(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStep(IEventDestination, IExtensionOptions)

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void OnDeploymentStep(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions)

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void PreCreateHostedConfigurationVersion(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreStartDeployment(IEventDestination, IExtensionOptions)

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.

public virtual void PreStartDeployment(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

Implements

Constructs.IConstruct
Constructs.IDependable