IExtensible

class aws_cdk.aws_appconfig.IExtensible(*args, **kwargs)

Bases: Protocol

Defines the extensible base implementation for extension association resources.

Methods

add_extension(extension)

Adds an extension association to the derived resource.

Parameters:

extension (IExtension) – The extension to create an association for.

Return type:

None

at_deployment_tick(event_destination, *, description=None, extension_name=None, latest_version_number=None, parameters=None)

Adds an AT_DEPLOYMENT_TICK extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an extension defined by the action point and event destination and also creates an extension association to the derived resource.

Parameters:

  • action_point (ActionPoint) – The action point which triggers the event.

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an ON_DEPLOYMENT_BAKING extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an ON_DEPLOYMENT_COMPLETE extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an ON_DEPLOYMENT_ROLLED_BACK extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an ON_DEPLOYMENT_START extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds an ON_DEPLOYMENT_STEP extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds a PRE_CREATE_HOSTED_CONFIGURATION_VERSION extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None

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

Adds a PRE_START_DEPLOYMENT extension with the provided event destination and also creates an extension association to the derived resource.

Parameters:

  • event_destination (IEventDestination) – The event that occurs during the extension.

  • description (Optional[str]) – A description of the extension. Default: - No description.

  • extension_name (Optional[str]) – The name of the extension. Default: - A name is generated.

  • latest_version_number (Union[int, float, None]) – 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]]) – The parameters accepted for the extension. Default: - None.

Return type:

None