Struct aws_sdk_codebuild::types::builders::EnvironmentVariableBuilder

#[non_exhaustive]
pub struct EnvironmentVariableBuilder { /* private fields */ }

A builder for EnvironmentVariable.

Implementations

impl EnvironmentVariableBuilder

pub fn name(self, input: impl Into<String>) -> Self

The name or key of the environment variable.

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

The name or key of the environment variable.

pub fn get_name(&self) -> &Option<String>

The name or key of the environment variable.

pub fn value(self, input: impl Into<String>) -> Self

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

This field is required.

pub fn set_value(self, input: Option<String>) -> Self

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

pub fn get_value(&self) -> &Option<String>

The value of the environment variable.

We strongly discourage the use of PLAINTEXT environment variables to store sensitive values, especially Amazon Web Services secret key IDs. PLAINTEXT environment variables can be displayed in plain text using the CodeBuild console and the CLI. For sensitive values, we recommend you use an environment variable of type PARAMETER_STORE or SECRETS_MANAGER.

pub fn type(self, input: EnvironmentVariableType) -> Self

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

• PLAINTEXT: An environment variable in plain text format. This is the default value.

• SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

pub fn set_type(self, input: Option<EnvironmentVariableType>) -> Self

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

• PLAINTEXT: An environment variable in plain text format. This is the default value.

• SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

pub fn get_type(&self) -> &Option<EnvironmentVariableType>

The type of environment variable. Valid values include:

• PARAMETER_STORE: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the value of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see env/parameter-store in the CodeBuild User Guide.

• PLAINTEXT: An environment variable in plain text format. This is the default value.

• SECRETS_MANAGER: An environment variable stored in Secrets Manager. For environment variables of this type, specify the name of the secret as the value of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define Secrets Manager environment variables in the buildspec. To learn how to do so, see env/secrets-manager in the CodeBuild User Guide.

pub fn build(self) -> Result<EnvironmentVariable, BuildError>

Consumes the builder and constructs a EnvironmentVariable. This method will fail if any of the following fields are not set:

• name
• value

Trait Implementations

impl Clone for EnvironmentVariableBuilder

fn clone(&self) -> EnvironmentVariableBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EnvironmentVariableBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EnvironmentVariableBuilder

fn default() -> EnvironmentVariableBuilder

Returns the “default value” for a type.

impl PartialEq for EnvironmentVariableBuilder

fn eq(&self, other: &EnvironmentVariableBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EnvironmentVariableBuilder