Class: AWSCDK::CustomerProfiles::CfnObjectType::ObjectTypeKeyProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::CustomerProfiles::CfnObjectType::ObjectTypeKeyProperty

Defined in:

customer_profiles/cfn_object_type.rb

Overview

An object that defines the Key element of a ProfileObject.

A Key is a special element that can be used to search for a customer profile.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html

Instance Attribute Summary

• #field_names ⇒ Array<String>^? readonly

  The reference for the key name of the fields map.

• #standard_identifiers ⇒ Array<String>^? readonly

  The types of keys that a ProfileObject can have.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(field_names: nil, standard_identifiers: nil) ⇒ ObjectTypeKeyProperty constructor

  A new instance of ObjectTypeKeyProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(field_names: nil, standard_identifiers: nil) ⇒ ObjectTypeKeyProperty

Returns a new instance of ObjectTypeKeyProperty.

Parameters:

• field_names (Array<String>, nil) (defaults to: nil) —

  The reference for the key name of the fields map.

• standard_identifiers (Array<String>, nil) (defaults to: nil) —

  The types of keys that a ProfileObject can have.

# File 'customer_profiles/cfn_object_type.rb', line 830

def initialize(field_names: nil, standard_identifiers: nil)
  @field_names = field_names
  Jsii::Type.check_type(@field_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "fieldNames") unless @field_names.nil?
  @standard_identifiers = standard_identifiers
  Jsii::Type.check_type(@standard_identifiers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "standardIdentifiers") unless @standard_identifiers.nil?
end

Instance Attribute Details

#field_names ⇒ Array<String>^? (readonly)

The reference for the key name of the fields map.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-fieldnames

# File 'customer_profiles/cfn_object_type.rb', line 841

def field_names
  @field_names
end

#standard_identifiers ⇒ Array<String>^? (readonly)

The types of keys that a ProfileObject can have.

Each ProfileObject can have only 1 UNIQUE key but multiple PROFILE keys. PROFILE means that this key can be used to tie an object to a PROFILE. UNIQUE means that it can be used to uniquely identify an object. If a key a is marked as SECONDARY, it will be used to search for profiles after all other PROFILE keys have been searched. A LOOKUP_ONLY key is only used to match a profile but is not persisted to be used for searching of the profile. A NEW_ONLY key is only used if the profile does not already exist before the object is ingested, otherwise it is only used for matching objects to profiles.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers

# File 'customer_profiles/cfn_object_type.rb', line 848

def standard_identifiers
  @standard_identifiers
end

Class Method Details

.jsii_properties ⇒ Object

# File 'customer_profiles/cfn_object_type.rb', line 850

def self.jsii_properties
  {
    :field_names => "fieldNames",
    :standard_identifiers => "standardIdentifiers",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'customer_profiles/cfn_object_type.rb', line 857

def to_jsii
  result = {}
  result.merge!({
    "fieldNames" => @field_names,
    "standardIdentifiers" => @standard_identifiers,
  })
  result.compact
end