Class: AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCustomerprofiles::ICalculatedAttributeDefinitionRef
Defined in:
customer_profiles/cfn_calculated_attribute_definition.rb

Overview

A calculated attribute definition for Customer Profiles.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnCalculatedAttributeDefinition

Create a new AWS::CustomerProfiles::CalculatedAttributeDefinition.

Parameters:



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

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinitionProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY3VzdG9tZXJwcm9maWxlcy5DZm5DYWxjdWxhdGVkQXR0cmlidXRlRGVmaW5pdGlvblByb3BzIn0=")), "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) 


183
184
185
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 183

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

.is_cfn_calculated_attribute_definition(x) ⇒ Boolean

Checks whether the given object is a CfnCalculatedAttributeDefinition.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


85
86
87
88
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 85

def self.is_cfn_calculated_attribute_definition(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_customerprofiles.CfnCalculatedAttributeDefinition", "isCfnCalculatedAttributeDefinition", [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
 
# File 'customer_profiles/cfn_calculated_attribute_definition.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_readiness => { kind: :property, name: "attrReadiness", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :calculated_attribute_definition_ref => { kind: :property, name: "calculatedAttributeDefinitionRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :attribute_details => { kind: :property, name: "attributeDetails", is_optional: false },
    :calculated_attribute_name => { kind: :property, name: "calculatedAttributeName", is_optional: false },
    :domain_name => { kind: :property, name: "domainName", is_optional: false },
    :statistic => { kind: :property, name: "statistic", is_optional: false },
    :conditions => { kind: :property, name: "conditions", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :use_historical_data => { kind: :property, name: "useHistoricalData", 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.



376
377
378
379
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 376

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:



388
389
390
391
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 388

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:



398
399
400
401
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 398

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:



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

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.


466
467
468
469
470
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 466

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.



476
477
478
479
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 476

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.



488
489
490
491
492
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 488

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

#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:



501
502
503
504
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 501

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:



523
524
525
526
527
528
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 523

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 calculated attribute definition was created.

Returns:

  • (String) 


190
191
192
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 190

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_last_updated_at ⇒ String

The timestamp of when the calculated attribute definition was most recently edited.

Returns:

  • (String) 


197
198
199
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 197

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_readiness ⇒ AWSCDK::IResolvable

The readiness status of the calculated attribute.

Returns:



204
205
206
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 204

def attr_readiness()
  jsii_get_property("attrReadiness")
end

#attr_status ⇒ String

Status of the Calculated Attribute creation (whether all historical data has been indexed.).

Returns:

  • (String) 


211
212
213
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 211

def attr_status()
  jsii_get_property("attrStatus")
end

#attribute_details ⇒ AWSCDK::IResolvable, AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::AttributeDetailsProperty

Mathematical expression and a list of attribute items specified in that expression.

Returns:



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

def attribute_details()
  jsii_get_property("attributeDetails")
end

#attribute_details=(value) ⇒ Object 



236
237
238
239
240
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 236

def attribute_details=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::AttributeDetailsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkNhbGN1bGF0ZWRBdHRyaWJ1dGVEZWZpbml0aW9uLkF0dHJpYnV0ZURldGFpbHNQcm9wZXJ0eSJ9XX19")), "attributeDetails")
  jsii_set_property("attributeDetails", value)
end

#calculated_attribute_definition_ref ⇒ AWSCDK::Interfaces::AWSCustomerprofiles::CalculatedAttributeDefinitionReference

A reference to a CalculatedAttributeDefinition resource.

Returns:



218
219
220
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 218

def calculated_attribute_definition_ref()
  jsii_get_property("calculatedAttributeDefinitionRef")
end

#calculated_attribute_name ⇒ String

The name of an attribute defined in a profile object type.

Returns:

  • (String) 


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

def calculated_attribute_name()
  jsii_get_property("calculatedAttributeName")
end

#calculated_attribute_name=(value) ⇒ Object 



249
250
251
252
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 249

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



225
226
227
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 225

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



136
137
138
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 136

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


141
142
143
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 141

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


532
533
534
535
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 532

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}) 


146
147
148
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 146

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


153
154
155
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 153

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#conditions ⇒ AWSCDK::IResolvable, ...

The conditions including range, object count, and threshold for the calculated attribute.

Returns:



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

def conditions()
  jsii_get_property("conditions")
end

#conditions=(value) ⇒ Object 



285
286
287
288
289
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 285

def conditions=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CustomerProfiles::CfnCalculatedAttributeDefinition::ConditionsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jdXN0b21lcnByb2ZpbGVzLkNmbkNhbGN1bGF0ZWRBdHRyaWJ1dGVEZWZpbml0aW9uLkNvbmRpdGlvbnNQcm9wZXJ0eSJ9XX19")), "conditions") unless value.nil?
  jsii_set_property("conditions", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


98
99
100
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 98

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description of the calculated attribute.

Returns:

  • (String, nil) 


294
295
296
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 294

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



298
299
300
301
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 298

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

#display_name ⇒ String?

The display name of the calculated attribute.

Returns:

  • (String, nil) 


306
307
308
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 306

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



310
311
312
313
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 310

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

#domain_name ⇒ String

The unique name of the domain.

Returns:

  • (String) 


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

def domain_name()
  jsii_get_property("domainName")
end

#domain_name=(value) ⇒ Object 



261
262
263
264
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 261

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



158
159
160
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 158

def env()
  jsii_get_property("env")
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:



545
546
547
548
549
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 545

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:



556
557
558
559
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 556

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:



626
627
628
629
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 626

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


110
111
112
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 110

def logical_id()
  jsii_get_property("logicalId")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


93
94
95
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 93

def node()
  jsii_get_property("node")
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:



567
568
569
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 567

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:



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

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.



367
368
369
370
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 367

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) 


129
130
131
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 129

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:



585
586
587
588
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 585

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}) 


592
593
594
595
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 592

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:



602
603
604
605
606
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 602

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.



611
612
613
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 611

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



119
120
121
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 119

def stack()
  jsii_get_property("stack")
end

#statistic ⇒ String

The aggregation operation to perform for the calculated attribute.

Returns:

  • (String) 


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

def statistic()
  jsii_get_property("statistic")
end

#statistic=(value) ⇒ Object 



273
274
275
276
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 273

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

#tags ⇒ Array<AWSCDK::CfnTag>?

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

Returns:



318
319
320
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 318

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



322
323
324
325
326
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 322

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



343
344
345
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 343

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}) 


166
167
168
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 166

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}) 


176
177
178
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 176

def updated_properties()
  jsii_get_property("updatedProperties")
end

#use_historical_data ⇒ Boolean, ...

Whether historical data ingested before the Calculated Attribute was created should be included in calculations.

Returns:



331
332
333
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 331

def use_historical_data()
  jsii_get_property("useHistoricalData")
end

#use_historical_data=(value) ⇒ Object 



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

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

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


617
618
619
620
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 617

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) 


356
357
358
359
360
361
 
# File 'customer_profiles/cfn_calculated_attribute_definition.rb', line 356

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