HostedConfigurationProps

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

Bases: ConfigurationProps

Properties for HostedConfiguration.

Parameters:

  • 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.

  • application (IApplication) – The application associated with the configuration.

  • content (ConfigurationContent) – The content of the hosted configuration.

  • 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:

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.")
)

Attributes

application

The application associated with the configuration.

content

The content of the hosted configuration.

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.

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.