HostedConfiguration

class aws_cdk.aws_appconfig_alpha.HostedConfiguration(scope, id, *, content, latest_version_number=None, version_label=None, application, deployment_key=None, deployment_strategy=None, deploy_to=None, description=None, name=None, type=None, validators=None)

Bases: Construct

(deprecated) A hosted configuration represents configuration stored in the AWS AppConfig hosted configuration store.

Stability:: deprecated
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appconfig_alpha as appconfig_alpha
from aws_cdk import aws_kms as kms

# application: appconfig_alpha.Application
# configuration_content: appconfig_alpha.ConfigurationContent
# deployment_strategy: appconfig_alpha.DeploymentStrategy
# environment: appconfig_alpha.Environment
# key: kms.Key
# validator: appconfig_alpha.IValidator

hosted_configuration = appconfig_alpha.HostedConfiguration(self, "MyHostedConfiguration",
    application=application,
    content=configuration_content,

    # the properties below are optional
    deployment_key=key,
    deployment_strategy=deployment_strategy,
    deploy_to=[environment],
    description="description",
    latest_version_number=123,
    name="name",
    type=appconfig_alpha.ConfigurationType.FREEFORM,
    validators=[validator],
    version_label="versionLabel"
)

Parameters:

scope (Construct) –
id (str) –
content (ConfigurationContent) – (deprecated) The content of the hosted configuration.
latest_version_number (Union[int, float, None]) – (deprecated) The latest version number of the hosted configuration. Default: - None.
version_label (Optional[str]) – (deprecated) The version label of the hosted configuration. Default: - None.
application (IApplication) – (deprecated) The application associated with the configuration.
deployment_key (Optional[IKey]) – (deprecated) The deployment key of the configuration. Default: - None.
deployment_strategy (Optional[IDeploymentStrategy]) – (deprecated) 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]]) – (deprecated) The list of environments to deploy the configuration to. If this parameter is not specified, then there will be no deployment. Default: - None.
description (Optional[str]) – (deprecated) The description of the configuration. Default: - No description.
name (Optional[str]) – (deprecated) The name of the configuration. Default: - A name is generated.
type (Optional[ConfigurationType]) – (deprecated) The type of configuration. Default: ConfigurationType.FREEFORM
validators (Optional[Sequence[IValidator]]) – (deprecated) The validators for the configuration. Default: - No validators.

Stability:

deprecated

Methods

add_extension(extension)

(deprecated) Adds an extension association to the configuration profile.

Parameters:: extension (IExtension) – The extension to create an association for.
Stability:: deprecated
Return type:: None

deploy(environment)

(deprecated) Deploys the configuration to the specified environment.

Parameters:: environment (IEnvironment) – The environment to deploy the configuration to.
Deprecated:
Return type:: None

Use deployTo as a property instead. We do not recommend creating resources in multiple stacks. If you want to do this still, please take a look into https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appconfig.CfnDeployment.html.

Stability:: deprecated

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

(deprecated) Adds an extension defined by the action point and event destination and also creates an extension association to the configuration profile.

Parameters:

action_point (ActionPoint) – The action point which triggers the event.
event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

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

(deprecated) Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the configuration profile.

Parameters:

event_destination (IEventDestination) – The event that occurs during the extension.
description (Optional[str]) – (deprecated) A description of the extension. Default: - No description.
extension_name (Optional[str]) – (deprecated) The name of the extension. Default: - A name is generated.
latest_version_number (Union[int, float, None]) – (deprecated) 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]]) – (deprecated) The parameters accepted for the extension. Default: - None.

Stability:

deprecated

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

application

(deprecated) The application associated with the configuration.

Stability:: deprecated

configuration_profile_arn

(deprecated) The Amazon Resource Name (ARN) of the configuration profile.

Stability:: deprecated

configuration_profile_id

(deprecated) The ID of the configuration profile.

Stability:: deprecated

content

(deprecated) The content of the hosted configuration.

Stability:: deprecated

content_type

(deprecated) The content type of the hosted configuration.

Stability:: deprecated

deploy_to

(deprecated) The environments to deploy to.

Stability:: deprecated

deployment_key

(deprecated) The deployment key for the configuration.

Stability:: deprecated

deployment_strategy

(deprecated) The deployment strategy for the configuration.

Stability:: deprecated

description

(deprecated) The description of the configuration.

Stability:: deprecated

hosted_configuration_version_arn

(deprecated) The Amazon Resource Name (ARN) of the hosted configuration version.

Stability:: deprecated

latest_version_number

(deprecated) The latest version number of the hosted configuration.

Stability:: deprecated

name

(deprecated) The name of the configuration.

Stability:: deprecated

node: The tree node.

type

(deprecated) The configuration type.

Stability:: deprecated

validators

(deprecated) The validators for the configuration.

Stability:: deprecated

version_label

(deprecated) The version label of the hosted configuration.

Stability:: deprecated

version_number

(deprecated) The version number of the hosted configuration.

Stability:: deprecated

Static Methods

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.