Parameter Class
Defines a parameter for an extension.
Example
ts
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'),
]
});
python
# fn: lambda.Function
appconfig.Extension(self, "MyExtension",
actions=[
appconfig.Action(
action_points=[appconfig.ActionPoint.ON_DEPLOYMENT_START],
event_destination=appconfig.LambdaDestination(fn)
)
],
parameters=[
appconfig.Parameter.required("testParam", "true"),
appconfig.Parameter.not_required("testNotRequiredParam")
]
)
java
Function fn;
Extension.Builder.create(this, "MyExtension")
.actions(List.of(
Action.Builder.create()
.actionPoints(List.of(ActionPoint.ON_DEPLOYMENT_START))
.eventDestination(new LambdaDestination(fn))
.build()))
.parameters(List.of(Parameter.required("testParam", "true"), Parameter.notRequired("testNotRequiredParam")))
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
Function fn;
new Extension(this, "MyExtension", new ExtensionProps {
Actions = new [] {
new Action(new ActionProps {
ActionPoints = new [] { ActionPoint.ON_DEPLOYMENT_START },
EventDestination = new LambdaDestination(fn)
}) },
Parameters = new [] { Parameter.Required("testParam", "true"), Parameter.NotRequired("testNotRequiredParam") }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var fn Function
appconfig.NewExtension(this, jsii.String("MyExtension"), &ExtensionProps{
Actions: []Action{
appconfig.NewAction(&ActionProps{
ActionPoints: []ActionPoint{
appconfig.ActionPoint_ON_DEPLOYMENT_START,
},
EventDestination: appconfig.NewLambdaDestination(fn),
}),
},
Parameters: []Parameter{
appconfig.Parameter_Required(jsii.String("testParam"), jsii.String("true")),
appconfig.Parameter_NotRequired(jsii.String("testNotRequiredParam")),
},
})
Properties
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#The description of the parameter.
A boolean that indicates if the parameter is required or optional.
The name of the parameter.
valuemay be undefinedstringvaluemay be undefinedstrvaluemay be undefinedStringValuemay be undefinedstringValuemay be undefined*string#The value of the parameter.
Methods
notRequired(name: string, value?: string, description?: string): Parameter // chainable@staticmethod def not_required(name: str, value: typing.Optional[str] = None, description: typing.Optional[str] = None) -> Parameterpublic static Parameter notRequired(String name, String value, String description)public static Parameter NotRequired(string name, string? value = null, string? description = null)func NotRequired(Name *string, Value *string, Description *string) Parameterstatic#An optional parameter for an extension.
3 parameters
Parameters
namenamenamenameName— The name of the parameter.valuevaluevaluevalueValue— The value of the parameter.descriptiondescriptiondescriptiondescriptionDescription— A description for the parameter.
required(name: string, value: string, description?: string): Parameter // chainable@staticmethod def required(name: str, value: str, description: typing.Optional[str] = None) -> Parameterpublic static Parameter required(String name, String value, String description)public static Parameter Required(string name, string value, string? description = null)func Required(Name *string, Value *string, Description *string) Parameterstatic#A required parameter for an extension.
3 parameters
Parameters
namenamenamenameName— The name of the parameter.valuevaluevaluevalueValue— The value of the parameter.descriptiondescriptiondescriptiondescriptionDescription— A description for the parameter.