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
System.Object
CfnElement
CfnRefElement
CfnResource
CfnEnvironment
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEnvironment : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnEnvironment
    Inherits CfnResource
    Implements IInspectable, 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(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
    CfnEnvironment(Construct, String, ICfnEnvironmentProps)

    Properties

    ApplicationId

    The application ID.
    AttrEnvironmentId

    The environment ID.
    CdkTagManager

    Tag Manager which manages the tags for this resource.
    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.
    CfnProperties
    DeletionProtectionCheck

    A parameter to configure deletion protection.
    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(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

    CfnEnvironment(Construct, String, ICfnEnvironmentProps)

    public CfnEnvironment(Construct scope, string id, ICfnEnvironmentProps props)
    Parameters
    scope Constructs.Construct

    Scope in which this resource is defined.

    id System.String

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

    props ICfnEnvironmentProps

    Resource properties.

    Properties

    ApplicationId

    The application ID.

    public virtual string ApplicationId { get; set; }
    Property Value

    System.String

    AttrEnvironmentId

    The environment ID.

    public virtual string AttrEnvironmentId { get; }
    Property Value

    System.String

    Remarks

    CloudformationAttribute: EnvironmentId

    CdkTagManager

    Tag Manager which manages the tags for this resource.

    public virtual TagManager CdkTagManager { get; }
    Property Value

    TagManager

    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

    DeletionProtectionCheck

    A parameter to configure deletion protection.

    public virtual string DeletionProtectionCheck { get; set; }
    Property Value

    System.String

    Description

    A description of the environment.

    public virtual string Description { get; set; }
    Property Value

    System.String

    Monitors

    Amazon CloudWatch alarms to monitor during the deployment process.

    public virtual object Monitors { get; set; }
    Property Value

    System.Object

    Name

    A name for the environment.

    public virtual string Name { get; set; }
    Property Value

    System.String

    Tags

    Metadata to assign to the environment.

    public virtual ICfnTag[] Tags { get; set; }
    Property Value

    ICfnTag[]

    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>

    Overrides

    Implements