Class HostedConfigurationOptions

Options for HostedConfiguration.

Inheritance

object

HostedConfigurationOptions

Implements

IHostedConfigurationOptions

IConfigurationOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class HostedConfigurationOptions : IHostedConfigurationOptions, IConfigurationOptions

Syntax (vb)

Public Class HostedConfigurationOptions Implements IHostedConfigurationOptions, 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;

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

            var hostedConfigurationOptions = new HostedConfigurationOptions {
                Content = configurationContent,

                // the properties below are optional
                DeletionProtectionCheck = DeletionProtectionCheck.ACCOUNT_DEFAULT,
                DeploymentKey = key,
                DeploymentStrategy = deploymentStrategyRef,
                DeployTo = new [] { environment },
                Description = "description",
                LatestVersionNumber = 123,
                Name = "name",
                Type = ConfigurationType.FREEFORM,
                Validators = new [] { validator },
                VersionLabel = "versionLabel"
            };

Synopsis

Constructors

HostedConfigurationOptions()

Options for HostedConfiguration.

Properties

Content	The content of the hosted configuration.
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.
LatestVersionNumber	The latest version number of the hosted configuration.
Name	The name of the configuration.
Type	The type of configuration.
Validators	The validators for the configuration.
VersionLabel	The version label of the hosted configuration.

Constructors

HostedConfigurationOptions()

Options for HostedConfiguration.

public HostedConfigurationOptions()

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;

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

            var hostedConfigurationOptions = new HostedConfigurationOptions {
                Content = configurationContent,

                // the properties below are optional
                DeletionProtectionCheck = DeletionProtectionCheck.ACCOUNT_DEFAULT,
                DeploymentKey = key,
                DeploymentStrategy = deploymentStrategyRef,
                DeployTo = new [] { environment },
                Description = "description",
                LatestVersionNumber = 123,
                Name = "name",
                Type = ConfigurationType.FREEFORM,
                Validators = new [] { validator },
                VersionLabel = "versionLabel"
            };

Properties

Content

The content of the hosted configuration.

public ConfigurationContent Content { get; set; }

Property Value

ConfigurationContent

Remarks

ExampleMetadata: fixture=_generated

DeletionProtectionCheck

A parameter to configure deletion protection.

public DeletionProtectionCheck? DeletionProtectionCheck { get; set; }

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.

public IEnvironment[]? DeployTo { get; set; }

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.

public IKey? DeploymentKey { get; set; }

Property Value

IKey

Remarks

Default: - None.

DeploymentStrategy

The deployment strategy for the configuration.

public IDeploymentStrategyRef? DeploymentStrategy { get; set; }

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.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - No description.

LatestVersionNumber

The latest version number of the hosted configuration.

public double? LatestVersionNumber { get; set; }

Property Value

double?

Remarks

Default: - None.

Name

The name of the configuration.

public string? Name { get; set; }

Property Value

string

Remarks

Default: - A name is generated.

Type

The type of configuration.

public ConfigurationType? Type { get; set; }

Property Value

ConfigurationType?

Remarks

Default: ConfigurationType.FREEFORM

Validators

The validators for the configuration.

public IValidator[]? Validators { get; set; }

Property Value

IValidator[]

Remarks

Default: - No validators.

VersionLabel

The version label of the hosted configuration.

public string? VersionLabel { get; set; }

Property Value

string

Remarks

Default: - None.

Implements

IHostedConfigurationOptions

IConfigurationOptions