Class SourcedConfiguration

A sourced configuration represents configuration stored in an Amazon S3 bucket, AWS Secrets Manager secret, Systems Manager (SSM) Parameter Store parameter, SSM document, or AWS CodePipeline.

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

ExampleMetadata: infused

Examples
Application application;
Bucket bucket;


new SourcedConfiguration(this, "MySourcedConfiguration", new SourcedConfigurationProps {
    Application = application,
    Location = ConfigurationSource.FromBucket(bucket, "path/to/file.json"),
    Type = ConfigurationType.FEATURE_FLAGS,
    Name = "MyConfig",
    Description = "This is my sourced configuration from CDK."
});

Synopsis

Constructors

SourcedConfiguration(ByRefValue)

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

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

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.
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
Location

The location where the configuration is stored.
Name

The name of the configuration.
RetrievalRole

The IAM role to retrieve the configuration.
SourceKey

The key to decrypt the configuration if applicable.
Type

The configuration type.
Validators

The validators for the configuration.
VersionNumber

The version number of the configuration to deploy.

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

SourcedConfiguration(ByRefValue)

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

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

The Javascript-owned object reference

SourcedConfiguration(DeputyBase.DeputyProps)

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

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

The deputy props

SourcedConfiguration(Construct, String, ISourcedConfigurationProps)

public SourcedConfiguration(Construct scope, string id, ISourcedConfigurationProps props)
Parameters
scope Constructs.Construct
id System.String
props ISourcedConfigurationProps

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

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

Location

The location where the configuration is stored.

public virtual ConfigurationSource Location { get; }
Property Value

ConfigurationSource

Name

The name of the configuration.

public virtual string Name { get; }
Property Value

System.String

RetrievalRole

The IAM role to retrieve the configuration.

public virtual IRole RetrievalRole { get; }
Property Value

IRole

SourceKey

The key to decrypt the configuration if applicable.

public virtual IKey SourceKey { get; }
Property Value

IKey

Remarks

This key can be used when storing configuration in AWS Secrets Manager, Systems Manager Parameter Store, or Amazon S3.

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[]

VersionNumber

The version number of the configuration to deploy.

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