class Parameter
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.AppConfig.Alpha.Parameter |
Go | github.com/aws/aws-cdk-go/awscdkappconfigalpha/v2#Parameter |
Java | software.amazon.awscdk.services.appconfig.alpha.Parameter |
Python | aws_cdk.aws_appconfig_alpha.Parameter |
TypeScript (source) | @aws-cdk/aws-appconfig-alpha » Parameter |
⚠️ Deprecated: undefined
Defines a parameter for an extension.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appconfig_alpha from '@aws-cdk/aws-appconfig-alpha';
const parameter = appconfig_alpha.Parameter.notRequired('name', /* all optional props */ 'value', /* all optional props */ 'description');
Properties
Name | Type | Description |
---|---|---|
is | 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
⚠️ Deprecated: undefined
Type:
boolean
A boolean that indicates if the parameter is required or optional.
name
⚠️ Deprecated: undefined
Type:
string
The name of the parameter.
description?
⚠️ Deprecated: undefined
Type:
string
(optional)
The description of the parameter.
value?
⚠️ Deprecated: undefined
Type:
string
(optional)
The value of the parameter.
Methods
Name | Description |
---|---|
static not | An optional parameter for an extension. |
static required(name, value, description?) | A required parameter for an extension. |
Required(name, value?, description?)
static notpublic static notRequired(name: string, value?: string, description?: string): Parameter
⚠️ Deprecated: undefined
Parameters
- name
string
— The name of the parameter. - value
string
— The value of the parameter. - description
string
— A description for the parameter.
Returns
An optional parameter for an extension.
static required(name, value, description?)
public static required(name: string, value: string, description?: string): Parameter
⚠️ Deprecated: undefined
Parameters
- name
string
— The name of the parameter. - value
string
— The value of the parameter. - description
string
— A description for the parameter.
Returns
A required parameter for an extension.