Class SourcedConfiguration
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.services.appconfig.alpha.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-08T21:35:15.601Z")
@Stability(Deprecated)
@Deprecated
public class SourcedConfiguration
extends software.constructs.Construct
implements IConfiguration, IExtensible
Deprecated.
(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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.appconfig.alpha.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.services.kms.*; Application application; ConfigurationSource configurationSource; DeploymentStrategy deploymentStrategy; Environment environment; Key key; Role role; IValidator validator; SourcedConfiguration sourcedConfiguration = SourcedConfiguration.Builder.create(this, "MySourcedConfiguration") .application(application) .location(configurationSource) // the properties below are optional .deploymentKey(key) .deploymentStrategy(deploymentStrategy) .deployTo(List.of(environment)) .description("description") .name("name") .retrievalRole(role) .type(ConfigurationType.FREEFORM) .validators(List.of(validator)) .versionNumber("versionNumber") .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.alpha.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.alpha.IExtensible
IExtensible.Jsii$Default, IExtensible.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
SourcedConfiguration
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated.protected
SourcedConfiguration
(software.amazon.jsii.JsiiObjectRef objRef) Deprecated.SourcedConfiguration
(software.constructs.Construct scope, String id, SourcedConfigurationProps props) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
Deprecated.void
addExtension
(IExtension extension) Deprecated.void
deploy
(IEnvironment environment) Deprecated.protected void
Deprecated.Deprecated.protected String
Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.Deprecated.protected ExtensibleBase
Deprecated.Deprecated.getName()
Deprecated.Deprecated.Deprecated.getType()
Deprecated.Deprecated.Deprecated.void
on
(ActionPoint actionPoint, IEventDestination eventDestination) Deprecated.void
on
(ActionPoint actionPoint, IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
onDeploymentBaking
(IEventDestination eventDestination) Deprecated.void
onDeploymentBaking
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
onDeploymentComplete
(IEventDestination eventDestination) Deprecated.void
onDeploymentComplete
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
onDeploymentRolledBack
(IEventDestination eventDestination) Deprecated.void
onDeploymentRolledBack
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
onDeploymentStart
(IEventDestination eventDestination) Deprecated.void
onDeploymentStart
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
onDeploymentStep
(IEventDestination eventDestination) Deprecated.void
onDeploymentStep
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
preCreateHostedConfigurationVersion
(IEventDestination eventDestination) Deprecated.void
preCreateHostedConfigurationVersion
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.void
preStartDeployment
(IEventDestination eventDestination) Deprecated.void
preStartDeployment
(IEventDestination eventDestination, ExtensionOptions options) Deprecated.protected void
setApplicationId
(String value) Deprecated.protected void
setExtensible
(ExtensibleBase value) Deprecated.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) Deprecated. -
SourcedConfiguration
protected SourcedConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) Deprecated. -
SourcedConfiguration
@Stability(Deprecated) @Deprecated public SourcedConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull SourcedConfigurationProps props) Deprecated.- Parameters:
scope
- This parameter is required.id
- This parameter is required.props
- This parameter is required.
-
-
Method Details
-
addExistingEnvironmentsToApplication
Deprecated. -
addExtension
Deprecated.(deprecated) 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.
-
deploy
Deprecated.UsedeployTo
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.(deprecated) Deploys the configuration to the specified environment.- Parameters:
environment
- The environment to deploy the configuration to. This parameter is required.
-
deployConfigToEnvironments
Deprecated. -
on
@Stability(Deprecated) @Deprecated public void on(@NotNull ActionPoint actionPoint, @NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void on(@NotNull ActionPoint actionPoint, @NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void onDeploymentBaking(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void onDeploymentBaking(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void onDeploymentComplete(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void onDeploymentComplete(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void onDeploymentRolledBack(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void onDeploymentRolledBack(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void onDeploymentStart(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void onDeploymentStart(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void onDeploymentStep(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void onDeploymentStep(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void preCreateHostedConfigurationVersion(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void preCreateHostedConfigurationVersion(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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(Deprecated) @Deprecated public void preStartDeployment(@NotNull IEventDestination eventDestination, @Nullable ExtensionOptions options) Deprecated.(deprecated) 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
@Stability(Deprecated) @Deprecated public void preStartDeployment(@NotNull IEventDestination eventDestination) Deprecated.(deprecated) 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
Deprecated.(deprecated) The application associated with the configuration.- Specified by:
getApplication
in interfaceIConfiguration
-
getConfigurationProfileArn
Deprecated.(deprecated) The Amazon Resource Name (ARN) of the configuration profile. -
getConfigurationProfileId
Deprecated.(deprecated) The ID of the configuration profile.- Specified by:
getConfigurationProfileId
in interfaceIConfiguration
-
getLocation
Deprecated.(deprecated) The location where the configuration is stored. -
getDeploymentKey
Deprecated.(deprecated) The deployment key for the configuration.- Specified by:
getDeploymentKey
in interfaceIConfiguration
-
getDeploymentStrategy
Deprecated.(deprecated) The deployment strategy for the configuration.- Specified by:
getDeploymentStrategy
in interfaceIConfiguration
-
getDeployTo
Deprecated.(deprecated) The environments to deploy to.- Specified by:
getDeployTo
in interfaceIConfiguration
-
getDescription
Deprecated.(deprecated) The description of the configuration.- Specified by:
getDescription
in interfaceIConfiguration
-
getName
Deprecated.(deprecated) The name of the configuration.- Specified by:
getName
in interfaceIConfiguration
-
getRetrievalRole
Deprecated.(deprecated) The IAM role to retrieve the configuration. -
getSourceKey
Deprecated.(deprecated) 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
Deprecated.(deprecated) The configuration type.- Specified by:
getType
in interfaceIConfiguration
-
getValidators
Deprecated.(deprecated) The validators for the configuration.- Specified by:
getValidators
in interfaceIConfiguration
-
getVersionNumber
Deprecated.(deprecated) The version number of the configuration to deploy.- Specified by:
getVersionNumber
in interfaceIConfiguration
-
getApplicationId
Deprecated. -
setApplicationId
Deprecated. -
getExtensible
Deprecated. -
setExtensible
Deprecated.
-
deployTo
as a property instead.