Class CfnEnvironment

The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnEnvironment

Implements

IInspectable

IEnvironmentRef

IConstruct

IDependable

IEnvironmentAware

ITaggableV2

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEnvironment : CfnResource, IInspectable, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Syntax (vb)

Public Class CfnEnvironment Inherits CfnResource Implements IInspectable, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

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;

             var cfnEnvironment = new CfnEnvironment(this, "MyCfnEnvironment", new CfnEnvironmentProps {
                 ApplicationId = "applicationId",
                 Name = "name",

                 // the properties below are optional
                 DeletionProtectionCheck = "deletionProtectionCheck",
                 Description = "description",
                 Monitors = new [] { new MonitorsProperty {
                     AlarmArn = "alarmArn",
                     AlarmRoleArn = "alarmRoleArn"
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnEnvironment(Construct, string, ICfnEnvironmentProps)

Create a new AWS::AppConfig::Environment.

Properties

ApplicationId	The application ID.
AttrEnvironmentId	The environment ID.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CdkTagManager	Tag Manager which manages the tags for this resource.
CfnProperties	The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.
DeletionProtectionCheck	A parameter to configure deletion protection.
Description	A description of the environment.
EnvironmentRef	A reference to a Environment resource.
Monitors	Amazon CloudWatch alarms to monitor during the deployment process.
Name	A name for the environment.
Tags	Metadata to assign to the environment.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.

Constructors

CfnEnvironment(Construct, string, ICfnEnvironmentProps)

Create a new AWS::AppConfig::Environment.

public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnEnvironmentProps

Resource properties.

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Properties

ApplicationId

The application ID.

public virtual string ApplicationId { get; set; }

Property Value

string

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

AttrEnvironmentId

The environment ID.

public virtual string AttrEnvironmentId { get; }

Property Value

string

Remarks

CloudformationAttribute: EnvironmentId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }

Property Value

TagManager

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

DeletionProtectionCheck

A parameter to configure deletion protection.

public virtual string? DeletionProtectionCheck { get; set; }

Property Value

string

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Description

A description of the environment.

public virtual string? Description { get; set; }

Property Value

string

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

EnvironmentRef

A reference to a Environment resource.

public virtual IEnvironmentReference EnvironmentRef { get; }

Property Value

IEnvironmentReference

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Monitors

Amazon CloudWatch alarms to monitor during the deployment process.

public virtual object? Monitors { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnEnvironment.IMonitorsProperty)[]

Name

A name for the environment.

public virtual string Name { get; set; }

Property Value

string

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Tags

Metadata to assign to the environment.

public virtual ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html

CloudformationResource: AWS::AppConfig::Environment

ExampleMetadata: fixture=_generated

Implements

IInspectable

IEnvironmentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggableV2