Class: AWSCDK::AppConfig::ConfigurationSource

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

Overview

Defines the integrated configuration sources.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConfigurationSource

Returns a new instance of ConfigurationSource.



8
9
10
 
# File 'app_config/configuration_source.rb', line 8

def initialize
  Jsii::Object.instance_method(:initialize).bind(self).call
end

Class Method Details

.from_bucket(bucket, object_key, key = nil) ⇒ AWSCDK::AppConfig::ConfigurationSource

Defines configuration content from an Amazon S3 bucket.

Parameters:

  • bucket (AWSCDK::S3::IBucket) —

    The S3 bucket where the configuration is stored.

  • object_key (String) —

    The path to the configuration.

  • key (AWSCDK::KMS::IKey, nil) (defaults to: nil) —

    The KMS Key that the bucket is encrypted with.

Returns:

  • (AWSCDK::AppConfig::ConfigurationSource) 


26
27
28
29
30
31
 
# File 'app_config/configuration_source.rb', line 26

def self.from_bucket(bucket, object_key, key = nil)
  Jsii::Type.check_type(bucket, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfczMuSUJ1Y2tldCJ9")), "bucket")
  Jsii::Type.check_type(object_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectKey")
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "key") unless key.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationSource", "fromBucket", [bucket, object_key, key])
end

.from_cfn_document(document) ⇒ AWSCDK::AppConfig::ConfigurationSource

Defines configuration content from a Systems Manager (SSM) document.

Parameters:

Returns:

  • (AWSCDK::AppConfig::ConfigurationSource) 


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

def self.from_cfn_document(document)
  Jsii::Type.check_type(document, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLkNmbkRvY3VtZW50In0=")), "document")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationSource", "fromCfnDocument", [document])
end

.from_parameter(parameter, key = nil) ⇒ AWSCDK::AppConfig::ConfigurationSource

Defines configuration content from a Systems Manager (SSM) Parameter Store parameter.

Parameters:

Returns:

  • (AWSCDK::AppConfig::ConfigurationSource) 


47
48
49
50
51
 
# File 'app_config/configuration_source.rb', line 47

def self.from_parameter(parameter, key = nil)
  Jsii::Type.check_type(parameter, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc3NtLklQYXJhbWV0ZXIifQ==")), "parameter")
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa21zLklLZXkifQ==")), "key") unless key.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationSource", "fromParameter", [parameter, key])
end

.from_pipeline(pipeline) ⇒ AWSCDK::AppConfig::ConfigurationSource

Defines configuration content from AWS CodePipeline.

Parameters:

Returns:

  • (AWSCDK::AppConfig::ConfigurationSource) 


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

def self.from_pipeline(pipeline)
  Jsii::Type.check_type(pipeline, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2RlcGlwZWxpbmUuSVBpcGVsaW5lUmVmIn0=")), "pipeline")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationSource", "fromPipeline", [pipeline])
end

.from_secret(secret) ⇒ AWSCDK::AppConfig::ConfigurationSource

Defines configuration content from an AWS Secrets Manager secret.

Parameters:

Returns:

  • (AWSCDK::AppConfig::ConfigurationSource) 


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

def self.from_secret(secret)
  Jsii::Type.check_type(secret, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfc2VjcmV0c21hbmFnZXIuSVNlY3JldCJ9")), "secret")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationSource", "fromSecret", [secret])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
 
# File 'app_config/configuration_source.rb', line 12

def self.jsii_overridable_methods
  {
    :location_uri => { kind: :property, name: "locationUri", is_optional: false },
    :type => { kind: :property, name: "type", is_optional: false },
    :key => { kind: :property, name: "key", is_optional: true },
  }
end

Instance Method Details

#key ⇒ AWSCDK::KMS::IKey?

The KMS Key that encrypts the configuration.

Returns:



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

def key()
  jsii_get_property("key")
end

#location_uri ⇒ String

The URI of the configuration source.

Returns:

  • (String) 


74
75
76
 
# File 'app_config/configuration_source.rb', line 74

def location_uri()
  jsii_get_property("locationUri")
end

#type ⇒ AWSCDK::AppConfig::ConfigurationSourceType

The type of the configuration source.

Returns:



81
82
83
 
# File 'app_config/configuration_source.rb', line 81

def type()
  jsii_get_property("type")
end