class SourcedConfiguration (construct)
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.SourcedConfiguration |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#SourcedConfiguration |
Java | software.amazon.awscdk.services.appconfig.alpha.SourcedConfiguration |
Python | aws_cdk.aws_appconfig_alpha.SourcedConfiguration |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » SourcedConfiguration |
⚠️ Deprecated: undefined
Implements
IConstruct
, IDependable
, IConfiguration
, IExtensible
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
declare const application: appconfig_alpha.Application;
declare const configurationSource: appconfig_alpha.ConfigurationSource;
declare const deploymentStrategy: appconfig_alpha.DeploymentStrategy;
declare const environment: appconfig_alpha.Environment;
declare const key: kms.Key;
declare const role: iam.Role;
declare const validator: appconfig_alpha.IValidator;
const sourcedConfiguration = new appconfig_alpha.SourcedConfiguration(this, 'MySourcedConfiguration', {
application: application,
location: configurationSource,
// the properties below are optional
deploymentKey: key,
deploymentStrategy: deploymentStrategy,
deployTo: [environment],
description: 'description',
name: 'name',
retrievalRole: role,
type: appconfig_alpha.ConfigurationType.FREEFORM,
validators: [validator],
versionNumber: 'versionNumber',
});
Initializer
new SourcedConfiguration(scope: Construct, id: string, props: SourcedConfigurationProps)
⚠️ Deprecated: undefined
Parameters
- scope
Construct
- id
string
- props
Sourced
Configuration Props
Construct Props
Name | Type | Description |
---|---|---|
application | IApplication | The application associated with the configuration. |
location | Configuration | The location where the configuration is stored. |
deploy | IEnvironment [] | The list of environments to deploy the configuration to. |
deployment | IKey | The deployment key of the configuration. |
deployment | IDeployment | The deployment strategy for the configuration. |
description? | string | The description of the configuration. |
name? | string | The name of the configuration. |
retrieval | IRole | The IAM role to retrieve the configuration. |
type? | Configuration | The type of configuration. |
validators? | IValidator [] | The validators for the configuration. |
version | string | The version number of the sourced configuration to deploy. |
application
⚠️ Deprecated: undefined
Type:
IApplication
The application associated with the configuration.
location
⚠️ Deprecated: undefined
Type:
Configuration
The location where the configuration is stored.
deployTo?
⚠️ Deprecated: undefined
Type:
IEnvironment
[]
(optional, default: None.)
The list of environments to deploy the configuration to.
If this parameter is not specified, then there will be no deployment.
deploymentKey?
⚠️ Deprecated: undefined
Type:
IKey
(optional, default: None.)
The deployment key of the configuration.
deploymentStrategy?
⚠️ Deprecated: undefined
Type:
IDeployment
(optional, default: A deployment strategy with the rollout strategy set to
RolloutStrategy.CANARY_10_PERCENT_20_MINUTES)
The deployment strategy for the configuration.
description?
⚠️ Deprecated: undefined
Type:
string
(optional, default: No description.)
The description of the configuration.
name?
⚠️ Deprecated: undefined
Type:
string
(optional, default: A name is generated.)
The name of the configuration.
retrievalRole?
⚠️ Deprecated: undefined
Type:
IRole
(optional, default: A role is generated.)
The IAM role to retrieve the configuration.
type?
⚠️ Deprecated: undefined
Type:
Configuration
(optional, default: ConfigurationType.FREEFORM)
The type of configuration.
validators?
⚠️ Deprecated: undefined
Type:
IValidator
[]
(optional, default: No validators.)
The validators for the configuration.
versionNumber?
⚠️ Deprecated: undefined
Type:
string
(optional, default: None.)
The version number of the sourced configuration to deploy.
If this is not specified, then there will be no deployment.
Properties
Name | Type | Description |
---|---|---|
application | IApplication | The application associated with the configuration. |
application | string | |
configuration | string | The Amazon Resource Name (ARN) of the configuration profile. |
configuration | string | The ID of the configuration profile. |
extensible | Extensible | |
location | Configuration | The location where the configuration is stored. |
node | Node | The tree node. |
deploy | IEnvironment [] | The environments to deploy to. |
deployment | IKey | The deployment key for the configuration. |
deployment | IDeployment | The deployment strategy for the configuration. |
description? | string | The description of the configuration. |
name? | string | The name of the configuration. |
retrieval | IRole | The IAM role to retrieve the configuration. |
source | IKey | The key to decrypt the configuration if applicable. |
type? | Configuration | The configuration type. |
validators? | IValidator [] | The validators for the configuration. |
version | string | The version number of the configuration to deploy. |
application
⚠️ Deprecated: undefined
Type:
IApplication
The application associated with the configuration.
applicationId
⚠️ Deprecated: undefined
Type:
string
configurationProfileArn
⚠️ Deprecated: undefined
Type:
string
The Amazon Resource Name (ARN) of the configuration profile.
configurationProfileId
⚠️ Deprecated: undefined
Type:
string
The ID of the configuration profile.
extensible
⚠️ Deprecated: undefined
Type:
Extensible
location
⚠️ Deprecated: undefined
Type:
Configuration
The location where the configuration is stored.
node
⚠️ Deprecated: undefined
Type:
Node
The tree node.
deployTo?
⚠️ Deprecated: undefined
Type:
IEnvironment
[]
(optional)
The environments to deploy to.
deploymentKey?
⚠️ Deprecated: undefined
Type:
IKey
(optional)
The deployment key for the configuration.
deploymentStrategy?
⚠️ Deprecated: undefined
Type:
IDeployment
(optional)
The deployment strategy for the configuration.
description?
⚠️ Deprecated: undefined
Type:
string
(optional)
The description of the configuration.
name?
⚠️ Deprecated: undefined
Type:
string
(optional)
The name of the configuration.
retrievalRole?
⚠️ Deprecated: undefined
Type:
IRole
(optional)
The IAM role to retrieve the configuration.
sourceKey?
⚠️ Deprecated: undefined
Type:
IKey
(optional)
The key to decrypt the configuration if applicable.
This key can be used when storing configuration in AWS Secrets Manager, Systems Manager Parameter Store, or Amazon S3.
type?
⚠️ Deprecated: undefined
Type:
Configuration
(optional)
The configuration type.
validators?
⚠️ Deprecated: undefined
Type:
IValidator
[]
(optional)
The validators for the configuration.
versionNumber?
⚠️ Deprecated: undefined
Type:
string
(optional)
The version number of the configuration to deploy.
Methods
Name | Description |
---|---|
add | Adds an extension association to the configuration profile. |
deploy(environment) | Deploys the configuration to the specified environment. |
on(actionPoint, eventDestination, options?) | Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile. |
on | Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile. |
pre | Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile. |
pre | Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile. |
to | Returns a string representation of this construct. |
protected add | |
protected deploy |
Extension(extension)
addpublic addExtension(extension: IExtension): void
⚠️ Deprecated: undefined
Parameters
- extension
IExtension
— The extension to create an association for.
Adds an extension association to the configuration profile.
deploy(environment)
public deploy(environment: IEnvironment): void
⚠️ Deprecated: Use deployTo
as a property instead. We do not recommend
creating resources in multiple stacks. If you want to do this still,
please take a look into https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig.CfnDeployment.html.
Parameters
- environment
IEnvironment
— The environment to deploy the configuration to.
Deploys the configuration to the specified environment.
on(actionPoint, eventDestination, options?)
public on(actionPoint: ActionPoint, eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- actionPoint
Action
— The action point which triggers the event.Point - eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.
DeploymentBaking(eventDestination, options?)
onpublic onDeploymentBaking(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentComplete(eventDestination, options?)
onpublic onDeploymentComplete(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentRolledBack(eventDestination, options?)
onpublic onDeploymentRolledBack(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentStart(eventDestination, options?)
onpublic onDeploymentStart(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.
DeploymentStep(eventDestination, options?)
onpublic onDeploymentStep(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.
CreateHostedConfigurationVersion(eventDestination, options?)
prepublic preCreateHostedConfigurationVersion(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.
StartDeployment(eventDestination, options?)
prepublic preStartDeployment(eventDestination: IEventDestination, options?: ExtensionOptions): void
⚠️ Deprecated: undefined
Parameters
- eventDestination
IEvent
— The event that occurs during the extension.Destination - options
Extension
— Options for the extension.Options
Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.
String()
topublic toString(): string
⚠️ Deprecated: undefined
Returns
string
Returns a string representation of this construct.
ExistingEnvironmentsToApplication()
protected addprotected addExistingEnvironmentsToApplication(): void
⚠️ Deprecated: undefined
ConfigToEnvironments()
protected deployprotected deployConfigToEnvironments(): void
⚠️ Deprecated: undefined