Class CfnEnvironment
A CloudFormation AWS::AppConfig::Environment
.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.AWS.AppConfig.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEnvironment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
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. 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 .
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
Description = "description",
Monitors = new [] { new MonitorsProperty {
AlarmArn = "alarmArn",
AlarmRoleArn = "alarmRoleArn"
} },
Tags = new [] { new TagsProperty {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnEnvironment(Construct, String, ICfnEnvironmentProps) | Create a new |
CfnEnvironment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEnvironment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
ApplicationId | The application ID. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Description | A description of the environment. |
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>) |
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 System.String
- scoped id of the resource.
- props ICfnEnvironmentProps
- resource properties.
CfnEnvironment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEnvironment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEnvironment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEnvironment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
ApplicationId
The application ID.
public virtual string ApplicationId { get; set; }
Property Value
System.String
Remarks
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Description
A description of the environment.
public virtual string Description { get; set; }
Property Value
System.String
Remarks
Monitors
Amazon CloudWatch alarms to monitor during the deployment process.
public virtual object Monitors { get; set; }
Property Value
System.Object
Remarks
Name
A name for the environment.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
Tags
Metadata to assign to the environment.
public virtual CfnEnvironment.ITagsProperty[] Tags { get; set; }
Property Value
CfnEnvironment.ITagsProperty[]
Remarks
Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>