IEnvironment

class aws_cdk.aws_appconfig.IEnvironment(*args, **kwargs)

Bases: IResource, Protocol

Methods

add_deployment(configuration)

Creates a deployment of the supplied configuration to this environment.

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.

Parameters:: configuration (IConfiguration) – The configuration that will be deployed to this environment.
Return type:: None

add_deployments(*configurations)

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

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

Parameters:: configurations (IConfiguration) – The configurations that will be deployed to this environment.
Return type:: None

add_extension(extension)

Adds an extension association to the environment.

Parameters:: extension (IExtension) – The extension to create an association for.
Return type:: None

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

grant(grantee, *actions)

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

Parameters:

grantee (IGrantable) – the principal (no-op if undefined).
actions (str) – the set of actions to allow (i.e., ‘appconfig:GetLatestConfiguration’, ‘appconfig:StartConfigurationSession’, etc.).

Return type:

Grant

grant_read_config(grantee)

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

Actions: GetLatestConfiguration, StartConfigurationSession.

Parameters:: grantee (IGrantable) – Principal to grant read rights to.
Return type:: Grant

on(action_point, event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

action_point (ActionPoint) – The action point which triggers the event.
event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

on_deployment_baking(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

on_deployment_complete(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

on_deployment_rolled_back(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

on_deployment_start(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

on_deployment_step(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

pre_create_hosted_configuration_version(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

pre_start_deployment(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

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

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – A description of the extension. Default: - No description.
extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – The latest version number of the extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this field. Default: - None.
parameters (Optional[Sequence[Parameter]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

Attributes

application: The application associated with the environment.

application_id: The ID of the application associated to the environment.

description: The description of the environment.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

environment_arn

The Amazon Resource Name (ARN) of the environment.

Attribute:: true

environment_id

The ID of the environment.

Attribute:: true

monitors: The monitors for the environment.

name: The name of the environment.

node: The tree node.

stack: The stack in which this resource is defined.