Class: AWSCDK::AppConfig::HostedConfigurationProps

Inherits:
ConfigurationProps
  • Object
show all
Defined in:
app_config/hosted_configuration_props.rb

Overview

Properties for HostedConfiguration.

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, application:, content:, kms_key: nil, latest_version_number: nil, version_label: nil) ⇒ HostedConfigurationProps

Returns a new instance of HostedConfigurationProps.

Parameters:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'app_config/hosted_configuration_props.rb', line 20

def initialize(deletion_protection_check: nil, deployment_key: nil, deployment_strategy: nil, deploy_to: nil, description: nil, name: nil, type: nil, validators: nil, application:, content:, kms_key: nil, latest_version_number: nil, version_label: 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?
  @application = application
  Jsii::Type.check_type(@application, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLklBcHBsaWNhdGlvbiJ9")), "application")
  @content = content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNvbmZpZ3VyYXRpb25Db250ZW50In0=")), "content")
  @kms_key = kms_key
  Jsii::Type.check_type(@kms_key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rbXMuSUtleVJlZiJ9")), "kmsKey") unless @kms_key.nil?
  @latest_version_number = latest_version_number
  Jsii::Type.check_type(@latest_version_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "latestVersionNumber") unless @latest_version_number.nil?
  @version_label = version_label
  Jsii::Type.check_type(@version_label, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionLabel") unless @version_label.nil?
end

Instance Attribute Details

#application ⇒ AWSCDK::AppConfig::IApplication (readonly)

The application associated with the configuration.

Returns:



102
103
104
 
# File 'app_config/hosted_configuration_props.rb', line 102

def application
  @application
end

#content ⇒ AWSCDK::AppConfig::ConfigurationContent (readonly)

The content of the hosted configuration.

Returns:



106
107
108
 
# File 'app_config/hosted_configuration_props.rb', line 106

def content
  @content
end

#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:



57
58
59
 
# File 'app_config/hosted_configuration_props.rb', line 57

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:



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

def deploy_to
  @deploy_to
end

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

Note:

Default: - None.

The deployment key of the configuration.

Returns:



62
63
64
 
# File 'app_config/hosted_configuration_props.rb', line 62

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:



67
68
69
 
# File 'app_config/hosted_configuration_props.rb', line 67

def deployment_strategy
  @deployment_strategy
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

The description of the configuration.

Returns:

  • (String, nil) 


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

def description
  @description
end

#kms_key ⇒ AWSCDK::Interfaces::AWSKMS::IKeyRef? (readonly)

Note:

Default: None

The customer managed key to encrypt hosted configuration.

Returns:



111
112
113
 
# File 'app_config/hosted_configuration_props.rb', line 111

def kms_key
  @kms_key
end

#latest_version_number ⇒ Numeric? (readonly)

Note:

Default: - None.

The latest version number of the hosted configuration.

Returns:

  • (Numeric, nil) 


116
117
118
 
# File 'app_config/hosted_configuration_props.rb', line 116

def latest_version_number
  @latest_version_number
end

#name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name of the configuration.

Returns:

  • (String, nil) 


88
89
90
 
# File 'app_config/hosted_configuration_props.rb', line 88

def name
  @name
end

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

Note:

Default: ConfigurationType.FREEFORM

The type of configuration.

Returns:



93
94
95
 
# File 'app_config/hosted_configuration_props.rb', line 93

def type
  @type
end

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

Note:

Default: - No validators.

The validators for the configuration.

Returns:



98
99
100
 
# File 'app_config/hosted_configuration_props.rb', line 98

def validators
  @validators
end

#version_label ⇒ String? (readonly)

Note:

Default: - None.

The version label of the hosted configuration.

Returns:

  • (String, nil) 


121
122
123
 
# File 'app_config/hosted_configuration_props.rb', line 121

def version_label
  @version_label
end

Class Method Details

.jsii_properties ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'app_config/hosted_configuration_props.rb', line 123

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",
    :application => "application",
    :content => "content",
    :kms_key => "kmsKey",
    :latest_version_number => "latestVersionNumber",
    :version_label => "versionLabel",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'app_config/hosted_configuration_props.rb', line 141

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "deletionProtectionCheck" => @deletion_protection_check,
    "deploymentKey" => @deployment_key,
    "deploymentStrategy" => @deployment_strategy,
    "deployTo" => @deploy_to,
    "description" => @description,
    "name" => @name,
    "type" => @type,
    "validators" => @validators,
    "application" => @application,
    "content" => @content,
    "kmsKey" => @kms_key,
    "latestVersionNumber" => @latest_version_number,
    "versionLabel" => @version_label,
  })
  result.compact
end