Interface IConfigurationOptions

Options for the Configuration construct.

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IConfigurationOptions

Syntax (vb)

Public Interface IConfigurationOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.AppConfig;
            using Amazon.CDK.AWS.KMS;
            using Amazon.CDK.Interfaces.AppConfig;

            IDeploymentStrategyRef deploymentStrategyRef;
            Environment environment;
            Key key;
            IValidator validator;

            var configurationOptions = new ConfigurationOptions {
                DeletionProtectionCheck = DeletionProtectionCheck.ACCOUNT_DEFAULT,
                DeploymentKey = key,
                DeploymentStrategy = deploymentStrategyRef,
                DeployTo = new [] { environment },
                Description = "description",
                Name = "name",
                Type = ConfigurationType.FREEFORM,
                Validators = new [] { validator }
            };

Synopsis

Properties

DeletionProtectionCheck	A parameter to configure deletion protection.
DeployTo	The list of environments to deploy the configuration to.
DeploymentKey	The deployment key of the configuration.
DeploymentStrategy	The deployment strategy for the configuration.
Description	The description of the configuration.
Name	The name of the configuration.
Type	The type of configuration.
Validators	The validators for the configuration.

Properties

DeletionProtectionCheck

A parameter to configure deletion protection.

DeletionProtectionCheck? DeletionProtectionCheck { get; }

Property Value

DeletionProtectionCheck?

Remarks

Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.

Default: DeletionProtectionCheck.ACCOUNT_DEFAULT

See: https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html

DeployTo

The list of environments to deploy the configuration to.

IEnvironment[]? DeployTo { get; }

Property Value

IEnvironment[]

Remarks

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.

DeploymentKey

The deployment key of the configuration.

IKey? DeploymentKey { get; }

Property Value

IKey

Remarks

Default: - None.

DeploymentStrategy

The deployment strategy for the configuration.

IDeploymentStrategyRef? DeploymentStrategy { get; }

Property Value

IDeploymentStrategyRef

Remarks

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

Description

The description of the configuration.

string? Description { get; }

Property Value

string

Remarks

Default: - No description.

Name

The name of the configuration.

string? Name { get; }

Property Value

string

Remarks

Default: - A name is generated.

Type

The type of configuration.

ConfigurationType? Type { get; }

Property Value

ConfigurationType?

Remarks

Default: ConfigurationType.FREEFORM

Validators

The validators for the configuration.

IValidator[]? Validators { get; }

Property Value

IValidator[]

Remarks

Default: - No validators.