Struct Environment 

#[non_exhaustive]
pub struct Environment {
    pub name: Arc<str>,
    pub aws_account_id: Option<AccountId>,
    pub aws_region: Option<Region>,
    pub aws_profile: Option<Arc<str>>,
    pub source_file: Arc<Path>,
    pub locals: Map,
}

A named environment (staging, production, etc.).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: Arc<str>

Environment name (e.g. staging).

aws_account_id: Option<AccountId>

AWS account id (12 digits). None if the source did not declare one.

aws_region: Option<Region>

AWS region. None if the source did not declare one.

aws_profile: Option<Arc<str>>

AWS shared-config profile name. None if the source did not declare one.

source_file: Arc<Path>

Path of the source file that defined this environment (typically terraform/environments/<name>.terragrunt.hcl).

locals: Map

Resolved environment-level locals (every other key from the source file).

Implementations

impl Environment

pub fn builder() -> EnvironmentBuilder<((), (), (), (), (), ())>

Create a builder for building Environment. On the builder, call .name(...), .aws_account_id(...)(optional), .aws_region(...)(optional), .aws_profile(...)(optional), .source_file(...), .locals(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Environment.

Trait Implementations

impl Clone for Environment

fn clone(&self) -> Environment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Environment

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Environment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Environment

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for Environment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Environment