Class SourcedConfiguration
(deprecated) 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
Namespace: Amazon.CDK.AWS.AppConfig.Alpha
Assembly: Amazon.CDK.AWS.AppConfig.Alpha.dll
Syntax (csharp)
public class SourcedConfiguration : Construct, IConfiguration, IExtensible
Syntax (vb)
Public Class SourcedConfiguration
Inherits Construct
Implements IConfiguration, IExtensible
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppConfig.Alpha;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.KMS;
Application application;
ConfigurationSource configurationSource;
DeploymentStrategy deploymentStrategy;
Environment environment;
Key key;
Role role;
IValidator validator;
var sourcedConfiguration = new SourcedConfiguration(this, "MySourcedConfiguration", new SourcedConfigurationProps {
Application = application,
Location = configurationSource,
// the properties below are optional
DeploymentKey = key,
DeploymentStrategy = deploymentStrategy,
DeployTo = new [] { environment },
Description = "description",
Name = "name",
RetrievalRole = role,
Type = ConfigurationType.FREEFORM,
Validators = new [] { validator },
VersionNumber = "versionNumber"
});
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 | (deprecated) The application associated with the configuration. |
ApplicationId | |
ConfigurationProfileArn | (deprecated) The Amazon Resource Name (ARN) of the configuration profile. |
ConfigurationProfileId | (deprecated) The ID of the configuration profile. |
DeploymentKey | (deprecated) The deployment key for the configuration. |
DeploymentStrategy | (deprecated) The deployment strategy for the configuration. |
DeployTo | (deprecated) The environments to deploy to. |
Description | (deprecated) The description of the configuration. |
Extensible | |
Location | (deprecated) The location where the configuration is stored. |
Name | (deprecated) The name of the configuration. |
RetrievalRole | (deprecated) The IAM role to retrieve the configuration. |
SourceKey | (deprecated) The key to decrypt the configuration if applicable. |
Type | (deprecated) The configuration type. |
Validators | (deprecated) The validators for the configuration. |
VersionNumber | (deprecated) The version number of the configuration to deploy. |
Methods
AddExistingEnvironmentsToApplication() | |
AddExtension(IExtension) | (deprecated) Adds an extension association to the configuration profile. |
Deploy(IEnvironment) | (deprecated) Deploys the configuration to the specified environment. |
DeployConfigToEnvironments() | |
On(ActionPoint, IEventDestination, IExtensionOptions) | (deprecated) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile. |
OnDeploymentBaking(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile. |
OnDeploymentComplete(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile. |
OnDeploymentRolledBack(IEventDestination, IExtensionOptions) | (deprecated) 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) | (deprecated) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile. |
OnDeploymentStep(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile. |
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions) | (deprecated) 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) | (deprecated) 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
Remarks
Stability: Deprecated
Properties
Application
(deprecated) The application associated with the configuration.
public virtual IApplication Application { get; }
Property Value
Remarks
Stability: Deprecated
ApplicationId
protected virtual string ApplicationId { get; set; }
Property Value
System.String
Remarks
Stability: Deprecated
ConfigurationProfileArn
(deprecated) The Amazon Resource Name (ARN) of the configuration profile.
public virtual string ConfigurationProfileArn { get; }
Property Value
System.String
Remarks
Stability: Deprecated
ConfigurationProfileId
(deprecated) The ID of the configuration profile.
public virtual string ConfigurationProfileId { get; }
Property Value
System.String
Remarks
Stability: Deprecated
DeploymentKey
(deprecated) The deployment key for the configuration.
public virtual IKey DeploymentKey { get; }
Property Value
Remarks
Stability: Deprecated
DeploymentStrategy
(deprecated) The deployment strategy for the configuration.
public virtual IDeploymentStrategy DeploymentStrategy { get; }
Property Value
Remarks
Stability: Deprecated
DeployTo
(deprecated) The environments to deploy to.
public virtual IEnvironment[] DeployTo { get; }
Property Value
Remarks
Stability: Deprecated
Description
(deprecated) The description of the configuration.
public virtual string Description { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Extensible
protected virtual ExtensibleBase Extensible { get; set; }
Property Value
Remarks
Stability: Deprecated
Location
(deprecated) The location where the configuration is stored.
public virtual ConfigurationSource Location { get; }
Property Value
Remarks
Stability: Deprecated
Name
(deprecated) The name of the configuration.
public virtual string Name { get; }
Property Value
System.String
Remarks
Stability: Deprecated
RetrievalRole
(deprecated) The IAM role to retrieve the configuration.
public virtual IRole RetrievalRole { get; }
Property Value
Remarks
Stability: Deprecated
SourceKey
(deprecated) The key to decrypt the configuration if applicable.
public virtual IKey SourceKey { get; }
Property Value
Remarks
This key can be used when storing configuration in AWS Secrets Manager, Systems Manager Parameter Store, or Amazon S3.
Stability: Deprecated
Type
(deprecated) The configuration type.
public virtual Nullable<ConfigurationType> Type { get; }
Property Value
System.Nullable<ConfigurationType>
Remarks
Stability: Deprecated
Validators
(deprecated) The validators for the configuration.
public virtual IValidator[] Validators { get; }
Property Value
Remarks
Stability: Deprecated
VersionNumber
(deprecated) The version number of the configuration to deploy.
public virtual string VersionNumber { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Methods
AddExistingEnvironmentsToApplication()
protected virtual void AddExistingEnvironmentsToApplication()
Remarks
Stability: Deprecated
AddExtension(IExtension)
(deprecated) 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
Stability: Deprecated
Deploy(IEnvironment)
(deprecated) Deploys the configuration to the specified environment.
public virtual void Deploy(IEnvironment environment)
Parameters
- environment IEnvironment
The environment to deploy the configuration to.
Remarks
Stability: Deprecated
DeployConfigToEnvironments()
protected virtual void DeployConfigToEnvironments()
Remarks
Stability: Deprecated
On(ActionPoint, IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
OnDeploymentBaking(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
OnDeploymentComplete(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
OnDeploymentRolledBack(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
OnDeploymentStart(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
OnDeploymentStep(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated
PreStartDeployment(IEventDestination, IExtensionOptions)
(deprecated) 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
Stability: Deprecated