Class: AWSCDK::AppConfig::ConfigurationOptions

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_config/configuration_options.rb

Overview

Options for the Configuration construct.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(deletion_protection_check: nil, deployment_key: nil, deployment_strategy: nil, deploy_to: nil, description: nil, name: nil, type: nil, validators: nil) ⇒ ConfigurationOptions

Returns a new instance of ConfigurationOptions.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'app_config/configuration_options.rb', line 15

def initialize(deletion_protection_check: nil, deployment_key: nil, deployment_strategy: nil, deploy_to: nil, description: nil, name: nil, type: nil, validators: nil)
  @deletion_protection_check = deletion_protection_check
  Jsii::Type.check_type(@deletion_protection_check, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkRlbGV0aW9uUHJvdGVjdGlvbkNoZWNrIn0=")), "deletionProtectionCheck") unless @deletion_protection_check.nil?
  @deployment_key = deployment_key
  Jsii::Type.check_type(@deployment_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "deploymentKey") unless @deployment_key.nil?
  @deployment_strategy = deployment_strategy
  Jsii::Type.check_type(@deployment_strategy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBjb25maWcuSURlcGxveW1lbnRTdHJhdGVneVJlZiJ9")), "deploymentStrategy") unless @deployment_strategy.nil?
  @deploy_to = deploy_to
  Jsii::Type.check_type(@deploy_to, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBjb25maWcuSUVudmlyb25tZW50In0sImtpbmQiOiJhcnJheSJ9fQ==")), "deployTo") unless @deploy_to.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNvbmZpZ3VyYXRpb25UeXBlIn0=")), "type") unless @type.nil?
  @validators = validators
  Jsii::Type.check_type(@validators, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBjb25maWcuSVZhbGlkYXRvciJ9LCJraW5kIjoiYXJyYXkifX0=")), "validators") unless @validators.nil?
end

Instance Attribute Details

#deletion_protection_check ⇒ AWSCDK::AppConfig::DeletionProtectionCheck? (readonly)

Note:

Default: DeletionProtectionCheck.ACCOUNT_DEFAULT

A parameter to configure deletion protection.

Deletion protection prevents a user from deleting a configuration profile if your application has called either GetLatestConfiguration or GetConfiguration for the configuration profile during the specified interval.

Returns:

See Also:



42
43
44
 
# File 'app_config/configuration_options.rb', line 42

def deletion_protection_check
  @deletion_protection_check
end

#deploy_to ⇒ Array<AWSCDK::AppConfig::IEnvironment>? (readonly)

Note:

Default: - None.

The list of environments to deploy the configuration to.

If this parameter is not specified, then there will be no deployment created alongside this configuration.

Deployments can be added later using the IEnvironment.addDeployment or IEnvironment.addDeployments methods.

Returns:



63
64
65
 
# File 'app_config/configuration_options.rb', line 63

def deploy_to
  @deploy_to
end

#deployment_key ⇒ AWSCDK::KMS::IKey? (readonly)

Note:

Default: - None.

The deployment key of the configuration.

Returns:



47
48
49
 
# File 'app_config/configuration_options.rb', line 47

def deployment_key
  @deployment_key
end

#deployment_strategy ⇒ AWSCDK::Interfaces::AWSAppconfig::IDeploymentStrategyRef? (readonly)

Note:

Default: - A deployment strategy with the rollout strategy set to RolloutStrategy.CANARY_10_PERCENT_20_MINUTES

The deployment strategy for the configuration.

Returns:



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

def deployment_strategy
  @deployment_strategy
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

The description of the configuration.

Returns:

  • (String, nil) 


68
69
70
 
# File 'app_config/configuration_options.rb', line 68

def description
  @description
end

#name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name of the configuration.

Returns:

  • (String, nil) 


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

def name
  @name
end

#type ⇒ AWSCDK::AppConfig::ConfigurationType? (readonly)

Note:

Default: ConfigurationType.FREEFORM

The type of configuration.

Returns:



78
79
80
 
# File 'app_config/configuration_options.rb', line 78

def type
  @type
end

#validators ⇒ Array<AWSCDK::AppConfig::IValidator>? (readonly)

Note:

Default: - No validators.

The validators for the configuration.

Returns:



83
84
85
 
# File 'app_config/configuration_options.rb', line 83

def validators
  @validators
end

Class Method Details

.jsii_properties ⇒ Object 



85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'app_config/configuration_options.rb', line 85

def self.jsii_properties
  {
    :deletion_protection_check => "deletionProtectionCheck",
    :deployment_key => "deploymentKey",
    :deployment_strategy => "deploymentStrategy",
    :deploy_to => "deployTo",
    :description => "description",
    :name => "name",
    :type => "type",
    :validators => "validators",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "deletionProtectionCheck" => @deletion_protection_check,
    "deploymentKey" => @deployment_key,
    "deploymentStrategy" => @deployment_strategy,
    "deployTo" => @deploy_to,
    "description" => @description,
    "name" => @name,
    "type" => @type,
    "validators" => @validators,
  })
  result.compact
end