Class EnvironmentProps

Properties for the Environment construct.

Inheritance

object

EnvironmentProps

Implements

IEnvironmentProps

IEnvironmentOptions

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 EnvironmentProps : IEnvironmentProps, IEnvironmentOptions

Syntax (vb)

Public Class EnvironmentProps Implements IEnvironmentProps, IEnvironmentOptions

Remarks

ExampleMetadata: infused

Examples

var app = new Application(this, "MyApp");
            var env = new Environment(this, "MyEnv", new EnvironmentProps {
                Application = app
            });

            new HostedConfiguration(this, "MyFirstHostedConfig", new HostedConfigurationProps {
                Application = app,
                DeployTo = new [] { env },
                Content = ConfigurationContent.FromInlineText("This is my first configuration content.")
            });

            new HostedConfiguration(this, "MySecondHostedConfig", new HostedConfigurationProps {
                Application = app,
                DeployTo = new [] { env },
                Content = ConfigurationContent.FromInlineText("This is my second configuration content.")
            });

Synopsis

Constructors

EnvironmentProps()

Properties for the Environment construct.

Properties

Application	The application to be associated with the environment.
DeletionProtectionCheck	A property to prevent accidental deletion of active environments.
Description	The description of the environment.
EnvironmentName	The name of the environment.
Monitors	The monitors for the environment.

Constructors

EnvironmentProps()

Properties for the Environment construct.

public EnvironmentProps()

Remarks

ExampleMetadata: infused

Examples

var app = new Application(this, "MyApp");
            var env = new Environment(this, "MyEnv", new EnvironmentProps {
                Application = app
            });

            new HostedConfiguration(this, "MyFirstHostedConfig", new HostedConfigurationProps {
                Application = app,
                DeployTo = new [] { env },
                Content = ConfigurationContent.FromInlineText("This is my first configuration content.")
            });

            new HostedConfiguration(this, "MySecondHostedConfig", new HostedConfigurationProps {
                Application = app,
                DeployTo = new [] { env },
                Content = ConfigurationContent.FromInlineText("This is my second configuration content.")
            });

Properties

Application

The application to be associated with the environment.

public IApplication Application { get; set; }

Property Value

IApplication

Remarks

ExampleMetadata: infused

DeletionProtectionCheck

A property to prevent accidental deletion of active environments.

public DeletionProtectionCheck? DeletionProtectionCheck { get; set; }

Property Value

DeletionProtectionCheck?

Remarks

Default: undefined - AppConfig default is ACCOUNT_DEFAULT

Description

The description of the environment.

public string? Description { get; set; }

Property Value

string

Remarks

Default: - No description.

EnvironmentName

The name of the environment.

public string? EnvironmentName { get; set; }

Property Value

string

Remarks

Default: - A name is generated.

Monitors

The monitors for the environment.

public Monitor[]? Monitors { get; set; }

Property Value

Monitor[]

Remarks

Default: - No monitors.

Implements

IEnvironmentProps

IEnvironmentOptions