HostedConfigurationProps

class aws_cdk.aws_appconfig.HostedConfigurationProps(*, deletion_protection_check=None, deployment_key=None, deployment_strategy=None, deploy_to=None, description=None, name=None, type=None, validators=None, application, content, kms_key=None, latest_version_number=None, version_label=None)

Bases: ConfigurationProps

Properties for HostedConfiguration.

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[IDeploymentStrategyRef]) – 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.
application (IApplication) – The application associated with the configuration.
content (ConfigurationContent) – The content of the hosted configuration.
kms_key (Optional[IKeyRef]) – The customer managed key to encrypt hosted configuration. Default: None
latest_version_number (Union[int, float, None]) – The latest version number of the hosted configuration. Default: - None.
version_label (Optional[str]) – The version label of the hosted configuration. Default: - None.

ExampleMetadata:

infused

Example:

# application: appconfig.Application
# fn: lambda.Function


appconfig.HostedConfiguration(self, "MyHostedConfiguration",
    application=application,
    content=appconfig.ConfigurationContent.from_inline_text("This is my configuration content."),
    validators=[
        appconfig.JsonSchemaValidator.from_file("schema.json"),
        appconfig.LambdaValidator.from_function(fn)
    ]
)

Attributes

application: The application associated with the configuration.

content: The content of the hosted configuration.

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.

kms_key

The customer managed key to encrypt hosted configuration.

Default:: None

latest_version_number

The latest version number of the hosted configuration.

Default:

None.

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.

version_label

The version label of the hosted configuration.

Default:

None.