Package software.amazon.awscdk.services.appconfig

Class ConfigurationSource

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.appconfig.ConfigurationSource

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:56.529Z")
@Stability(Stable)
public abstract class ConfigurationSource
extends software.amazon.jsii.JsiiObject

Defines the integrated configuration sources.

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigurationSource()
protected	ConfigurationSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	ConfigurationSource(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static ConfigurationSource	fromBucket(IBucket bucket, String objectKey)	Defines configuration content from an Amazon S3 bucket.
static ConfigurationSource	fromBucket(IBucket bucket, String objectKey, IKey key)	Defines configuration content from an Amazon S3 bucket.
static ConfigurationSource	fromCfnDocument(CfnDocument document)	Defines configuration content from a Systems Manager (SSM) document.
static ConfigurationSource	fromParameter(IParameter parameter)	Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.
static ConfigurationSource	fromParameter(IParameter parameter, IKey key)	Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.
static ConfigurationSource	fromPipeline(IPipeline pipeline)	Defines configuration content from AWS CodePipeline.
static ConfigurationSource	fromSecret(ISecret secret)	Defines configuration content from an AWS Secrets Manager secret.
abstract IKey	getKey()	The KMS Key that encrypts the configuration.
abstract String	getLocationUri()	The URI of the configuration source.
abstract ConfigurationSourceType	getType()	The type of the configuration source.

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, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

ConfigurationSource

protected ConfigurationSource(software.amazon.jsii.JsiiObjectRef objRef)

ConfigurationSource

protected ConfigurationSource(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

ConfigurationSource

@Stability(Stable)
protected ConfigurationSource()

Method Details

fromBucket

@Stability(Stable)
@NotNull
public static ConfigurationSource fromBucket(@NotNull
 IBucket bucket,
 @NotNull
 String objectKey,
 @Nullable
 IKey key)

Defines configuration content from an Amazon S3 bucket.

Parameters:

bucket - The S3 bucket where the configuration is stored. This parameter is required.

objectKey - The path to the configuration. This parameter is required.

key - The KMS Key that the bucket is encrypted with.

fromBucket

@Stability(Stable)
@NotNull
public static ConfigurationSource fromBucket(@NotNull
 IBucket bucket,
 @NotNull
 String objectKey)

Defines configuration content from an Amazon S3 bucket.

Parameters:

bucket - The S3 bucket where the configuration is stored. This parameter is required.

objectKey - The path to the configuration. This parameter is required.

fromCfnDocument

@Stability(Stable)
@NotNull
public static ConfigurationSource fromCfnDocument(@NotNull
 CfnDocument document)

Defines configuration content from a Systems Manager (SSM) document.

Parameters:

document - The SSM document where the configuration is stored. This parameter is required.

fromParameter

@Stability(Stable)
@NotNull
public static ConfigurationSource fromParameter(@NotNull
 IParameter parameter,
 @Nullable
 IKey key)

Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.

Parameters:

parameter - The parameter where the configuration is stored. This parameter is required.

key - The KMS Key that the secure string is encrypted with.

fromParameter

@Stability(Stable)
@NotNull
public static ConfigurationSource fromParameter(@NotNull
 IParameter parameter)

Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.

Parameters:

parameter - The parameter where the configuration is stored. This parameter is required.

fromPipeline

@Stability(Stable)
@NotNull
public static ConfigurationSource fromPipeline(@NotNull
 IPipeline pipeline)

Defines configuration content from AWS CodePipeline.

Parameters:

pipeline - The pipeline where the configuration is stored. This parameter is required.

fromSecret

@Stability(Stable)
@NotNull
public static ConfigurationSource fromSecret(@NotNull
 ISecret secret)

Defines configuration content from an AWS Secrets Manager secret.

Parameters:

secret - The secret where the configuration is stored. This parameter is required.

getLocationUri

@Stability(Stable)
@NotNull
public abstract String getLocationUri()

The URI of the configuration source.

getType

@Stability(Stable)
@NotNull
public abstract ConfigurationSourceType getType()

The type of the configuration source.

getKey

@Stability(Stable)
@Nullable
public abstract IKey getKey()

The KMS Key that encrypts the configuration.