Class: AWSCDK::CustomerProfiles::CfnObjectType

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSCustomerprofiles::IObjectTypeRef
Defined in:
customer_profiles/cfn_object_type.rb

Overview

Specifies an Amazon Connect Customer Profiles Object Type Mapping.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnObjectType

Create a new AWS::CustomerProfiles::ObjectType.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::CustomerProfiles::CfnObjectTypeProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'customer_profiles/cfn_object_type.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnObjectTypeProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5PYmplY3RUeXBlUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


186
187
188
 
# File 'customer_profiles/cfn_object_type.rb', line 186

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_customerprofiles.CfnObjectType", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_object_type(x) ⇒ Boolean

Checks whether the given object is a CfnObjectType.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


88
89
90
91
 
# File 'customer_profiles/cfn_object_type.rb', line 88

def self.is_cfn_object_type(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_customerprofiles.CfnObjectType", "isCfnObjectType", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'customer_profiles/cfn_object_type.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_last_updated_at => { kind: :property, name: "attrLastUpdatedAt", is_optional: false },
    :attr_max_available_profile_object_count => { kind: :property, name: "attrMaxAvailableProfileObjectCount", is_optional: false },
    :object_type_ref => { kind: :property, name: "objectTypeRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :object_type_name => { kind: :property, name: "objectTypeName", is_optional: false },
    :allow_profile_creation => { kind: :property, name: "allowProfileCreation", is_optional: true },
    :encryption_key => { kind: :property, name: "encryptionKey", is_optional: true },
    :expiration_days => { kind: :property, name: "expirationDays", is_optional: true },
    :fields => { kind: :property, name: "fields", is_optional: true },
    :keys => { kind: :property, name: "keys", is_optional: true },
    :max_profile_object_count => { kind: :property, name: "maxProfileObjectCount", is_optional: true },
    :source_last_updated_timestamp_format => { kind: :property, name: "sourceLastUpdatedTimestampFormat", is_optional: true },
    :source_priority => { kind: :property, name: "sourcePriority", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :template_id => { kind: :property, name: "templateId", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



418
419
420
421
 
# File 'customer_profiles/cfn_object_type.rb', line 418

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



430
431
432
433
 
# File 'customer_profiles/cfn_object_type.rb', line 430

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



440
441
442
443
 
# File 'customer_profiles/cfn_object_type.rb', line 440

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



451
452
453
454
455
 
# File 'customer_profiles/cfn_object_type.rb', line 451

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


508
509
510
511
512
 
# File 'customer_profiles/cfn_object_type.rb', line 508

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



518
519
520
521
 
# File 'customer_profiles/cfn_object_type.rb', line 518

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



530
531
532
533
534
 
# File 'customer_profiles/cfn_object_type.rb', line 530

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#allow_profile_creation ⇒ Boolean, ...

Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.

Returns:



264
265
266
 
# File 'customer_profiles/cfn_object_type.rb', line 264

def allow_profile_creation()
  jsii_get_property("allowProfileCreation")
end

#allow_profile_creation=(value) ⇒ Object 



268
269
270
271
 
# File 'customer_profiles/cfn_object_type.rb', line 268

def allow_profile_creation=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "allowProfileCreation") unless value.nil?
  jsii_set_property("allowProfileCreation", value)
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



543
544
545
546
 
# File 'customer_profiles/cfn_object_type.rb', line 543

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



565
566
567
568
569
570
 
# File 'customer_profiles/cfn_object_type.rb', line 565

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_at ⇒ String

The timestamp of when the object type was created.

Returns:

  • (String) 


193
194
195
 
# File 'customer_profiles/cfn_object_type.rb', line 193

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_last_updated_at ⇒ String

The timestamp of when the object type was most recently edited.

Returns:

  • (String) 


200
201
202
 
# File 'customer_profiles/cfn_object_type.rb', line 200

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_max_available_profile_object_count ⇒ Numeric

The amount of provisioned profile object max count available.

Returns:

  • (Numeric) 


207
208
209
 
# File 'customer_profiles/cfn_object_type.rb', line 207

def attr_max_available_profile_object_count()
  jsii_get_property("attrMaxAvailableProfileObjectCount")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



139
140
141
 
# File 'customer_profiles/cfn_object_type.rb', line 139

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


144
145
146
 
# File 'customer_profiles/cfn_object_type.rb', line 144

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


574
575
576
577
 
# File 'customer_profiles/cfn_object_type.rb', line 574

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


149
150
151
 
# File 'customer_profiles/cfn_object_type.rb', line 149

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


156
157
158
 
# File 'customer_profiles/cfn_object_type.rb', line 156

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


101
102
103
 
# File 'customer_profiles/cfn_object_type.rb', line 101

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String

The description of the profile object type mapping.

Returns:

  • (String) 


228
229
230
 
# File 'customer_profiles/cfn_object_type.rb', line 228

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



232
233
234
235
 
# File 'customer_profiles/cfn_object_type.rb', line 232

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description")
  jsii_set_property("description", value)
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


240
241
242
 
# File 'customer_profiles/cfn_object_type.rb', line 240

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



244
245
246
247
 
# File 'customer_profiles/cfn_object_type.rb', line 244

def domain_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "domainName")
  jsii_set_property("domainName", value)
end

#encryption_key ⇒ String?

The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.

Returns:

  • (String, nil) 


276
277
278
 
# File 'customer_profiles/cfn_object_type.rb', line 276

def encryption_key()
  jsii_get_property("encryptionKey")
end

#encryption_key=(value) ⇒ Object 



280
281
282
283
 
# File 'customer_profiles/cfn_object_type.rb', line 280

def encryption_key=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKey") unless value.nil?
  jsii_set_property("encryptionKey", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



161
162
163
 
# File 'customer_profiles/cfn_object_type.rb', line 161

def env()
  jsii_get_property("env")
end

#expiration_days ⇒ Numeric?

The number of days until the data of this type expires.

Returns:

  • (Numeric, nil) 


288
289
290
 
# File 'customer_profiles/cfn_object_type.rb', line 288

def expiration_days()
  jsii_get_property("expirationDays")
end

#expiration_days=(value) ⇒ Object 



292
293
294
295
 
# File 'customer_profiles/cfn_object_type.rb', line 292

def expiration_days=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "expirationDays") unless value.nil?
  jsii_set_property("expirationDays", value)
end

#fields ⇒ AWSCDK::IResolvable, ...

A list of field definitions for the object type mapping.

Returns:



300
301
302
 
# File 'customer_profiles/cfn_object_type.rb', line 300

def fields()
  jsii_get_property("fields")
end

#fields=(value) ⇒ Object 



304
305
306
307
 
# File 'customer_profiles/cfn_object_type.rb', line 304

def fields=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5PYmplY3RUeXBlLkZpZWxkTWFwUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "fields") unless value.nil?
  jsii_set_property("fields", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



587
588
589
590
591
 
# File 'customer_profiles/cfn_object_type.rb', line 587

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



598
599
600
601
 
# File 'customer_profiles/cfn_object_type.rb', line 598

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



668
669
670
671
 
# File 'customer_profiles/cfn_object_type.rb', line 668

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#keys ⇒ AWSCDK::IResolvable, ...

A list of keys that can be used to map data to the profile or search for the profile.

Returns:



312
313
314
 
# File 'customer_profiles/cfn_object_type.rb', line 312

def keys()
  jsii_get_property("keys")
end

#keys=(value) ⇒ Object 



316
317
318
319
 
# File 'customer_profiles/cfn_object_type.rb', line 316

def keys=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5PYmplY3RUeXBlLktleU1hcFByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "keys") unless value.nil?
  jsii_set_property("keys", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


113
114
115
 
# File 'customer_profiles/cfn_object_type.rb', line 113

def logical_id()
  jsii_get_property("logicalId")
end

#max_profile_object_count ⇒ Numeric?

The amount of profile object max count assigned to the object type.

Returns:

  • (Numeric, nil) 


324
325
326
 
# File 'customer_profiles/cfn_object_type.rb', line 324

def max_profile_object_count()
  jsii_get_property("maxProfileObjectCount")
end

#max_profile_object_count=(value) ⇒ Object 



328
329
330
331
 
# File 'customer_profiles/cfn_object_type.rb', line 328

def max_profile_object_count=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxProfileObjectCount") unless value.nil?
  jsii_set_property("maxProfileObjectCount", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


96
97
98
 
# File 'customer_profiles/cfn_object_type.rb', line 96

def node()
  jsii_get_property("node")
end

#object_type_name ⇒ String

The name of the profile object type.

Returns:

  • (String) 


252
253
254
 
# File 'customer_profiles/cfn_object_type.rb', line 252

def object_type_name()
  jsii_get_property("objectTypeName")
end

#object_type_name=(value) ⇒ Object 



256
257
258
259
 
# File 'customer_profiles/cfn_object_type.rb', line 256

def object_type_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "objectTypeName")
  jsii_set_property("objectTypeName", value)
end

#object_type_ref ⇒ AWSCDK::Interfaces::AWSCustomerprofiles::ObjectTypeReference

A reference to a ObjectType resource.

Returns:



214
215
216
 
# File 'customer_profiles/cfn_object_type.rb', line 214

def object_type_ref()
  jsii_get_property("objectTypeRef")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



609
610
611
 
# File 'customer_profiles/cfn_object_type.rb', line 609

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



616
617
618
 
# File 'customer_profiles/cfn_object_type.rb', line 616

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



409
410
411
412
 
# File 'customer_profiles/cfn_object_type.rb', line 409

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


132
133
134
 
# File 'customer_profiles/cfn_object_type.rb', line 132

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



627
628
629
630
 
# File 'customer_profiles/cfn_object_type.rb', line 627

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


634
635
636
637
 
# File 'customer_profiles/cfn_object_type.rb', line 634

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



644
645
646
647
648
 
# File 'customer_profiles/cfn_object_type.rb', line 644

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



653
654
655
 
# File 'customer_profiles/cfn_object_type.rb', line 653

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#source_last_updated_timestamp_format ⇒ String?

The format of your sourceLastUpdatedTimestamp that was previously set up.

Returns:

  • (String, nil) 


336
337
338
 
# File 'customer_profiles/cfn_object_type.rb', line 336

def source_last_updated_timestamp_format()
  jsii_get_property("sourceLastUpdatedTimestampFormat")
end

#source_last_updated_timestamp_format=(value) ⇒ Object 



340
341
342
343
 
# File 'customer_profiles/cfn_object_type.rb', line 340

def source_last_updated_timestamp_format=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceLastUpdatedTimestampFormat") unless value.nil?
  jsii_set_property("sourceLastUpdatedTimestampFormat", value)
end

#source_priority ⇒ Numeric?

Defines the priority order of object types.

Returns:

  • (Numeric, nil) 


348
349
350
 
# File 'customer_profiles/cfn_object_type.rb', line 348

def source_priority()
  jsii_get_property("sourcePriority")
end

#source_priority=(value) ⇒ Object 



352
353
354
355
 
# File 'customer_profiles/cfn_object_type.rb', line 352

def source_priority=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sourcePriority") unless value.nil?
  jsii_set_property("sourcePriority", value)
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



122
123
124
 
# File 'customer_profiles/cfn_object_type.rb', line 122

def stack()
  jsii_get_property("stack")
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



221
222
223
 
# File 'customer_profiles/cfn_object_type.rb', line 221

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



360
361
362
 
# File 'customer_profiles/cfn_object_type.rb', line 360

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



364
365
366
367
368
 
# File 'customer_profiles/cfn_object_type.rb', line 364

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#template_id ⇒ String?

A unique identifier for the template mapping.

Returns:

  • (String, nil) 


373
374
375
 
# File 'customer_profiles/cfn_object_type.rb', line 373

def template_id()
  jsii_get_property("templateId")
end

#template_id=(value) ⇒ Object 



377
378
379
380
 
# File 'customer_profiles/cfn_object_type.rb', line 377

def template_id=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "templateId") unless value.nil?
  jsii_set_property("templateId", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



385
386
387
 
# File 'customer_profiles/cfn_object_type.rb', line 385

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


169
170
171
 
# File 'customer_profiles/cfn_object_type.rb', line 169

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


179
180
181
 
# File 'customer_profiles/cfn_object_type.rb', line 179

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


659
660
661
662
 
# File 'customer_profiles/cfn_object_type.rb', line 659

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


398
399
400
401
402
403
 
# File 'customer_profiles/cfn_object_type.rb', line 398

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end