aws-cdk-lib.aws_appconfig.CfnExtensionProps

interface CfnExtensionProps

LanguageType name
.NETAmazon.CDK.AWS.AppConfig.CfnExtensionProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#CfnExtensionProps
Javasoftware.amazon.awscdk.services.appconfig.CfnExtensionProps
Pythonaws_cdk.aws_appconfig.CfnExtensionProps
TypeScript aws-cdk-lib » aws_appconfig » CfnExtensionProps

Properties for defining a CfnExtension.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appconfig as appconfig } from 'aws-cdk-lib';

declare const actions: any;
const cfnExtensionProps: appconfig.CfnExtensionProps = {
  actions: actions,
  name: 'name',

  // the properties below are optional
  description: 'description',
  latestVersionNumber: 123,
  parameters: {
    parametersKey: {
      required: false,

      // the properties below are optional
      description: 'description',
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
actionsanyThe actions defined in the extension.
namestringA name for the extension.
description?stringInformation about the extension.
latestVersionNumber?numberYou can omit this field when you create an extension.
parameters?IResolvable | { [string]: IResolvable | ParameterProperty }The parameters accepted by the extension.
tags?CfnTag[]Adds one or more tags for the specified extension.

actions

Type: any

The actions defined in the extension.


name

Type: string

A name for the extension.

Each extension name in your account must be unique. Extension versions use the same name.


description?

Type: string (optional)

Information about the extension.


latestVersionNumber?

Type: number (optional)

You can omit this field when you create an 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.


parameters?

Type: IResolvable | { [string]: IResolvable | ParameterProperty } (optional)

The parameters accepted by the extension.

You specify parameter values when you associate the extension to an AWS AppConfig resource by using the CreateExtensionAssociation API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object.


tags?

Type: CfnTag[] (optional)

Adds one or more tags for the specified extension.

Tags are metadata that help you categorize resources in different ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you define.