Show / Hide Table of Contents

Interface ICfnEnvironmentProps

Properties for defining a CfnEnvironment.

Namespace: Amazon.CDK.AWS.AppConfig
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnEnvironmentProps
Syntax (vb)
Public Interface ICfnEnvironmentProps
Remarks

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

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 cfnEnvironmentProps = 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

Properties

ApplicationId

The application ID.

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.

Properties

ApplicationId

The application ID.

string ApplicationId { get; }
Property Value

string

Remarks

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

DeletionProtectionCheck

A parameter to configure deletion protection.

string? DeletionProtectionCheck { get; }
Property Value

string

Remarks

Deletion protection prevents a user from deleting an environment if your application called either GetLatestConfiguration or GetConfiguration in the environment during the specified interval.

This parameter supports the following values:

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

    Description

    A description of the environment.

    string? Description { get; }
    Property Value

    string

    Remarks

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

    Monitors

    Amazon CloudWatch alarms to monitor during the deployment process.

    object? Monitors { get; }
    Property Value

    object

    Remarks

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

    Name

    A name for the environment.

    string Name { get; }
    Property Value

    string

    Remarks

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

    Tags

    Metadata to assign to the environment.

    ICfnTag[]? Tags { get; }
    Property Value

    ICfnTag[]

    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.

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

    Back to top Generated by DocFX