Interface IEnvironment

Inherited Members

IResource.ApplyRemovalPolicy(RemovalPolicy)

IResource.Stack

IEnvironmentRef.EnvironmentRef

IEnvironmentAware.Env

Namespace: Amazon.CDK.AWS.AppConfig

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IEnvironment : IResource, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware

Syntax (vb)

Public Interface IEnvironment Inherits IResource, IEnvironmentRef, IConstruct, IDependable, IEnvironmentAware

Synopsis

Properties

Application	The application associated with the environment.
ApplicationId	The ID of the application associated to the environment.
Description	The description of the environment.
EnvironmentArn	The Amazon Resource Name (ARN) of the environment.
EnvironmentId	The ID of the environment.
Monitors	The monitors for the environment.
Name	The name of the environment.

Methods

AddDeployment(IConfiguration)	Creates a deployment of the supplied configuration to this environment.
AddDeployments(params IConfiguration[])	Creates a deployment for each of the supplied configurations to this environment.
AddExtension(IExtension)	Adds an extension association to the environment.
AtDeploymentTick(IEventDestination, IExtensionOptions?)	Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.
Grant(IGrantable, params string[])	Adds an IAM policy statement associated with this environment to an IAM principal's policy.
GrantReadConfig(IGrantable)	Permits an IAM principal to perform read operations on this environment's configurations.
On(ActionPoint, IEventDestination, IExtensionOptions?)	Adds an extension defined by the action point and event destination and also creates an extension association to the environment.
OnDeploymentBaking(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.
OnDeploymentComplete(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.
OnDeploymentRolledBack(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.
OnDeploymentStart(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.
OnDeploymentStep(IEventDestination, IExtensionOptions?)	Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.
PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions?)	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?)	Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.

Properties

Application

The application associated with the environment.

IApplication? Application { get; }

Property Value

IApplication

ApplicationId

The ID of the application associated to the environment.

string ApplicationId { get; }

Property Value

string

Description

The description of the environment.

string? Description { get; }

Property Value

string

EnvironmentArn

The Amazon Resource Name (ARN) of the environment.

string EnvironmentArn { get; }

Property Value

string

Remarks

Attribute: true

EnvironmentId

The ID of the environment.

string EnvironmentId { get; }

Property Value

string

Remarks

Attribute: true

Monitors

The monitors for the environment.

Monitor[]? Monitors { get; }

Property Value

Monitor[]

Name

The name of the environment.

string? Name { get; }

Property Value

string

Methods

AddDeployment(IConfiguration)

Creates a deployment of the supplied configuration to this environment.

void AddDeployment(IConfiguration configuration)

Parameters

configuration IConfiguration

The configuration that will be deployed to this environment.

Remarks

Note that you can only deploy one configuration at a time to an environment. However, you can deploy one configuration each to different environments at the same time. If more than one deployment is requested for this environment, they will occur in the same order they were provided.

AddDeployments(params IConfiguration[])

Creates a deployment for each of the supplied configurations to this environment.

void AddDeployments(params IConfiguration[] configurations)

Parameters

configurations IConfiguration[]

The configurations that will be deployed to this environment.

Remarks

These configurations will be deployed in the same order as the input array.

AddExtension(IExtension)

Adds an extension association to the environment.

void AddExtension(IExtension extension)

Parameters

extension IExtension

The extension to create an association for.

AtDeploymentTick(IEventDestination, IExtensionOptions?)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to an application.

void AtDeploymentTick(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

Grant(IGrantable, params string[])

Adds an IAM policy statement associated with this environment to an IAM principal's policy.

Grant Grant(IGrantable grantee, params string[] actions)

Parameters

grantee IGrantable

the principal (no-op if undefined).

actions string[]

the set of actions to allow (i.e., 'appconfig:GetLatestConfiguration', 'appconfig:StartConfigurationSession', etc.).

Returns

Grant

GrantReadConfig(IGrantable)

Permits an IAM principal to perform read operations on this environment's configurations.

Grant GrantReadConfig(IGrantable grantee)

Parameters

grantee IGrantable

Principal to grant read rights to.

Returns

Grant

Remarks

Actions: GetLatestConfiguration, StartConfigurationSession.

On(ActionPoint, IEventDestination, IExtensionOptions?)

Adds an extension defined by the action point and event destination and also creates an extension association to the environment.

void On(ActionPoint actionPoint, IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

actionPoint ActionPoint

The action point which triggers the event.

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentBaking(IEventDestination, IExtensionOptions?)

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the environment.

void OnDeploymentBaking(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentComplete(IEventDestination, IExtensionOptions?)

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the environment.

void OnDeploymentComplete(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentRolledBack(IEventDestination, IExtensionOptions?)

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the environment.

void OnDeploymentRolledBack(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStart(IEventDestination, IExtensionOptions?)

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the environment.

void OnDeploymentStart(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

OnDeploymentStep(IEventDestination, IExtensionOptions?)

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the environment.

void OnDeploymentStep(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreCreateHostedConfigurationVersion(IEventDestination, IExtensionOptions?)

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the environment.

void PreCreateHostedConfigurationVersion(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.

PreStartDeployment(IEventDestination, IExtensionOptions?)

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the environment.

void PreStartDeployment(IEventDestination eventDestination, IExtensionOptions? options = null)

Parameters

eventDestination IEventDestination

The event that occurs during the extension.

options IExtensionOptions

Options for the extension.