Class: AWSCDK::CXAPI::Environment Deprecated

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cxapi/environment.rb

Overview

Deprecated.

The official definition of this type has moved to @aws-cdk/cloud-assembly-api.

Models an AWS execution environment, for use within the CDK toolkit.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(account:, name:, region:) ⇒ Environment

Returns a new instance of Environment.

Parameters:

  • account (String)

    The AWS account this environment deploys into.

  • name (String)

    The arbitrary name of this environment (user-set, or at least user-meaningful).

  • region (String)

    The AWS region name where this environment deploys into.



12
13
14
15
16
17
18
19
# File 'cxapi/environment.rb', line 12

def initialize(account:, name:, region:)
  @account = 
  Jsii::Type.check_type(@account, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "account")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @region = region
  Jsii::Type.check_type(@region, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "region")
end

Instance Attribute Details

#accountString (readonly)

The AWS account this environment deploys into.

Returns:

  • (String)


24
25
26
# File 'cxapi/environment.rb', line 24

def 
  @account
end

#nameString (readonly)

The arbitrary name of this environment (user-set, or at least user-meaningful).

Returns:

  • (String)


28
29
30
# File 'cxapi/environment.rb', line 28

def name
  @name
end

#regionString (readonly)

The AWS region name where this environment deploys into.

Returns:

  • (String)


32
33
34
# File 'cxapi/environment.rb', line 32

def region
  @region
end

Class Method Details

.jsii_propertiesObject



34
35
36
37
38
39
40
# File 'cxapi/environment.rb', line 34

def self.jsii_properties
  {
    :account => "account",
    :name => "name",
    :region => "region",
  }
end

Instance Method Details

#to_jsiiObject



42
43
44
45
46
47
48
49
50
# File 'cxapi/environment.rb', line 42

def to_jsii
  result = {}
  result.merge!({
    "account" => @account,
    "name" => @name,
    "region" => @region,
  })
  result.compact
end