Class SourcedConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.appconfig.SourcedConfiguration
- All Implemented Interfaces:
IConfiguration
,IExtensible
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-10-31T19:12:51.916Z")
@Stability(Stable)
public class SourcedConfiguration
extends software.constructs.Construct
implements 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:
Application application; Bucket bucket; SourcedConfiguration.Builder.create(this, "MySourcedConfiguration") .application(application) .location(ConfigurationSource.fromBucket(bucket, "path/to/file.json")) .type(ConfigurationType.FEATURE_FLAGS) .name("MyConfig") .description("This is my sourced configuration from CDK.") .build();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appconfig.IConfiguration
IConfiguration.Jsii$Default, IConfiguration.Jsii$Proxy
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.appconfig.IExtensible
IExtensible.Jsii$Default, IExtensible.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
SourcedConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
SourcedConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) SourcedConfiguration
(software.constructs.Construct scope, String id, SourcedConfigurationProps props) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
void
addExtension
(IExtension extension) Adds an extension association to the configuration profile.protected void
The application associated with the configuration.protected String
The Amazon Resource Name (ARN) of the configuration profile.The ID of the configuration profile.The deployment key for the configuration.The deployment strategy for the configuration.The environments to deploy to.The description of the configuration.protected ExtensibleBase
The location where the configuration is stored.getName()
The name of the configuration.The IAM role to retrieve the configuration.The key to decrypt the configuration if applicable.getType()
The configuration type.The validators for the configuration.The version number of the configuration to deploy.void
on
(ActionPoint actionPoint, IEventDestination eventDestination) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.void
on
(ActionPoint actionPoint, IEventDestination eventDestination, ExtensionOptions options) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.void
onDeploymentBaking
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentBaking
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentComplete
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentComplete
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentRolledBack
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentRolledBack
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentStart
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentStart
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentStep
(IEventDestination eventDestination) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.void
onDeploymentStep
(IEventDestination eventDestination, ExtensionOptions options) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.void
preCreateHostedConfigurationVersion
(IEventDestination eventDestination) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.void
preCreateHostedConfigurationVersion
(IEventDestination eventDestination, ExtensionOptions options) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.void
preStartDeployment
(IEventDestination eventDestination) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.void
preStartDeployment
(IEventDestination eventDestination, ExtensionOptions options) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.protected void
setApplicationId
(String value) protected void
setExtensible
(ExtensibleBase value) Methods inherited from class software.constructs.Construct
getNode, isConstruct, toString
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.constructs.IConstruct
getNode
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
SourcedConfiguration
protected SourcedConfiguration(software.amazon.jsii.JsiiObjectRef objRef) -
SourcedConfiguration
protected SourcedConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
SourcedConfiguration
@Stability(Stable) public SourcedConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull SourcedConfigurationProps props) - Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
addExistingEnvironmentsToApplication
@Stability(Stable) protected void addExistingEnvironmentsToApplication() -
addExtension
Adds an extension association to the configuration profile.- Specified by:
addExtension
in interfaceIExtensible
- Parameters:
extension
- The extension to create an association for. This parameter is required.
-
deployConfigToEnvironments
@Stability(Stable) protected void deployConfigToEnvironments() -
on
@Stability(Stable) public void on(@NotNull ActionPoint actionPoint, @NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.- Specified by:
on
in interfaceIExtensible
- Parameters:
actionPoint
- The action point which triggers the event. This parameter is required.eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
on
@Stability(Stable) public void on(@NotNull ActionPoint actionPoint, @NotNull IEventDestination eventDestination) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.- Specified by:
on
in interfaceIExtensible
- Parameters:
actionPoint
- The action point which triggers the event. This parameter is required.eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentBaking
@Stability(Stable) public void onDeploymentBaking(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentBaking
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentBaking
Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentBaking
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentComplete
@Stability(Stable) public void onDeploymentComplete(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentComplete
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentComplete
Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentComplete
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentRolledBack
@Stability(Stable) public void onDeploymentRolledBack(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentRolledBack
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentRolledBack
Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentRolledBack
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentStart
@Stability(Stable) public void onDeploymentStart(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentStart
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentStart
Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentStart
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
onDeploymentStep
@Stability(Stable) public void onDeploymentStep(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentStep
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
onDeploymentStep
Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
onDeploymentStep
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
preCreateHostedConfigurationVersion
@Stability(Stable) public void preCreateHostedConfigurationVersion(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
preCreateHostedConfigurationVersion
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
preCreateHostedConfigurationVersion
@Stability(Stable) public void preCreateHostedConfigurationVersion(@NotNull IEventDestination eventDestination) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
preCreateHostedConfigurationVersion
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
preStartDeployment
@Stability(Stable) public void preStartDeployment(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
preStartDeployment
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.options
- Options for the extension.
-
preStartDeployment
Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.- Specified by:
preStartDeployment
in interfaceIExtensible
- Parameters:
eventDestination
- The event that occurs during the extension. This parameter is required.
-
getApplication
The application associated with the configuration.- Specified by:
getApplication
in interfaceIConfiguration
-
getConfigurationProfileArn
The Amazon Resource Name (ARN) of the configuration profile. -
getConfigurationProfileId
The ID of the configuration profile.- Specified by:
getConfigurationProfileId
in interfaceIConfiguration
-
getLocation
The location where the configuration is stored. -
getDeploymentKey
The deployment key for the configuration.- Specified by:
getDeploymentKey
in interfaceIConfiguration
-
getDeploymentStrategy
The deployment strategy for the configuration.- Specified by:
getDeploymentStrategy
in interfaceIConfiguration
-
getDeployTo
The environments to deploy to.- Specified by:
getDeployTo
in interfaceIConfiguration
-
getDescription
The description of the configuration.- Specified by:
getDescription
in interfaceIConfiguration
-
getName
The name of the configuration.- Specified by:
getName
in interfaceIConfiguration
-
getRetrievalRole
The IAM role to retrieve the configuration. -
getSourceKey
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.
-
getType
The configuration type.- Specified by:
getType
in interfaceIConfiguration
-
getValidators
The validators for the configuration.- Specified by:
getValidators
in interfaceIConfiguration
-
getVersionNumber
The version number of the configuration to deploy.- Specified by:
getVersionNumber
in interfaceIConfiguration
-
getApplicationId
-
setApplicationId
-
getExtensible
-
setExtensible
-