aws-cdk-lib.aws_opsworks.CfnApp.EnvironmentVariableProperty

interface EnvironmentVariableProperty

LanguageType name
.NETAmazon.CDK.AWS.OpsWorks.CfnApp.EnvironmentVariableProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopsworks#CfnApp_EnvironmentVariableProperty
Javasoftware.amazon.awscdk.services.opsworks.CfnApp.EnvironmentVariableProperty
Pythonaws_cdk.aws_opsworks.CfnApp.EnvironmentVariableProperty
TypeScript aws-cdk-lib » aws_opsworks » CfnApp » EnvironmentVariableProperty

Represents an app's environment variable.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opsworks as opsworks } from 'aws-cdk-lib';
const environmentVariableProperty: opsworks.CfnApp.EnvironmentVariableProperty = {
  key: 'key',
  value: 'value',

  // the properties below are optional
  secure: false,
};

Properties

NameTypeDescription
keystring(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
valuestring(Optional) The environment variable's value, which can be left empty.
secure?boolean | IResolvable(Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set Secure to true . DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false .

key

Type: string

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified.

The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.


value

Type: string

(Optional) The environment variable's value, which can be left empty.

If you specify a value, it can contain up to 256 characters, which must all be printable.


secure?

Type: boolean | IResolvable (optional)

(Optional) Whether the variable's value is returned by the DescribeApps action. To hide an environment variable's value, set Secure to true . DescribeApps returns *****FILTERED***** instead of the actual value. The default value for Secure is false .