Skip to content
v2.277.0

EnvironmentVariableProperty Struct ​

Example ​

ts
// 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,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opsworks as opsworks

environment_variable_property = opsworks.CfnApp.EnvironmentVariableProperty(
    key="key",
    value="value",

    # the properties below are optional
    secure=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.opsworks.*;

EnvironmentVariableProperty environmentVariableProperty = EnvironmentVariableProperty.builder()
        .key("key")
        .value("value")

        // the properties below are optional
        .secure(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpsWorks;

var environmentVariableProperty = new EnvironmentVariableProperty {
    Key = "key",
    Value = "value",

    // the properties below are optional
    Secure = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

environmentVariableProperty := &EnvironmentVariableProperty{
	Key: jsii.String("key"),
	Value: jsii.String("value"),

	// the properties below are optional
	Secure: jsii.Boolean(false),
}

Properties ​

keystringkeystrkeyStringKeystringKey*stringrequired#
(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.

secureoptionalboolean | IResolvablesecureoptionaltyping.Union[bool, IResolvable]secureoptionalBooleanSecureoptionalboolSecureoptionalinterface{}#
(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 .

valuestringvaluestrvalueStringValuestringValue*stringrequired#
(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.