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.98.0 (build 00b106d)", date="2024-05-30T02:11:01.813Z") @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();
 
  • 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

      @Stability(Stable) public void addExtension(@NotNull IExtension extension)
      Adds an extension association to the configuration profile.

      Specified by:
      addExtension in interface IExtensible
      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 interface IExtensible
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • onDeploymentBaking

      @Stability(Stable) public void onDeploymentBaking(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • onDeploymentComplete

      @Stability(Stable) public void onDeploymentComplete(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • onDeploymentRolledBack

      @Stability(Stable) public void onDeploymentRolledBack(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • onDeploymentStart

      @Stability(Stable) public void onDeploymentStart(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • onDeploymentStep

      @Stability(Stable) public void onDeploymentStep(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      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 interface IExtensible
      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 interface IExtensible
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
      options - Options for the extension.
    • preStartDeployment

      @Stability(Stable) public void preStartDeployment(@NotNull IEventDestination eventDestination)
      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 interface IExtensible
      Parameters:
      eventDestination - The event that occurs during the extension. This parameter is required.
    • getApplication

      @Stability(Stable) @NotNull public IApplication getApplication()
      The application associated with the configuration.
      Specified by:
      getApplication in interface IConfiguration
    • getConfigurationProfileArn

      @Stability(Stable) @NotNull public String getConfigurationProfileArn()
      The Amazon Resource Name (ARN) of the configuration profile.
    • getConfigurationProfileId

      @Stability(Stable) @NotNull public String getConfigurationProfileId()
      The ID of the configuration profile.
      Specified by:
      getConfigurationProfileId in interface IConfiguration
    • getLocation

      @Stability(Stable) @NotNull public ConfigurationSource getLocation()
      The location where the configuration is stored.
    • getDeploymentKey

      @Stability(Stable) @Nullable public IKey getDeploymentKey()
      The deployment key for the configuration.
      Specified by:
      getDeploymentKey in interface IConfiguration
    • getDeploymentStrategy

      @Stability(Stable) @Nullable public IDeploymentStrategy getDeploymentStrategy()
      The deployment strategy for the configuration.
      Specified by:
      getDeploymentStrategy in interface IConfiguration
    • getDeployTo

      @Stability(Stable) @Nullable public List<IEnvironment> getDeployTo()
      The environments to deploy to.
      Specified by:
      getDeployTo in interface IConfiguration
    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the configuration.
      Specified by:
      getDescription in interface IConfiguration
    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the configuration.
      Specified by:
      getName in interface IConfiguration
    • getRetrievalRole

      @Stability(Stable) @Nullable public IRole getRetrievalRole()
      The IAM role to retrieve the configuration.
    • getSourceKey

      @Stability(Stable) @Nullable public IKey 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

      @Stability(Stable) @Nullable public ConfigurationType getType()
      The configuration type.
      Specified by:
      getType in interface IConfiguration
    • getValidators

      @Stability(Stable) @Nullable public List<IValidator> getValidators()
      The validators for the configuration.
      Specified by:
      getValidators in interface IConfiguration
    • getVersionNumber

      @Stability(Stable) @Nullable public String getVersionNumber()
      The version number of the configuration to deploy.
      Specified by:
      getVersionNumber in interface IConfiguration
    • getApplicationId

      @Stability(Stable) @NotNull protected String getApplicationId()
    • setApplicationId

      @Stability(Stable) protected void setApplicationId(@NotNull String value)
    • getExtensible

      @Stability(Stable) @NotNull protected ExtensibleBase getExtensible()
    • setExtensible

      @Stability(Stable) protected void setExtensible(@NotNull ExtensibleBase value)