Package software.amazon.awscdk.services.appconfig

Interface ConfigurationOptions

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
ConfigurationProps, HostedConfigurationOptions, HostedConfigurationProps, SourcedConfigurationOptions, SourcedConfigurationProps
All Known Implementing Classes:
ConfigurationOptions.Jsii$Proxy, ConfigurationProps.Jsii$Proxy, HostedConfigurationOptions.Jsii$Proxy, HostedConfigurationProps.Jsii$Proxy, SourcedConfigurationOptions.Jsii$Proxy, SourcedConfigurationProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.94.0 (build b380f01)", date="2024-03-14T22:21:49.817Z") @Stability(Stable) public interface ConfigurationOptions extends software.amazon.jsii.JsiiSerializable
Options for the Configuration construct.

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.kms.*;
 DeploymentStrategy deploymentStrategy;
 Environment environment;
 Key key;
 IValidator validator;
 ConfigurationOptions configurationOptions = ConfigurationOptions.builder()
         .deploymentKey(key)
         .deploymentStrategy(deploymentStrategy)
         .deployTo(List.of(environment))
         .description("description")
         .name("name")
         .type(ConfigurationType.FREEFORM)
         .validators(List.of(validator))
         .build();

  • Method Details

    • getDeploymentKey

      @Stability(Stable) @Nullable default IKey getDeploymentKey()
      The deployment key of the configuration.

      Default: - None.

    • getDeploymentStrategy

      @Stability(Stable) @Nullable default IDeploymentStrategy getDeploymentStrategy()
      The deployment strategy for the configuration.

      Default: - A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

    • getDeployTo

      @Stability(Stable) @Nullable default List<IEnvironment> getDeployTo()
      The list of environments to deploy the configuration to.

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

      Default: - None.

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      The description of the configuration.

      Default: - No description.

    • getName

      @Stability(Stable) @Nullable default String getName()
      The name of the configuration.

      Default: - A name is generated.

    • getType

      @Stability(Stable) @Nullable default ConfigurationType getType()
      The type of configuration.

      Default: ConfigurationType.FREEFORM

    • getValidators

      @Stability(Stable) @Nullable default List<IValidator> getValidators()
      The validators for the configuration.

      Default: - No validators.

    • builder

      @Stability(Stable) static ConfigurationOptions.Builder builder()
      Returns:
      a ConfigurationOptions.Builder of ConfigurationOptions