Class: AWSCDK::AppConfig::CfnHostedConfigurationVersionProps

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

Overview

Properties for defining a CfnHostedConfigurationVersion.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_id:, configuration_profile_id:, content:, content_type:, description: nil, latest_version_number: nil, version_label: nil) ⇒ CfnHostedConfigurationVersionProps

Returns a new instance of CfnHostedConfigurationVersionProps.

Parameters:

  • application_id (String, AWSCDK::Interfaces::AWSAppconfig::IApplicationRef) —

    The application ID.

  • configuration_profile_id (String, AWSCDK::Interfaces::AWSAppconfig::IConfigurationProfileRef) —

    The configuration profile ID.

  • content (String) —

    The configuration data, as bytes.

  • content_type (String) —

    A standard MIME type describing the format of the configuration content.

  • description (String, nil) (defaults to: nil) —

    A description of the configuration.

  • latest_version_number (Numeric, nil) (defaults to: nil) —

    An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.

  • version_label (String, nil) (defaults to: nil) —

    A user-defined label for an AWS AppConfig hosted configuration version.



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

def initialize(application_id:, configuration_profile_id:, content:, content_type:, description: nil, latest_version_number: nil, version_label: nil)
  @application_id = application_id
  Jsii::Type.check_type(@application_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBjb25maWcuSUFwcGxpY2F0aW9uUmVmIn1dfX0=")), "applicationId")
  @configuration_profile_id = configuration_profile_id
  Jsii::Type.check_type(@configuration_profile_id, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19hcHBjb25maWcuSUNvbmZpZ3VyYXRpb25Qcm9maWxlUmVmIn1dfX0=")), "configurationProfileId")
  @content = content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content")
  @content_type = content_type
  Jsii::Type.check_type(@content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.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_id ⇒ String, AWSCDK::Interfaces::AWSAppconfig::IApplicationRef (readonly)

The application ID.

Returns:

See Also:



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

def application_id
  @application_id
end

#configuration_profile_id ⇒ String, AWSCDK::Interfaces::AWSAppconfig::IConfigurationProfileRef (readonly)

The configuration profile ID.

Returns:

See Also:



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

def configuration_profile_id
  @configuration_profile_id
end

#content ⇒ String (readonly)

The configuration data, as bytes.

AWS AppConfig accepts any type of data, including text formats like JSON or TOML, or binary formats like protocol buffers or compressed data.

Returns:

  • (String)

See Also:



49
50
51
 
# File 'app_config/cfn_hosted_configuration_version_props.rb', line 49

def content
  @content
end

#content_type ⇒ String (readonly)

A standard MIME type describing the format of the configuration content.

For more information, see Content-Type .

Returns:

  • (String)

See Also:



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

def content_type
  @content_type
end

#description ⇒ String? (readonly)

A description of the configuration.

Due to HTTP limitations, this field only supports ASCII characters.

Returns:

  • (String, nil)

See Also:



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

def description
  @description
end

#latest_version_number ⇒ Numeric? (readonly)

An optional locking token used to prevent race conditions from overwriting configuration updates when creating a new version.

To ensure your data is not overwritten when creating multiple hosted configuration versions in rapid succession, specify the version number of the latest hosted configuration version.

Returns:

  • (Numeric, nil)

See Also:



70
71
72
 
# File 'app_config/cfn_hosted_configuration_version_props.rb', line 70

def latest_version_number
  @latest_version_number
end

#version_label ⇒ String? (readonly)

A user-defined label for an AWS AppConfig hosted configuration version.

Returns:

  • (String, nil)

See Also:



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

def version_label
  @version_label
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
 
# File 'app_config/cfn_hosted_configuration_version_props.rb', line 77

def self.jsii_properties
  {
    :application_id => "applicationId",
    :configuration_profile_id => "configurationProfileId",
    :content => "content",
    :content_type => "contentType",
    :description => "description",
    :latest_version_number => "latestVersionNumber",
    :version_label => "versionLabel",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'app_config/cfn_hosted_configuration_version_props.rb', line 89

def to_jsii
  result = {}
  result.merge!({
    "applicationId" => @application_id,
    "configurationProfileId" => @configuration_profile_id,
    "content" => @content,
    "contentType" => @content_type,
    "description" => @description,
    "latestVersionNumber" => @latest_version_number,
    "versionLabel" => @version_label,
  })
  result.compact
end