ConfigurationOptions

class aws_cdk.aws_appconfig.ConfigurationOptions(*, deletion_protection_check=None, deployment_key=None, deployment_strategy=None, deploy_to=None, description=None, name=None, type=None, validators=None)

Bases: object

Options for the Configuration construct.

Parameters:

deletion_protection_check (Optional[DeletionProtectionCheck]) – A parameter to configure deletion protection. Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval. Default: DeletionProtectionCheck.ACCOUNT_DEFAULT
deployment_key (Optional[IKey]) – The deployment key of the configuration. Default: - None.
deployment_strategy (Optional[IDeploymentStrategy]) – The deployment strategy for the configuration. Default: - A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES
deploy_to (Optional[Sequence[IEnvironment]]) – The list of environments to deploy the configuration to. If this parameter is not specified, then there will be no deployment created alongside this configuration. Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods. Default: - None.
description (Optional[str]) – The description of the configuration. Default: - No description.
name (Optional[str]) – The name of the configuration. Default: - A name is generated.
type (Optional[ConfigurationType]) – The type of configuration. Default: ConfigurationType.FREEFORM
validators (Optional[Sequence[IValidator]]) – The validators for the configuration. Default: - No validators.

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 import aws_appconfig as appconfig
from aws_cdk import aws_kms as kms

# deployment_strategy: appconfig.DeploymentStrategy
# environment: appconfig.Environment
# key: kms.Key
# validator: appconfig.IValidator

configuration_options = appconfig.ConfigurationOptions(
    deletion_protection_check=appconfig.DeletionProtectionCheck.ACCOUNT_DEFAULT,
    deployment_key=key,
    deployment_strategy=deployment_strategy,
    deploy_to=[environment],
    description="description",
    name="name",
    type=appconfig.ConfigurationType.FREEFORM,
    validators=[validator]
)

Attributes

deletion_protection_check

A parameter to configure deletion protection.

Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.

Default:: DeletionProtectionCheck.ACCOUNT_DEFAULT
See:: https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html

deploy_to

The list of environments to deploy the configuration to.

If this parameter is not specified, then there will be no deployment created alongside this configuration.

Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods.

Default:

None.

deployment_key

The deployment key of the configuration.

Default:

None.

deployment_strategy

The deployment strategy for the configuration.

Default:

A deployment strategy with the rollout strategy set to

RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

description

The description of the configuration.

Default:

No description.

name

The name of the configuration.

Default:

A name is generated.

type

The type of configuration.

Default:: ConfigurationType.FREEFORM

validators

The validators for the configuration.

Default:

No validators.