Module: AWSCDK::AppConfig::IConfiguration

Includes:
Constructs::IConstruct
Included in:
HostedConfiguration, SourcedConfiguration
Defined in:
app_config/i_configuration.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methodsObject



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
# File 'app_config/i_configuration.rb', line 98

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :application => { kind: :property, name: "application", is_optional: false },
    :configuration_profile_id => { kind: :property, name: "configurationProfileId", is_optional: false },
    :deployment_key => { kind: :property, name: "deploymentKey", is_optional: true },
    :deployment_strategy => { kind: :property, name: "deploymentStrategy", is_optional: true },
    :deploy_to => { kind: :property, name: "deployTo", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :type => { kind: :property, name: "type", is_optional: true },
    :validators => { kind: :property, name: "validators", is_optional: true },
    :version_number => { kind: :property, name: "versionNumber", is_optional: true },
    :with => { kind: :method, name: "with", is_optional: false },
  }
end

Instance Method Details

#applicationAWSCDK::AppConfig::IApplication

The application associated with the configuration.



17
18
19
# File 'app_config/i_configuration.rb', line 17

def application()
  jsii_get_property("application")
end

#configuration_profile_idString

The ID of the configuration profile.

Returns:

  • (String)


24
25
26
# File 'app_config/i_configuration.rb', line 24

def configuration_profile_id()
  jsii_get_property("configurationProfileId")
end

#deploy_toArray<AWSCDK::AppConfig::IEnvironment>?

The environments to deploy to.

Returns:



45
46
47
# File 'app_config/i_configuration.rb', line 45

def deploy_to()
  jsii_get_property("deployTo")
end

#deployment_keyAWSCDK::KMS::IKey?

The deployment key for the configuration.

Returns:



31
32
33
# File 'app_config/i_configuration.rb', line 31

def deployment_key()
  jsii_get_property("deploymentKey")
end

#deployment_strategyAWSCDK::AppConfig::IDeploymentStrategy?

The deployment strategy for the configuration.



38
39
40
# File 'app_config/i_configuration.rb', line 38

def deployment_strategy()
  jsii_get_property("deploymentStrategy")
end

#descriptionString?

The description of the configuration.

Returns:

  • (String, nil)


52
53
54
# File 'app_config/i_configuration.rb', line 52

def description()
  jsii_get_property("description")
end

#nameString?

The name of the configuration.

Returns:

  • (String, nil)


59
60
61
# File 'app_config/i_configuration.rb', line 59

def name()
  jsii_get_property("name")
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


10
11
12
# File 'app_config/i_configuration.rb', line 10

def node()
  jsii_get_property("node")
end

#typeAWSCDK::AppConfig::ConfigurationType?

The configuration type.



66
67
68
# File 'app_config/i_configuration.rb', line 66

def type()
  jsii_get_property("type")
end

#validatorsArray<AWSCDK::AppConfig::IValidator>?

The validators for the configuration.

Returns:



73
74
75
# File 'app_config/i_configuration.rb', line 73

def validators()
  jsii_get_property("validators")
end

#version_numberString?

The configuration version number.

Returns:

  • (String, nil)


80
81
82
# File 'app_config/i_configuration.rb', line 80

def version_number()
  jsii_get_property("versionNumber")
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

Parameters:

  • mixins (Array<Constructs::IMixin>)

    The mixins to apply.

Returns:

  • (Constructs::IConstruct)

    This construct for chaining



91
92
93
94
95
96
# File 'app_config/i_configuration.rb', line 91

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end