CfnExtensionPropsMixin

class aws_cdk.mixins_preview.aws_appconfig.mixins.CfnExtensionPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an AWS AppConfig extension.

An extension augments your ability to inject logic or behavior at different points during the AWS AppConfig workflow of creating or deploying a configuration.

You can create your own extensions or use the AWS authored extensions provided by AWS AppConfig . For an AWS AppConfig extension that uses AWS Lambda , you must create a Lambda function to perform any computation and processing defined in the extension. If you plan to create custom versions of the AWS authored notification extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri field for the new extension version.

For a custom EventBridge notification extension, enter the ARN of the EventBridge default events in the Uri field.
For a custom Amazon SNS notification extension, enter the ARN of an Amazon SNS topic in the Uri field.
For a custom Amazon SQS notification extension, enter the ARN of an Amazon SQS message queue in the Uri field.

For more information about extensions, see Extending workflows in the AWS AppConfig User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-extension.html
CloudformationResource:: AWS::AppConfig::Extension
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

# actions: Any

cfn_extension_props_mixin = appconfig_mixins.CfnExtensionPropsMixin(appconfig_mixins.CfnExtensionMixinProps(
    actions=actions,
    description="description",
    latest_version_number=123,
    name="name",
    parameters={
        "parameters_key": appconfig_mixins.CfnExtensionPropsMixin.ParameterProperty(
            description="description",
            dynamic=False,
            required=False
        )
    },
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::AppConfig::Extension.

Parameters:

props (Union[CfnExtensionMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['actions', 'description', 'latestVersionNumber', 'name', 'parameters', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ActionProperty

class CfnExtensionPropsMixin.ActionProperty(*, description=None, name=None, role_arn=None, uri=None)

Bases: object

The actions defined in the extension.

Parameters:

description (Optional[str]) – Information about actions defined in the extension.
name (Optional[str]) – The extension name.
role_arn (Optional[str]) – An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role.
uri (Optional[str]) – The extension URI associated to the action point in the extension definition. The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

action_property = appconfig_mixins.CfnExtensionPropsMixin.ActionProperty(
    description="description",
    name="name",
    role_arn="roleArn",
    uri="uri"
)

Attributes

description

Information about actions defined in the extension.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-description

name

The extension name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-name

role_arn

An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-rolearn

uri

The extension URI associated to the action point in the extension definition.

The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notification Service topic, or the Amazon EventBridge default event bus.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-action.html#cfn-appconfig-extension-action-uri

ParameterProperty

class CfnExtensionPropsMixin.ParameterProperty(*, description=None, dynamic=None, required=None)

Bases: object

A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notification Service topic entered in an extension when invoked.

Parameter values are specified in an extension association. For more information about extensions, see Extending workflows in the AWS AppConfig User Guide .

Parameters:

description (Optional[str]) – Information about the parameter.
dynamic (Union[bool, IResolvable, None]) – Indicates whether this parameter’s value can be supplied at the extension’s action point instead of during extension association. Dynamic parameters can’t be marked Required .
required (Union[bool, IResolvable, None]) – A parameter value must be specified in the extension association.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_appconfig import mixins as appconfig_mixins

parameter_property = appconfig_mixins.CfnExtensionPropsMixin.ParameterProperty(
    description="description",
    dynamic=False,
    required=False
)

Attributes

description

Information about the parameter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-description

dynamic

Indicates whether this parameter’s value can be supplied at the extension’s action point instead of during extension association.

Dynamic parameters can’t be marked Required .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-dynamic

required

A parameter value must be specified in the extension association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appconfig-extension-parameter.html#cfn-appconfig-extension-parameter-required