Package software.amazon.awscdk.services.appconfig

Class SourcedConfigurationOptions.Builder

java.lang.Object

software.amazon.awscdk.services.appconfig.SourcedConfigurationOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SourcedConfigurationOptions>

Enclosing interface:

SourcedConfigurationOptions

@Stability(Stable)
public static final class SourcedConfigurationOptions.Builder
extends Object
implements software.amazon.jsii.Builder<SourcedConfigurationOptions>

A builder for SourcedConfigurationOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SourcedConfigurationOptions	build()	Builds the configured instance.
SourcedConfigurationOptions.Builder	deploymentKey(IKey deploymentKey)	Sets the value of ConfigurationOptions.getDeploymentKey()
SourcedConfigurationOptions.Builder	deploymentStrategy(IDeploymentStrategy deploymentStrategy)	Sets the value of ConfigurationOptions.getDeploymentStrategy()
SourcedConfigurationOptions.Builder	deployTo(List<? extends IEnvironment> deployTo)	Sets the value of ConfigurationOptions.getDeployTo()
SourcedConfigurationOptions.Builder	description(String description)	Sets the value of ConfigurationOptions.getDescription()
SourcedConfigurationOptions.Builder	location(ConfigurationSource location)	Sets the value of SourcedConfigurationOptions.getLocation()
SourcedConfigurationOptions.Builder	name(String name)	Sets the value of ConfigurationOptions.getName()
SourcedConfigurationOptions.Builder	retrievalRole(IRole retrievalRole)	Sets the value of SourcedConfigurationOptions.getRetrievalRole()
SourcedConfigurationOptions.Builder	type(ConfigurationType type)	Sets the value of ConfigurationOptions.getType()
SourcedConfigurationOptions.Builder	validators(List<? extends IValidator> validators)	Sets the value of ConfigurationOptions.getValidators()
SourcedConfigurationOptions.Builder	versionNumber(String versionNumber)	Sets the value of SourcedConfigurationOptions.getVersionNumber()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

location

@Stability(Stable)
public SourcedConfigurationOptions.Builder location(ConfigurationSource location)

Sets the value of SourcedConfigurationOptions.getLocation()

Parameters:

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

Returns:

this

retrievalRole

@Stability(Stable)
public SourcedConfigurationOptions.Builder retrievalRole(IRole retrievalRole)

Sets the value of SourcedConfigurationOptions.getRetrievalRole()

Parameters:

retrievalRole - The IAM role to retrieve the configuration.

Returns:

this

versionNumber

@Stability(Stable)
public SourcedConfigurationOptions.Builder versionNumber(String versionNumber)

Sets the value of SourcedConfigurationOptions.getVersionNumber()

Parameters:

versionNumber - The version number of the sourced configuration to deploy. If this is not specified, then there will be no deployment.

Returns:

this

deploymentKey

@Stability(Stable)
public SourcedConfigurationOptions.Builder deploymentKey(IKey deploymentKey)

Sets the value of ConfigurationOptions.getDeploymentKey()

Parameters:

deploymentKey - The deployment key of the configuration.

Returns:

this

deploymentStrategy

@Stability(Stable)
public SourcedConfigurationOptions.Builder deploymentStrategy(IDeploymentStrategy deploymentStrategy)

Sets the value of ConfigurationOptions.getDeploymentStrategy()

Parameters:

deploymentStrategy - The deployment strategy for the configuration.

Returns:

this

deployTo

@Stability(Stable)
public SourcedConfigurationOptions.Builder deployTo(List<? extends IEnvironment> deployTo)

Sets the value of ConfigurationOptions.getDeployTo()

Parameters:

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.

Returns:

this

description

@Stability(Stable)
public SourcedConfigurationOptions.Builder description(String description)

Sets the value of ConfigurationOptions.getDescription()

Parameters:

description - The description of the configuration.

Returns:

this

name

@Stability(Stable)
public SourcedConfigurationOptions.Builder name(String name)

Sets the value of ConfigurationOptions.getName()

Parameters:

name - The name of the configuration.

Returns:

this

type

@Stability(Stable)
public SourcedConfigurationOptions.Builder type(ConfigurationType type)

Sets the value of ConfigurationOptions.getType()

Parameters:

type - The type of configuration.

Returns:

this

validators

@Stability(Stable)
public SourcedConfigurationOptions.Builder validators(List<? extends IValidator> validators)

Sets the value of ConfigurationOptions.getValidators()

Parameters:

validators - The validators for the configuration.

Returns:

this

build

@Stability(Stable)
public SourcedConfigurationOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<SourcedConfigurationOptions>

Returns:

a new instance of SourcedConfigurationOptions

Throws:

NullPointerException - if any required attribute was not provided