class Parameter

Language	Type name
.NET	Amazon.CDK.AWS.AppConfig.Parameter
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsappconfig#Parameter
Java	software.amazon.awscdk.services.appconfig.Parameter
Python	aws_cdk.aws_appconfig.Parameter
TypeScript (source)	aws-cdk-lib » aws_appconfig » Parameter

Defines a parameter for an extension.

Example

declare const fn: lambda.Function;

new appconfig.Extension(this, 'MyExtension', {
  actions: [
    new appconfig.Action({
      actionPoints: [appconfig.ActionPoint.ON_DEPLOYMENT_START],
      eventDestination: new appconfig.LambdaDestination(fn),
    }),
  ],
  parameters: [
    appconfig.Parameter.required('testParam', 'true'),
    appconfig.Parameter.notRequired('testNotRequiredParam'),
  ]
});

Properties

Name	Type	Description
isRequired	boolean	A boolean that indicates if the parameter is required or optional.
name	string	The name of the parameter.
description?	string	The description of the parameter.
value?	string	The value of the parameter.

---

isRequired

Type: boolean

A boolean that indicates if the parameter is required or optional.

---

name

Type: string

The name of the parameter.

---

description?

Type: string (optional)

The description of the parameter.

---

value?

Type: string (optional)

The value of the parameter.

Methods

Name	Description
static notRequired(name, value?, description?)	An optional parameter for an extension.
static required(name, value, description?)	A required parameter for an extension.

---

static notRequired(name, value?, description?)

public static notRequired(name: string, value?: string, description?: string): Parameter

Parameters

• name string — The name of the parameter.
• value string — The value of the parameter.
• description string — A description for the parameter.

Returns

• Parameter

An optional parameter for an extension.

---

static required(name, value, description?)

public static required(name: string, value: string, description?: string): Parameter

Parameters

• name string — The name of the parameter.
• value string — The value of the parameter.
• description string — A description for the parameter.

Returns

• Parameter

A required parameter for an extension.