Class CfnCalculatedAttributeDefinition
A calculated attribute definition for Customer Profiles.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCalculatedAttributeDefinition : CfnResource, IInspectable, ICalculatedAttributeDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Syntax (vb)
Public Class CfnCalculatedAttributeDefinition Inherits CfnResource Implements IInspectable, ICalculatedAttributeDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CustomerProfiles;
var cfnCalculatedAttributeDefinition = new CfnCalculatedAttributeDefinition(this, "MyCfnCalculatedAttributeDefinition", new CfnCalculatedAttributeDefinitionProps {
AttributeDetails = new AttributeDetailsProperty {
Attributes = new [] { new AttributeItemProperty {
Name = "name"
} },
Expression = "expression"
},
CalculatedAttributeName = "calculatedAttributeName",
DomainName = "domainName",
Statistic = "statistic",
// the properties below are optional
Conditions = new ConditionsProperty {
ObjectCount = 123,
Range = new RangeProperty {
Unit = "unit",
// the properties below are optional
TimestampFormat = "timestampFormat",
TimestampSource = "timestampSource",
Value = 123,
ValueRange = new ValueRangeProperty {
End = 123,
Start = 123
}
},
Threshold = new ThresholdProperty {
Operator = "operator",
Value = "value"
}
},
Description = "description",
DisplayName = "displayName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UseHistoricalData = false
});Synopsis
Constructors
| CfnCalculatedAttributeDefinition(Construct, string, ICfnCalculatedAttributeDefinitionProps) | Create a new |
Properties
| AttrCreatedAt | The timestamp of when the calculated attribute definition was created. |
| AttrLastUpdatedAt | The timestamp of when the calculated attribute definition was most recently edited. |
| AttrReadiness | The readiness status of the calculated attribute. |
| AttrStatus | Status of the Calculated Attribute creation (whether all historical data has been indexed.). |
| AttributeDetails | Mathematical expression and a list of attribute items specified in that expression. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CalculatedAttributeDefinitionRef | A reference to a CalculatedAttributeDefinition resource. |
| CalculatedAttributeName | The name of an attribute defined in a profile object type. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CfnProperties | A calculated attribute definition for Customer Profiles. |
| CfnPropertyNames | A calculated attribute definition for Customer Profiles. |
| Conditions | The conditions including range, object count, and threshold for the calculated attribute. |
| Description | The description of the calculated attribute. |
| DisplayName | The display name of the calculated attribute. |
| DomainName | The unique name of the domain. |
| Statistic | The aggregation operation to perform for the calculated attribute. |
| Tags | An array of key-value pairs to apply to this resource. |
| UseHistoricalData | Whether historical data ingested before the Calculated Attribute was created should be included in calculations. |
Methods
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnCalculatedAttributeDefinition(object) | Checks whether the given object is a CfnCalculatedAttributeDefinition. |
| RenderProperties(IDictionary<string, object>) | A calculated attribute definition for Customer Profiles. |
Constructors
CfnCalculatedAttributeDefinition(Construct, string, ICfnCalculatedAttributeDefinitionProps)
Create a new AWS::CustomerProfiles::CalculatedAttributeDefinition.
public CfnCalculatedAttributeDefinition(Construct scope, string id, ICfnCalculatedAttributeDefinitionProps props)Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnCalculatedAttributeDefinitionProps
Resource properties.
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
Properties
AttrCreatedAt
The timestamp of when the calculated attribute definition was created.
public virtual string AttrCreatedAt { get; }Property Value
Remarks
CloudformationAttribute: CreatedAt
AttrLastUpdatedAt
The timestamp of when the calculated attribute definition was most recently edited.
public virtual string AttrLastUpdatedAt { get; }Property Value
Remarks
CloudformationAttribute: LastUpdatedAt
AttrReadiness
The readiness status of the calculated attribute.
public virtual IResolvable AttrReadiness { get; }Property Value
Remarks
CloudformationAttribute: Readiness
AttrStatus
Status of the Calculated Attribute creation (whether all historical data has been indexed.).
public virtual string AttrStatus { get; }Property Value
Remarks
CloudformationAttribute: Status
AttributeDetails
Mathematical expression and a list of attribute items specified in that expression.
public virtual object AttributeDetails { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnCalculatedAttributeDefinition.IAttributeDetailsProperty
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
CalculatedAttributeDefinitionRef
A reference to a CalculatedAttributeDefinition resource.
public virtual ICalculatedAttributeDefinitionReference CalculatedAttributeDefinitionRef { get; }Property Value
ICalculatedAttributeDefinitionReference
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
CalculatedAttributeName
The name of an attribute defined in a profile object type.
public virtual string CalculatedAttributeName { get; set; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
CfnProperties
A calculated attribute definition for Customer Profiles.
protected override IDictionary<string, object> CfnProperties { get; }Property Value
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
CfnPropertyNames
A calculated attribute definition for Customer Profiles.
protected override IDictionary<string, string> CfnPropertyNames { get; }Property Value
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
Conditions
The conditions including range, object count, and threshold for the calculated attribute.
public virtual object? Conditions { get; set; }Property Value
Remarks
Type union: either IResolvable or CfnCalculatedAttributeDefinition.IConditionsProperty
Description
The description of the calculated attribute.
public virtual string? Description { get; set; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
DisplayName
The display name of the calculated attribute.
public virtual string? DisplayName { get; set; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
DomainName
The unique name of the domain.
public virtual string DomainName { get; set; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
Statistic
The aggregation operation to perform for the calculated attribute.
public virtual string Statistic { get; set; }Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
Tags
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[]? Tags { get; set; }Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
UseHistoricalData
Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
public virtual object? UseHistoricalData { get; set; }Property Value
Remarks
Type union: either bool or IResolvable
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
IsCfnCalculatedAttributeDefinition(object)
Checks whether the given object is a CfnCalculatedAttributeDefinition.
public static bool IsCfnCalculatedAttributeDefinition(object x)Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
A calculated attribute definition for Customer Profiles.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::CalculatedAttributeDefinition
ExampleMetadata: fixture=_generated