Package software.amazon.awscdk.services.appconfig

Class SourcedConfiguration.Builder

java.lang.Object
software.amazon.awscdk.services.appconfig.SourcedConfiguration.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<SourcedConfiguration>
Enclosing class:
SourcedConfiguration
@Stability(Stable) public static final class SourcedConfiguration.Builder extends Object implements software.amazon.jsii.Builder<SourcedConfiguration>
A fluent builder for SourcedConfiguration.

  • Method Details

    • create

      @Stability(Stable) public static SourcedConfiguration.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of SourcedConfiguration.Builder.

    • deploymentKey

      @Stability(Stable) public SourcedConfiguration.Builder deploymentKey(IKey deploymentKey)
      The deployment key of the configuration.

      Default: - None.

      Parameters:
      deploymentKey - The deployment key of the configuration. This parameter is required.
      Returns:
      this

    • deploymentStrategy

      @Stability(Stable) public SourcedConfiguration.Builder deploymentStrategy(IDeploymentStrategy deploymentStrategy)
      The deployment strategy for the configuration.

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

      Parameters:
      deploymentStrategy - The deployment strategy for the configuration. This parameter is required.
      Returns:
      this

    • deployTo

      @Stability(Stable) public SourcedConfiguration.Builder deployTo(List<? extends IEnvironment> deployTo)
      The list of environments to deploy the configuration to.

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

      Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods.

      Default: - None.

      Parameters:
      deployTo - The list of environments to deploy the configuration to. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public SourcedConfiguration.Builder description(String description)
      The description of the configuration.

      Default: - No description.

      Parameters:
      description - The description of the configuration. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public SourcedConfiguration.Builder name(String name)
      The name of the configuration.

      Default: - A name is generated.

      Parameters:
      name - The name of the configuration. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public SourcedConfiguration.Builder type(ConfigurationType type)
      The type of configuration.

      Default: ConfigurationType.FREEFORM

      Parameters:
      type - The type of configuration. This parameter is required.
      Returns:
      this

    • validators

      @Stability(Stable) public SourcedConfiguration.Builder validators(List<? extends IValidator> validators)
      The validators for the configuration.

      Default: - No validators.

      Parameters:
      validators - The validators for the configuration. This parameter is required.
      Returns:
      this

    • application

      @Stability(Stable) public SourcedConfiguration.Builder application(IApplication application)
      The application associated with the configuration.

      Parameters:
      application - The application associated with the configuration. This parameter is required.
      Returns:
      this

    • location

      @Stability(Stable) public SourcedConfiguration.Builder location(ConfigurationSource location)
      The location where the configuration is stored.

      Parameters:
      location - The location where the configuration is stored. This parameter is required.
      Returns:
      this

    • retrievalRole

      @Stability(Stable) public SourcedConfiguration.Builder retrievalRole(IRole retrievalRole)
      The IAM role to retrieve the configuration.

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

      Parameters:
      retrievalRole - The IAM role to retrieve the configuration. This parameter is required.
      Returns:
      this

    • versionNumber

      @Stability(Stable) public SourcedConfiguration.Builder versionNumber(String versionNumber)
      The version number of the sourced configuration to deploy.

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

      Default: - None.

      Parameters:
      versionNumber - The version number of the sourced configuration to deploy. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public SourcedConfiguration build()
      Specified by:
      build in interface software.amazon.jsii.Builder<SourcedConfiguration>
      Returns:
      a newly built instance of SourcedConfiguration.