CfnEnvironmentPropsMixin

class aws_cdk.mixins_preview.aws_appconfig.mixins.CfnEnvironmentPropsMixin(props, *, strategy=None)

Bases: Mixin

The AWS::AppConfig::Environment resource creates an environment, which is a logical deployment group of AWS AppConfig targets, such as applications in a Beta or Production environment.

You define one or more environments for each AWS AppConfig application. You can also define environments for application subcomponents such as the Web , Mobile and Back-end components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

AWS AppConfig requires that you create resources and deploy a configuration in the following order:

Create an application
Create an environment
Create a configuration profile
Choose a pre-defined deployment strategy or create your own
Deploy the configuration

For more information, see AWS AppConfig in the AWS AppConfig User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-environment.html
CloudformationResource:: AWS::AppConfig::Environment
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

cfn_environment_props_mixin = appconfig_mixins.CfnEnvironmentPropsMixin(appconfig_mixins.CfnEnvironmentMixinProps(
    application_id="applicationId",
    deletion_protection_check="deletionProtectionCheck",
    description="description",
    monitors=[appconfig_mixins.CfnEnvironmentPropsMixin.MonitorsProperty(
        alarm_arn="alarmArn",
        alarm_role_arn="alarmRoleArn"
    )],
    name="name",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppConfig::Environment.

Parameters:

props (Union[CfnEnvironmentMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['applicationId', 'deletionProtectionCheck', 'description', 'monitors', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

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

MonitorProperty

class CfnEnvironmentPropsMixin.MonitorProperty(*, alarm_arn=None, alarm_role_arn=None)

Bases: object

Amazon CloudWatch alarms to monitor during the deployment process.

Parameters:

alarm_arn (Optional[str]) – Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.
alarm_role_arn (Optional[str]) – ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

monitor_property = appconfig_mixins.CfnEnvironmentPropsMixin.MonitorProperty(
    alarm_arn="alarmArn",
    alarm_role_arn="alarmRoleArn"
)

Attributes

alarm_arn

Amazon Resource Name (ARN) of the Amazon CloudWatch alarm.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html#cfn-appconfig-environment-monitor-alarmarn

alarm_role_arn

ARN of an AWS Identity and Access Management (IAM) role for AWS AppConfig to monitor AlarmArn .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitor.html#cfn-appconfig-environment-monitor-alarmrolearn

MonitorsProperty

class CfnEnvironmentPropsMixin.MonitorsProperty(*, alarm_arn=None, alarm_role_arn=None)

Bases: object

Parameters:

alarm_arn (Optional[str])
alarm_role_arn (Optional[str])

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-environment-monitors.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

monitors_property = appconfig_mixins.CfnEnvironmentPropsMixin.MonitorsProperty(
    alarm_arn="alarmArn",
    alarm_role_arn="alarmRoleArn"
)

Attributes

alarm_arn

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

Type:: see

alarm_role_arn

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

Type:: see