Package software.amazon.awscdk.services.appconfig

Interface SourcedConfigurationOptions

All Superinterfaces:

ConfigurationOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SourcedConfigurationOptions.Jsii$Proxy

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

Options for SourcedConfiguration.

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.*;
 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kms.*;
 ConfigurationSource configurationSource;
 DeploymentStrategy deploymentStrategy;
 Environment environment;
 Key key;
 Role role;
 IValidator validator;
 SourcedConfigurationOptions sourcedConfigurationOptions = SourcedConfigurationOptions.builder()
         .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

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

Method Summary

Modifier and Type	Method	Description
static SourcedConfigurationOptions.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.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: - A role is generated.

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 SourcedConfigurationOptions.Builder builder()

Returns:

a SourcedConfigurationOptions.Builder of SourcedConfigurationOptions