Class: AWSCDK::CustomerProfiles::CfnIntegrationProps

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

Overview

Properties for defining a CfnIntegration.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(domain_name:, event_trigger_names: nil, flow_definition: nil, object_type_name: nil, object_type_names: nil, scope: nil, tags: nil, uri: nil) ⇒ CfnIntegrationProps

Returns a new instance of CfnIntegrationProps.

Parameters:

  • domain_name (String) —

    The unique name of the domain.

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

    A list of unique names for active event triggers associated with the integration.

  • flow_definition (AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::FlowDefinitionProperty, nil) (defaults to: nil) —

    The configuration that controls how Customer Profiles retrieves data from the source.

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

    The name of the profile object type mapping to use.

  • object_type_names (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnIntegration::ObjectTypeMappingProperty>, nil) (defaults to: nil) —

    The object type mapping.

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

    Scope of the integration, such as 'PROFILE' or 'DOMAIN'.

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

    The tags used to organize, track, or control access for this resource.

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

    The URI of the S3 bucket or any other type of data source.



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'customer_profiles/cfn_integration_props.rb', line 17

def initialize(domain_name:, event_trigger_names: nil, flow_definition: nil, object_type_name: nil, object_type_names: nil, scope: nil, tags: nil, uri: nil)
  @domain_name = domain_name
  Jsii::Type.check_type(@domain_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  @event_trigger_names = event_trigger_names
  Jsii::Type.check_type(@event_trigger_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "eventTriggerNames") unless @event_trigger_names.nil?
  @flow_definition = flow_definition.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnIntegration::FlowDefinitionProperty.new(**flow_definition.transform_keys(&:to_sym)) : flow_definition
  Jsii::Type.check_type(@flow_definition, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkludGVncmF0aW9uLkZsb3dEZWZpbml0aW9uUHJvcGVydHkifV19fQ==")), "flowDefinition") unless @flow_definition.nil?
  @object_type_name = object_type_name
  Jsii::Type.check_type(@object_type_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectTypeName") unless @object_type_name.nil?
  @object_type_names = object_type_names
  Jsii::Type.check_type(@object_type_names, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5JbnRlZ3JhdGlvbi5PYmplY3RUeXBlTWFwcGluZ1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "objectTypeNames") unless @object_type_names.nil?
  @scope = scope
  Jsii::Type.check_type(@scope, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "scope") unless @scope.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?
  @uri = uri
  Jsii::Type.check_type(@uri, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "uri") unless @uri.nil?
end

Instance Attribute Details

#domain_name ⇒ String (readonly)

The unique name of the domain.

Returns:

  • (String)

See Also:



40
41
42
 
# File 'customer_profiles/cfn_integration_props.rb', line 40

def domain_name
  @domain_name
end

#event_trigger_names ⇒ Array<String>? (readonly)

A list of unique names for active event triggers associated with the integration.

Returns:

  • (Array<String>, nil)

See Also:



45
46
47
 
# File 'customer_profiles/cfn_integration_props.rb', line 45

def event_trigger_names
  @event_trigger_names
end

#flow_definition ⇒ AWSCDK::IResolvable, ... (readonly)

The configuration that controls how Customer Profiles retrieves data from the source.

Returns:

See Also:



50
51
52
 
# File 'customer_profiles/cfn_integration_props.rb', line 50

def flow_definition
  @flow_definition
end

#object_type_name ⇒ String? (readonly)

The name of the profile object type mapping to use.

Returns:

  • (String, nil)

See Also:



55
56
57
 
# File 'customer_profiles/cfn_integration_props.rb', line 55

def object_type_name
  @object_type_name
end

#object_type_names ⇒ AWSCDK::IResolvable, ... (readonly)

The object type mapping.

Returns:

See Also:



60
61
62
 
# File 'customer_profiles/cfn_integration_props.rb', line 60

def object_type_names
  @object_type_names
end

#scope ⇒ String? (readonly)

Scope of the integration, such as 'PROFILE' or 'DOMAIN'.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'customer_profiles/cfn_integration_props.rb', line 65

def scope
  @scope
end

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

The tags used to organize, track, or control access for this resource.

Returns:

See Also:



70
71
72
 
# File 'customer_profiles/cfn_integration_props.rb', line 70

def tags
  @tags
end

#uri ⇒ String? (readonly)

The URI of the S3 bucket or any other type of data source.

Returns:

  • (String, nil)

See Also:



75
76
77
 
# File 'customer_profiles/cfn_integration_props.rb', line 75

def uri
  @uri
end

Class Method Details

.jsii_properties ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'customer_profiles/cfn_integration_props.rb', line 77

def self.jsii_properties
  {
    :domain_name => "domainName",
    :event_trigger_names => "eventTriggerNames",
    :flow_definition => "flowDefinition",
    :object_type_name => "objectTypeName",
    :object_type_names => "objectTypeNames",
    :scope => "scope",
    :tags => "tags",
    :uri => "uri",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'customer_profiles/cfn_integration_props.rb', line 90

def to_jsii
  result = {}
  result.merge!({
    "domainName" => @domain_name,
    "eventTriggerNames" => @event_trigger_names,
    "flowDefinition" => @flow_definition,
    "objectTypeName" => @object_type_name,
    "objectTypeNames" => @object_type_names,
    "scope" => @scope,
    "tags" => @tags,
    "uri" => @uri,
  })
  result.compact
end