Class HostedConfiguration

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

Inheritance
object
HostedConfiguration
Implements
IConstruct
IDependable
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HostedConfiguration : Construct, IConfiguration, IConstruct, IDependable, IExtensible
Syntax (vb)
Public Class HostedConfiguration Inherits Construct Implements IConfiguration, IConstruct, IDependable, IExtensible
Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

Synopsis

Constructors

HostedConfiguration(Construct, string, IHostedConfigurationProps)

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

Properties

Application

The application associated with the configuration.
ApplicationId

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.
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.
DeletionProtectionCheck

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

The environments to deploy to.
DeploymentKey

The deployment key for the configuration.
DeploymentStrategy

The deployment strategy for the configuration.
Description

The description of the configuration.
Extensible

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.
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()

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.
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()

A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.
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(Construct, string, IHostedConfigurationProps)

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

public HostedConfiguration(Construct scope, string id, IHostedConfigurationProps props)
Parameters
scope Construct
id string
props IHostedConfigurationProps
Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

Properties

Application

The application associated with the configuration.

public virtual IApplication Application { get; }
Property Value

IApplication

Remarks

ExampleMetadata: infused

ApplicationId

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

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

string

Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

ConfigurationProfileArn

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

public virtual string ConfigurationProfileArn { get; }
Property Value

string

Remarks

ExampleMetadata: infused

ConfigurationProfileId

The ID of the configuration profile.

public virtual string ConfigurationProfileId { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Content

The content of the hosted configuration.

public virtual string Content { get; }
Property Value

string

Remarks

ExampleMetadata: infused

ContentType

The content type of the hosted configuration.

public virtual string? ContentType { get; }
Property Value

string

Remarks

ExampleMetadata: infused

DeletionProtectionCheck

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

protected virtual DeletionProtectionCheck? DeletionProtectionCheck { get; set; }
Property Value

DeletionProtectionCheck?

Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

DeployTo

The environments to deploy to.

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

IEnvironment[]

Remarks

ExampleMetadata: infused

DeploymentKey

The deployment key for the configuration.

public virtual IKey? DeploymentKey { get; }
Property Value

IKey

Remarks

ExampleMetadata: infused

DeploymentStrategy

The deployment strategy for the configuration.

public virtual IDeploymentStrategy? DeploymentStrategy { get; }
Property Value

IDeploymentStrategy

Remarks

ExampleMetadata: infused

Description

The description of the configuration.

public virtual string? Description { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Extensible

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

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

ExtensibleBase

Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

HostedConfigurationVersionArn

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

public virtual string HostedConfigurationVersionArn { get; }
Property Value

string

Remarks

ExampleMetadata: infused

LatestVersionNumber

The latest version number of the hosted configuration.

public virtual double? LatestVersionNumber { get; }
Property Value

double?

Remarks

ExampleMetadata: infused

Name

The name of the configuration.

public virtual string? Name { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Type

The configuration type.

public virtual ConfigurationType? Type { get; }
Property Value

ConfigurationType?

Remarks

ExampleMetadata: infused

Validators

The validators for the configuration.

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

IValidator[]

Remarks

ExampleMetadata: infused

VersionLabel

The version label of the hosted configuration.

public virtual string? VersionLabel { get; }
Property Value

string

Remarks

ExampleMetadata: infused

VersionNumber

The version number of the hosted configuration.

public virtual string? VersionNumber { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Methods

AddExistingEnvironmentsToApplication()

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

protected virtual void AddExistingEnvironmentsToApplication()
Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

DeployConfigToEnvironments()

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

protected virtual void DeployConfigToEnvironments()
Remarks

ExampleMetadata: infused

Examples
Application application;
            Function fn;


            new HostedConfiguration(this, "MyHostedConfiguration", new HostedConfigurationProps {
                Application = application,
                Content = ConfigurationContent.FromInlineText("This is my configuration content."),
                Validators = new [] { JsonSchemaValidator.FromFile("schema.json"), LambdaValidator.FromFunction(fn) }
            });

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

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.

Remarks

ExampleMetadata: infused

Implements

Constructs.IConstruct
Constructs.IDependable