Environment

class aws_cdk.aws_appconfig.Environment(scope, id, *, application, deletion_protection_check=None, description=None, environment_name=None, monitors=None)

Bases: Resource

An AWS AppConfig environment.

See:: https://docs.aws.amazon.com/appconfig/latest/userguide/appconfig-creating-environment.html
Resource:: AWS::AppConfig::Environment
ExampleMetadata:: infused

Example:

app = appconfig.Application(self, "MyApp")
env = appconfig.Environment(self, "MyEnv",
    application=app
)

appconfig.HostedConfiguration(self, "MyHostedConfig",
    application=app,
    deploy_to=[env],
    content=appconfig.ConfigurationContent.from_inline_text("This is my configuration content.")
)

Parameters:

scope (Construct) –
id (str) –
application (IApplication) – The application to be associated with the environment.
deletion_protection_check (Optional[DeletionProtectionCheck]) – A property to prevent accidental deletion of active environments. Default: undefined - AppConfig default is ACCOUNT_DEFAULT
description (Optional[str]) – The description of the environment. Default: - No description.
environment_name (Optional[str]) – The name of the environment. Default: - A name is generated.
monitors (Optional[Sequence[Monitor]]) – The monitors for the environment. Default: - No monitors.

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) –

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) –

Return type:

None

add_extension(extension)

Adds an extension association to the environment.

Parameters:

extension (IExtension) –

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

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

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

Parameters:

event_destination (IEventDestination) –
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

grant(grantee, *actions)

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

Parameters:

grantee (IGrantable) –
actions (str) –

Return type:

Grant

grant_read_config(identity)

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

Actions: GetLatestConfiguration, StartConfigurationSession.

Parameters:

identity (IGrantable) –

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) –
event_destination (IEventDestination) –
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) –
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) –
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) –
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) –
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) –
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) –
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) –
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

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

application: The application associated with the environment.

application_id: The ID of 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.

Static Methods

classmethod from_environment_arn(scope, id, environment_arn)

Imports an environment into the CDK using its Amazon Resource Name (ARN).

Parameters:

scope (Construct) – The parent construct.
id (str) – The name of the environment construct.
environment_arn (str) – The Amazon Resource Name (ARN) of the environment.

Return type:

IEnvironment

classmethod from_environment_attributes(scope, id, *, application, environment_id, description=None, monitors=None, name=None)

Imports an environment into the CDK from its attributes.

Parameters:

scope (Construct) – The parent construct.
id (str) – The name of the environment construct.
application (IApplication) – The application associated with the environment.
environment_id (str) – The ID of the environment.
description (Optional[str]) – The description of the environment. Default: - None.
monitors (Optional[Sequence[Monitor]]) – The monitors for the environment. Default: - None.
name (Optional[str]) – The name of the environment. Default: - None.

Return type:

IEnvironment

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool