Class: AWSCDK::CloudFront::KeyValueStoreProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
cloud_front/key_value_store_props.rb

Overview

The properties to create a Key Value Store.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(comment: nil, key_value_store_name: nil, source: nil) ⇒ KeyValueStoreProps

Returns a new instance of KeyValueStoreProps.

Parameters:

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

    A comment for the Key Value Store.

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

    The unique name of the Key Value Store.

  • source (AWSCDK::CloudFront::ImportSource, nil) (defaults to: nil) —

    The import source for the Key Value Store.



10
11
12
13
14
15
16
17
 
# File 'cloud_front/key_value_store_props.rb', line 10

def initialize(comment: nil, key_value_store_name: nil, source: nil)
  @comment = comment
  Jsii::Type.check_type(@comment, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "comment") unless @comment.nil?
  @key_value_store_name = key_value_store_name
  Jsii::Type.check_type(@key_value_store_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "keyValueStoreName") unless @key_value_store_name.nil?
  @source = source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWRmcm9udC5JbXBvcnRTb3VyY2UifQ==")), "source") unless @source.nil?
end

Instance Attribute Details

#comment ⇒ String? (readonly)

Note:

Default: No comment will be specified

A comment for the Key Value Store.

Returns:

  • (String, nil) 


23
24
25
 
# File 'cloud_front/key_value_store_props.rb', line 23

def comment
  @comment
end

#key_value_store_name ⇒ String? (readonly)

Note:

Default: A generated name

The unique name of the Key Value Store.

Returns:

  • (String, nil) 


28
29
30
 
# File 'cloud_front/key_value_store_props.rb', line 28

def key_value_store_name
  @key_value_store_name
end

#source ⇒ AWSCDK::CloudFront::ImportSource? (readonly)

Note:

Default: No data will be imported to the store

The import source for the Key Value Store.

This will populate the initial items in the Key Value Store. The source data must be in a valid JSON format.

Returns:



36
37
38
 
# File 'cloud_front/key_value_store_props.rb', line 36

def source
  @source
end

Class Method Details

.jsii_properties ⇒ Object 



38
39
40
41
42
43
44
 
# File 'cloud_front/key_value_store_props.rb', line 38

def self.jsii_properties
  {
    :comment => "comment",
    :key_value_store_name => "keyValueStoreName",
    :source => "source",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



46
47
48
49
50
51
52
53
54
 
# File 'cloud_front/key_value_store_props.rb', line 46

def to_jsii
  result = {}
  result.merge!({
    "comment" => @comment,
    "keyValueStoreName" => @key_value_store_name,
    "source" => @source,
  })
  result.compact
end