Extension

class aws_cdk.aws_appconfig.Extension(scope, id, *, actions, description=None, extension_name=None, latest_version_number=None, parameters=None)

Bases: Resource

An AWS AppConfig extension.

See:: https://docs.aws.amazon.com/appconfig/latest/userguide/working-with-appconfig-extensions.html
Resource:: AWS::AppConfig::Extension
ExampleMetadata:: infused

Example:

# fn: lambda.Function


appconfig.Extension(self, "MyExtension",
    actions=[
        appconfig.Action(
            action_points=[appconfig.ActionPoint.ON_DEPLOYMENT_START],
            event_destination=appconfig.LambdaDestination(fn)
        )
    ]
)

Parameters:

scope (Construct) –
id (str) –
actions (Sequence[Action]) – The actions for 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.

Methods

apply_removal_policy(policy)

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:

policy (RemovalPolicy) –

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str

Attributes

actions: The actions for the extension.

description: The description of the extension.

env

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

extension_arn

The Amazon Resource Name (ARN) of the extension.

Attribute:: true

extension_id

The ID of the extension.

Attribute:: true

extension_version_number

The version number of the extension.

Attribute:: true

latest_version_number: The latest version number of the extension.

name: The name of the extension.

node: The tree node.

parameters: The parameters of the extension.

stack: The stack in which this resource is defined.

Static Methods

classmethod from_extension_arn(scope, id, extension_arn)

Imports an extension into the CDK using its Amazon Resource Name (ARN).

Parameters:

scope (Construct) – The parent construct.
id (str) – The name of the extension construct.
extension_arn (str) – The Amazon Resource Name (ARN) of the extension.

Return type:

IExtension

classmethod from_extension_attributes(scope, id, *, extension_id, extension_version_number, actions=None, description=None, extension_arn=None, name=None)

Imports an extension into the CDK using its attributes.

Parameters:

scope (Construct) – The parent construct.
id (str) – The name of the extension construct.
extension_id (str) – The ID of the extension.
extension_version_number (Union[int, float]) – The version number of the extension.
actions (Optional[Sequence[Action]]) – The actions of the extension. Default: - None.
description (Optional[str]) – The description of the extension. Default: - None.
extension_arn (Optional[str]) – The Amazon Resource Name (ARN) of the extension. Default: - The extension ARN is generated.
name (Optional[str]) – The name of the extension. Default: - None.

Return type:

IExtension

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.

classmethod is_owned_resource(construct)

Returns true if the construct was created by CDK, and false otherwise.

Parameters:

construct (IConstruct) –

Return type:

bool

classmethod is_resource(construct)

Check whether the given construct is a Resource.

Parameters:

construct (IConstruct) –

Return type:

bool