Class Environment
(deprecated) An AWS AppConfig environment.
Inherited Members
Namespace: Amazon.CDK.AWS.AppConfig.Alpha
Assembly: Amazon.CDK.AWS.AppConfig.Alpha.dll
Syntax (csharp)
public class Environment : Resource, IEnvironment, IResource, IExtensible
Syntax (vb)
Public Class Environment
Inherits Resource
Implements IEnvironment, IResource, IExtensible
Remarks
Stability: Deprecated
See: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html
Resource: 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.Alpha;
Application application;
Monitor monitor;
var environment = new Environment(this, "MyEnvironment", new EnvironmentProps {
Application = application,
// the properties below are optional
Description = "description",
EnvironmentName = "environmentName",
Monitors = new [] { monitor }
});
Synopsis
Constructors
Environment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
Environment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Environment(Construct, String, IEnvironmentProps) |
Properties
Application | (deprecated) The application associated with the environment. |
ApplicationId | (deprecated) The ID of the environment. |
Description | (deprecated) The description of the environment. |
EnvironmentArn | (deprecated) The Amazon Resource Name (ARN) of the environment. |
EnvironmentId | (deprecated) The ID of the environment. |
Extensible | |
Monitors | (deprecated) The monitors for the environment. |
Name | (deprecated) The name of the environment. |
Methods
AddExtension(IExtension) | (deprecated) Adds an extension association to the environment. |
FromEnvironmentArn(Construct, String, String) | (deprecated) Imports an environment into the CDK using its Amazon Resource Name (ARN). |
FromEnvironmentAttributes(Construct, String, IEnvironmentAttributes) | (deprecated) Imports an environment into the CDK from its attributes. |
On(ActionPoint, IEventDestination, IExtensionOptions) | (deprecated) Adds an extension defined by the action point and event destination and also creates an extension association to the environment. |
OnDeploymentBaking(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment. |
OnDeploymentComplete(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment. |
OnDeploymentRolledBack(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment. |
OnDeploymentStart(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment. |
OnDeploymentStep(IEventDestination, IExtensionOptions) | (deprecated) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment. |
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions) | (deprecated) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment. |
PreStartDeployment(IEventDestination, IExtensionOptions) | (deprecated) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment. |
Constructors
Environment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected Environment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
Environment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected Environment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Environment(Construct, String, IEnvironmentProps)
public Environment(Construct scope, string id, IEnvironmentProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props IEnvironmentProps
Remarks
Stability: Deprecated
Properties
Application
(deprecated) The application associated with the environment.
public virtual IApplication Application { get; }
Property Value
Remarks
Stability: Deprecated
ApplicationId
(deprecated) The ID of the environment.
public virtual string ApplicationId { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Description
(deprecated) The description of the environment.
public virtual string Description { get; }
Property Value
System.String
Remarks
Stability: Deprecated
EnvironmentArn
(deprecated) The Amazon Resource Name (ARN) of the environment.
public virtual string EnvironmentArn { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Attribute: true
EnvironmentId
(deprecated) The ID of the environment.
public virtual string EnvironmentId { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Attribute: true
Extensible
protected virtual ExtensibleBase Extensible { get; set; }
Property Value
Remarks
Stability: Deprecated
Monitors
(deprecated) The monitors for the environment.
public virtual Monitor[] Monitors { get; }
Property Value
Monitor[]
Remarks
Stability: Deprecated
Name
(deprecated) The name of the environment.
public virtual string Name { get; }
Property Value
System.String
Remarks
Stability: Deprecated
Methods
AddExtension(IExtension)
(deprecated) Adds an extension association to the environment.
public virtual void AddExtension(IExtension extension)
Parameters
- extension IExtension
Remarks
Stability: Deprecated
FromEnvironmentArn(Construct, String, String)
(deprecated) Imports an environment into the CDK using its Amazon Resource Name (ARN).
public static IEnvironment FromEnvironmentArn(Construct scope, string id, string environmentArn)
Parameters
- scope Constructs.Construct
The parent construct.
- id System.String
The name of the environment construct.
- environmentArn System.String
The Amazon Resource Name (ARN) of the environment.
Returns
Remarks
Stability: Deprecated
FromEnvironmentAttributes(Construct, String, IEnvironmentAttributes)
(deprecated) Imports an environment into the CDK from its attributes.
public static IEnvironment FromEnvironmentAttributes(Construct scope, string id, IEnvironmentAttributes attrs)
Parameters
- scope Constructs.Construct
The parent construct.
- id System.String
The name of the environment construct.
- attrs IEnvironmentAttributes
The attributes of the environment.
Returns
Remarks
Stability: Deprecated
On(ActionPoint, IEventDestination, IExtensionOptions)
(deprecated) Adds an extension defined by the action point and event destination and also creates an extension association to the environment.
public virtual void On(ActionPoint actionPoint, IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- actionPoint ActionPoint
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
OnDeploymentBaking(IEventDestination, IExtensionOptions)
(deprecated) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.
public virtual void OnDeploymentBaking(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
OnDeploymentComplete(IEventDestination, IExtensionOptions)
(deprecated) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.
public virtual void OnDeploymentComplete(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
OnDeploymentRolledBack(IEventDestination, IExtensionOptions)
(deprecated) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.
public virtual void OnDeploymentRolledBack(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
OnDeploymentStart(IEventDestination, IExtensionOptions)
(deprecated) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.
public virtual void OnDeploymentStart(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
OnDeploymentStep(IEventDestination, IExtensionOptions)
(deprecated) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.
public virtual void OnDeploymentStep(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions)
(deprecated) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.
public virtual void PreCreateHostedConfigurationVersion(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated
PreStartDeployment(IEventDestination, IExtensionOptions)
(deprecated) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.
public virtual void PreStartDeployment(IEventDestination eventDestination, IExtensionOptions options = null)
Parameters
- eventDestination IEventDestination
- options IExtensionOptions
Remarks
Stability: Deprecated