Class: AWSCDK::Connect::CfnDataTableProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
connect/cfn_data_table_props.rb

Overview

Properties for defining a CfnDataTable.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, instance_arn: nil, name: nil, status: nil, tags: nil, time_zone: nil, value_lock_level: nil) ⇒ CfnDataTableProps

Returns a new instance of CfnDataTableProps.

Parameters:

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

    An optional description of the data table's purpose and contents.

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

    The Amazon Resource Name (ARN) of the instance.

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

    The human-readable name of the data table.

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

    The current status of the data table.

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) —

    Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

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

    The IANA timezone identifier used when resolving time based dynamic values.

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

    The data level that concurrent value edits are locked on.



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

def initialize(description: nil, instance_arn: nil, name: nil, status: nil, tags: nil, time_zone: nil, value_lock_level: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @instance_arn = instance_arn
  Jsii::Type.check_type(@instance_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceArn") unless @instance_arn.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @status = status
  Jsii::Type.check_type(@status, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "status") unless @status.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
  @time_zone = time_zone
  Jsii::Type.check_type(@time_zone, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timeZone") unless @time_zone.nil?
  @value_lock_level = value_lock_level
  Jsii::Type.check_type(@value_lock_level, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "valueLockLevel") unless @value_lock_level.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

An optional description of the data table's purpose and contents.

Returns:

  • (String, nil)

See Also:



37
38
39
 
# File 'connect/cfn_data_table_props.rb', line 37

def description
  @description
end

#instance_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the instance.

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'connect/cfn_data_table_props.rb', line 42

def instance_arn
  @instance_arn
end

#name ⇒ String? (readonly)

The human-readable name of the data table.

Must be unique within the instance and conform to Connect naming standards.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'connect/cfn_data_table_props.rb', line 49

def name
  @name
end

#status ⇒ String? (readonly)

The current status of the data table.

One of PUBLISHED or SAVED.

Returns:

  • (String, nil)

See Also:



56
57
58
 
# File 'connect/cfn_data_table_props.rb', line 56

def status
  @status
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Key-value pairs for attribute based access control (TBAC or ABAC) and organization.

Returns:

See Also:



61
62
63
 
# File 'connect/cfn_data_table_props.rb', line 61

def tags
  @tags
end

#time_zone ⇒ String? (readonly)

The IANA timezone identifier used when resolving time based dynamic values.

Required even if no time slices are specified.

Returns:

  • (String, nil)

See Also:



68
69
70
 
# File 'connect/cfn_data_table_props.rb', line 68

def time_zone
  @time_zone
end

#value_lock_level ⇒ String? (readonly)

The data level that concurrent value edits are locked on.

One of DATA_TABLE, PRIMARY_VALUE, ATTRIBUTE, VALUE, and NONE. Determines how concurrent edits are handled when multiple users attempt to modify values simultaneously.

Returns:

  • (String, nil)

See Also:



75
76
77
 
# File 'connect/cfn_data_table_props.rb', line 75

def value_lock_level
  @value_lock_level
end

Class Method Details

.jsii_properties ⇒ Object 



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

def self.jsii_properties
  {
    :description => "description",
    :instance_arn => "instanceArn",
    :name => "name",
    :status => "status",
    :tags => "tags",
    :time_zone => "timeZone",
    :value_lock_level => "valueLockLevel",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "instanceArn" => @instance_arn,
    "name" => @name,
    "status" => @status,
    "tags" => @tags,
    "timeZone" => @time_zone,
    "valueLockLevel" => @value_lock_level,
  })
  result.compact
end