Class: AWSCDK::CustomerProfiles::CfnDomainObjectTypeProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
customer_profiles/cfn_domain_object_type_props.rb

Overview

Properties for defining a CfnDomainObjectType.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, fields:, object_type_name:, description: nil, encryption_key: nil, tags: nil) ⇒ CfnDomainObjectTypeProps

Returns a new instance of CfnDomainObjectTypeProps.

Parameters:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 15

def initialize(domain_name:, fields:, object_type_name:, description: nil, encryption_key: nil, tags: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @fields = fields
  Jsii::Type.check_type(@fields, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5Eb21haW5PYmplY3RUeXBlLkRvbWFpbk9iamVjdFR5cGVGaWVsZFByb3BlcnR5In1dfX0sImtpbmQiOiJtYXAifX1dfX0=")), "fields")
  @object_type_name = object_type_name
  Jsii::Type.check_type(@object_type_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectTypeName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @encryption_key = encryption_key
  Jsii::Type.check_type(@encryption_key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKey") unless @encryption_key.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?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Description of the domain object type.

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 49

def description
  @description
end

#domain_name ⇒ String (readonly)

The unique name of the domain.

Returns:

  • (String)

See Also:



34
35
36
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 34

def domain_name
  @domain_name
end

#encryption_key ⇒ String? (readonly)

The default encryption key.

Returns:

  • (String, nil)

See Also:



54
55
56
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 54

def encryption_key
  @encryption_key
end

#fields ⇒ AWSCDK::IResolvable, Hash{String => AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnDomainObjectType::DomainObjectTypeFieldProperty} (readonly)

A map of the name and ObjectType field.

Returns:

See Also:



39
40
41
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 39

def fields
  @fields
end

#object_type_name ⇒ String (readonly)

The name of the domain object type.

Returns:

  • (String)

See Also:



44
45
46
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 44

def object_type_name
  @object_type_name
end

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

An array of key-value pairs to apply to this resource.

Returns:

See Also:



59
60
61
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 59

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 61

def self.jsii_properties
  {
    :domain_name => "domainName",
    :fields => "fields",
    :object_type_name => "objectTypeName",
    :description => "description",
    :encryption_key => "encryptionKey",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'customer_profiles/cfn_domain_object_type_props.rb', line 72

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "fields" => @fields,
    "objectTypeName" => @object_type_name,
    "description" => @description,
    "encryptionKey" => @encryption_key,
    "tags" => @tags,
  })
  result.compact
end