software.amazon.awscdk.services.opsworks

Interface CfnApp.EnvironmentVariableProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnApp.EnvironmentVariableProperty.Jsii$Proxy

Enclosing class:

CfnApp

@Stability(value=Stable)
public static interface CfnApp.EnvironmentVariableProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.opsworks.*;
 EnvironmentVariableProperty environmentVariableProperty = EnvironmentVariableProperty.builder()
         .key("key")
         .value("value")
         // the properties below are optional
         .secure(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnApp.EnvironmentVariableProperty.Builder A builder for CfnApp.EnvironmentVariableProperty
static class	CfnApp.EnvironmentVariableProperty.Jsii$Proxy An implementation for CfnApp.EnvironmentVariableProperty

Method Summary

Modifier and Type	Method and Description
static CfnApp.EnvironmentVariableProperty.Builder	builder()
String	getKey() (Required) The environment variable's name, which can consist of up to 64 characters and must be specified.
default Object	getSecure() (Optional) Whether the variable's value is returned by the [DescribeApps](https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/DescribeApps) action.
String	getValue() (Optional) The environment variable's value, which can be left empty.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getKey

@Stability(value=Stable)
 @NotNull
String getKey()

(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.

getValue

@Stability(value=Stable)
 @NotNull
String getValue()

(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.

getSecure

@Stability(value=Stable)
 @Nullable
default Object getSecure()

(Optional) Whether the variable's value is returned by the [DescribeApps](https://docs.aws.amazon.com/goto/WebAPI/opsworks-2013-02-18/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` .

builder

@Stability(value=Stable)
static CfnApp.EnvironmentVariableProperty.Builder builder()

Returns:

a CfnApp.EnvironmentVariableProperty.Builder of CfnApp.EnvironmentVariableProperty