Class: AWSCDK::AppConfig::ConfigurationContent

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

Overview

Defines the hosted configuration content.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeConfigurationContent

Returns a new instance of ConfigurationContent.



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

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

Class Method Details

.from_file(input_path, content_type = nil) ⇒ AWSCDK::AppConfig::ConfigurationContent

Defines the hosted configuration content from a file.

Parameters:

  • input_path (String)

    The path to the file that defines configuration content.

  • content_type (String, nil) (defaults to: nil)

    The configuration content type, specified as a standard MIME type. Supported examples include: - text/plain - application/json - application/octet-stream - application/x-yaml.

Returns:

  • (AWSCDK::AppConfig::ConfigurationContent)


24
25
26
27
28
# File 'app_config/configuration_content.rb', line 24

def self.from_file(input_path, content_type = nil)
  Jsii::Type.check_type(input_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputPath")
  Jsii::Type.check_type(content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless content_type.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationContent", "fromFile", [input_path, content_type])
end

.from_inline(content, content_type = nil) ⇒ AWSCDK::AppConfig::ConfigurationContent

Defines the hosted configuration content from inline code.

Parameters:

  • content (String)

    The inline code that defines the configuration content.

  • content_type (String, nil) (defaults to: nil)

    The configuration content type, specified as a standard MIME type. Supported examples include: - text/plain - application/json - application/octet-stream - application/x-yaml.

Returns:

  • (AWSCDK::AppConfig::ConfigurationContent)


35
36
37
38
39
# File 'app_config/configuration_content.rb', line 35

def self.from_inline(content, content_type = nil)
  Jsii::Type.check_type(content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  Jsii::Type.check_type(content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless content_type.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationContent", "fromInline", [content, content_type])
end

.from_inline_json(content, content_type = nil) ⇒ AWSCDK::AppConfig::ConfigurationContent

Defines the hosted configuration content as JSON from inline code.

Parameters:

  • content (String)

    The inline code that defines the configuration content.

  • content_type (String, nil) (defaults to: nil)

    The configuration content type, specified as a standard MIME type. Supported examples include: - text/plain - application/json - application/octet-stream - application/x-yaml.

Returns:

  • (AWSCDK::AppConfig::ConfigurationContent)


46
47
48
49
50
# File 'app_config/configuration_content.rb', line 46

def self.from_inline_json(content, content_type = nil)
  Jsii::Type.check_type(content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  Jsii::Type.check_type(content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless content_type.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationContent", "fromInlineJson", [content, content_type])
end

.from_inline_text(content) ⇒ AWSCDK::AppConfig::ConfigurationContent

Defines the hosted configuration content as text from inline code.

Parameters:

  • content (String)

    The inline code that defines the configuration content.

Returns:

  • (AWSCDK::AppConfig::ConfigurationContent)


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

def self.from_inline_text(content)
  Jsii::Type.check_type(content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationContent", "fromInlineText", [content])
end

.from_inline_yaml(content) ⇒ AWSCDK::AppConfig::ConfigurationContent

Defines the hosted configuration content as YAML from inline code.

Parameters:

  • content (String)

    The inline code that defines the configuration content.

Returns:

  • (AWSCDK::AppConfig::ConfigurationContent)


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

def self.from_inline_yaml(content)
  Jsii::Type.check_type(content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appconfig.ConfigurationContent", "fromInlineYaml", [content])
end

.jsii_overridable_methodsObject



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

def self.jsii_overridable_methods
  {
    :content => { kind: :property, name: "content", is_optional: false },
    :content_type => { kind: :property, name: "contentType", is_optional: false },
  }
end

Instance Method Details

#contentString

The configuration content.

Returns:

  • (String)


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

def content()
  jsii_get_property("content")
end

#content_typeString

The configuration content type, specified as a standard MIME type. Supported examples include: - text/plain - application/json - application/octet-stream - application/x-yaml.

For an up-to-date list of valid MIME types, see: https://www.iana.org/assignments/media-types/media-types.xhtml

Returns:

  • (String)


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

def content_type()
  jsii_get_property("contentType")
end