Class: AWSCDK::AppConfig::SourcedConfigurationProps

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

Overview

Properties for SourcedConfiguration.

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:, location:, retrieval_role: nil, version_number: nil) ⇒ SourcedConfigurationProps

Returns a new instance of SourcedConfigurationProps.

Parameters:



19
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
 
# File 'app_config/sourced_configuration_props.rb', line 19

def initialize(deletion_protection_check: nil, deployment_key: nil, deployment_strategy: nil, deploy_to: nil, description: nil, name: nil, type: nil, validators: nil, application:, location:, retrieval_role: nil, version_number: 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")
  @location = location
  Jsii::Type.check_type(@location, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwY29uZmlnLkNvbmZpZ3VyYXRpb25Tb3VyY2UifQ==")), "location")
  @retrieval_role = retrieval_role
  Jsii::Type.check_type(@retrieval_role, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19pYW0uSVJvbGVSZWYifQ==")), "retrievalRole") unless @retrieval_role.nil?
  @version_number = version_number
  Jsii::Type.check_type(@version_number, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "versionNumber") unless @version_number.nil?
end

Instance Attribute Details

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

The application associated with the configuration.

Returns:



99
100
101
 
# File 'app_config/sourced_configuration_props.rb', line 99

def application
  @application
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:



54
55
56
 
# File 'app_config/sourced_configuration_props.rb', line 54

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:



75
76
77
 
# File 'app_config/sourced_configuration_props.rb', line 75

def deploy_to
  @deploy_to
end

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

Note:

Default: - None.

The deployment key of the configuration.

Returns:



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

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:



64
65
66
 
# File 'app_config/sourced_configuration_props.rb', line 64

def deployment_strategy
  @deployment_strategy
end

#description ⇒ String? (readonly)

Note:

Default: - No description.

The description of the configuration.

Returns:

  • (String, nil) 


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

def description
  @description
end

#location ⇒ AWSCDK::AppConfig::ConfigurationSource (readonly)

The location where the configuration is stored.

Returns:



103
104
105
 
# File 'app_config/sourced_configuration_props.rb', line 103

def location
  @location
end

#name ⇒ String? (readonly)

Note:

Default: - A name is generated.

The name of the configuration.

Returns:

  • (String, nil) 


85
86
87
 
# File 'app_config/sourced_configuration_props.rb', line 85

def name
  @name
end

#retrieval_role ⇒ AWSCDK::Interfaces::AWSIAM::IRoleRef? (readonly)

Note:

Default: - Auto generated if location type is not ConfigurationSourceType.CODE_PIPELINE otherwise no role specified.

The IAM role to retrieve the configuration.

Returns:



108
109
110
 
# File 'app_config/sourced_configuration_props.rb', line 108

def retrieval_role
  @retrieval_role
end

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

Note:

Default: ConfigurationType.FREEFORM

The type of configuration.

Returns:



90
91
92
 
# File 'app_config/sourced_configuration_props.rb', line 90

def type
  @type
end

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

Note:

Default: - No validators.

The validators for the configuration.

Returns:



95
96
97
 
# File 'app_config/sourced_configuration_props.rb', line 95

def validators
  @validators
end

#version_number ⇒ String? (readonly)

Note:

Default: - None.

The version number of the sourced configuration to deploy.

If this is not specified, then there will be no deployment.

Returns:

  • (String, nil) 


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

def version_number
  @version_number
end

Class Method Details

.jsii_properties ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'app_config/sourced_configuration_props.rb', line 118

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",
    :location => "location",
    :retrieval_role => "retrievalRole",
    :version_number => "versionNumber",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'app_config/sourced_configuration_props.rb', line 135

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,
    "location" => @location,
    "retrievalRole" => @retrieval_role,
    "versionNumber" => @version_number,
  })
  result.compact
end