Package software.amazon.awscdk.services.appconfig

Interface SourcedConfigurationProps

All Superinterfaces:

ConfigurationOptions, ConfigurationProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourcedConfigurationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-22T02:23:56.579Z")
@Stability(Stable)
public interface SourcedConfigurationProps
extends software.amazon.jsii.JsiiSerializable, ConfigurationProps

Properties for SourcedConfiguration.

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

Modifier and Type	Interface	Description
static final class	SourcedConfigurationProps.Builder	A builder for SourcedConfigurationProps
static final class	SourcedConfigurationProps.Jsii$Proxy	An implementation for SourcedConfigurationProps

Method Summary

Modifier and Type	Method	Description
static SourcedConfigurationProps.Builder	builder()
ConfigurationSource	getLocation()	The location where the configuration is stored.
default IRole	getRetrievalRole()	The IAM role to retrieve the configuration.
default String	getVersionNumber()	The version number of the sourced configuration to deploy.

Methods inherited from interface software.amazon.awscdk.services.appconfig.ConfigurationOptions

getDeploymentKey, getDeploymentStrategy, getDeployTo, getDescription, getName, getType, getValidators

Methods inherited from interface software.amazon.awscdk.services.appconfig.ConfigurationProps

getApplication

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getLocation

@Stability(Stable)
@NotNull
ConfigurationSource getLocation()

The location where the configuration is stored.

getRetrievalRole

@Stability(Stable)
@Nullable
default IRole getRetrievalRole()

The IAM role to retrieve the configuration.

Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.

getVersionNumber

@Stability(Stable)
@Nullable
default String getVersionNumber()

The version number of the sourced configuration to deploy.

If this is not specified, then there will be no deployment.

Default: - None.

builder

@Stability(Stable)
static SourcedConfigurationProps.Builder builder()

Returns:

a SourcedConfigurationProps.Builder of SourcedConfigurationProps