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
object
SourcedConfiguration
Implements
IConstruct
IDependable
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SourcedConfiguration : Construct, IConfiguration, IConstruct, IDependable, IExtensible
Syntax (vb)
Public Class SourcedConfiguration Inherits Construct Implements IConfiguration, IConstruct, IDependable, 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(Construct, string, ISourcedConfigurationProps)

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.

Properties

Application

The application associated with the configuration.
ApplicationId

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

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

The ID of the configuration profile.
DeletionProtectionCheck

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.
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 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.
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()

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.
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 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.
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(Construct, string, ISourcedConfigurationProps)

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.

public SourcedConfiguration(Construct scope, string id, ISourcedConfigurationProps props)
Parameters
scope Construct
id string
props ISourcedConfigurationProps
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."
            });

Properties

Application

The application associated with the configuration.

public virtual IApplication Application { get; }
Property Value

IApplication

Remarks

ExampleMetadata: infused

ApplicationId

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.

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

string

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."
            });

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

DeletionProtectionCheck

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.

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

DeletionProtectionCheck?

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."
            });

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

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

ExtensibleBase

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."
            });

Location

The location where the configuration is stored.

public virtual ConfigurationSource Location { get; }
Property Value

ConfigurationSource

Remarks

ExampleMetadata: infused

Name

The name of the configuration.

public virtual string? Name { get; }
Property Value

string

Remarks

ExampleMetadata: infused

RetrievalRole

The IAM role to retrieve the configuration.

public virtual IRole? RetrievalRole { get; }
Property Value

IRole

Remarks

ExampleMetadata: infused

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

VersionNumber

The version number of the configuration to deploy.

public virtual string? VersionNumber { get; }
Property Value

string

Remarks

ExampleMetadata: infused

Methods

AddExistingEnvironmentsToApplication()

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.

protected virtual void AddExistingEnvironmentsToApplication()
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."
            });

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

protected virtual void DeployConfigToEnvironments()
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."
            });

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