Class: AWSCDK::GetContextKeyOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
get_context_key_options.rb

Direct Known Subclasses

GetContextValueOptions

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(provider:, additional_cache_key: nil, include_environment: nil, props: nil) ⇒ GetContextKeyOptions

Returns a new instance of GetContextKeyOptions.

Parameters:

  • provider (String) —

    The context provider to query.

  • additional_cache_key (String, nil) (defaults to: nil) —

    Adds an additional discriminator to the cdk.context.json cache key.

  • include_environment (Boolean, nil) (defaults to: nil) —

    Whether to include the stack's account and region automatically.

  • props (Hash{String => Object}, nil) (defaults to: nil) —

    Provider-specific properties.



10
11
12
13
14
15
16
17
18
19
 
# File 'get_context_key_options.rb', line 10

def initialize(provider:, additional_cache_key: nil, include_environment: nil, props: nil)
  @provider = provider
  Jsii::Type.check_type(@provider, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "provider")
  @additional_cache_key = additional_cache_key
  Jsii::Type.check_type(@additional_cache_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "additionalCacheKey") unless @additional_cache_key.nil?
  @include_environment = include_environment
  Jsii::Type.check_type(@include_environment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "includeEnvironment") unless @include_environment.nil?
  @props = props
  Jsii::Type.check_type(@props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props") unless @props.nil?
end

Instance Attribute Details

#additional_cache_key ⇒ String? (readonly)

Note:

Default: - no additional cache key

Adds an additional discriminator to the cdk.context.json cache key.

Returns:

  • (String, nil) 


29
30
31
 
# File 'get_context_key_options.rb', line 29

def additional_cache_key
  @additional_cache_key
end

#include_environment ⇒ Boolean? (readonly)

Note:

Default: true

Whether to include the stack's account and region automatically.

Returns:

  • (Boolean, nil) 


34
35
36
 
# File 'get_context_key_options.rb', line 34

def include_environment
  @include_environment
end

#props ⇒ Hash{String => Object}? (readonly)

Provider-specific properties.

Returns:

  • (Hash{String => Object}, nil) 


38
39
40
 
# File 'get_context_key_options.rb', line 38

def props
  @props
end

#provider ⇒ String (readonly)

The context provider to query.

Returns:

  • (String) 


24
25
26
 
# File 'get_context_key_options.rb', line 24

def provider
  @provider
end

Class Method Details

.jsii_properties ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'get_context_key_options.rb', line 40

def self.jsii_properties
  {
    :provider => "provider",
    :additional_cache_key => "additionalCacheKey",
    :include_environment => "includeEnvironment",
    :props => "props",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



49
50
51
52
53
54
55
56
57
58
 
# File 'get_context_key_options.rb', line 49

def to_jsii
  result = {}
  result.merge!({
    "provider" => @provider,
    "additionalCacheKey" => @additional_cache_key,
    "includeEnvironment" => @include_environment,
    "props" => @props,
  })
  result.compact
end