Documentation
¶
Index ¶
- func CfnCalculatedAttributeDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCalculatedAttributeDefinition_IsCfnCalculatedAttributeDefinition(x interface{}) *bool
- func CfnCalculatedAttributeDefinition_IsCfnElement(x interface{}) *bool
- func CfnCalculatedAttributeDefinition_IsCfnResource(x interface{}) *bool
- func CfnCalculatedAttributeDefinition_IsConstruct(x interface{}) *bool
- func CfnDomain_ArnForDomain(resource interfacesawscustomerprofiles.IDomainRef) *string
- func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDomain_FromDomainName(scope constructs.Construct, id *string, domainName *string) interfacesawscustomerprofiles.IDomainRef
- func CfnDomain_IsCfnDomain(x interface{}) *bool
- func CfnDomain_IsCfnElement(x interface{}) *bool
- func CfnDomain_IsCfnResource(x interface{}) *bool
- func CfnDomain_IsConstruct(x interface{}) *bool
- func CfnEventStream_ArnForEventStream(resource interfacesawscustomerprofiles.IEventStreamRef) *string
- func CfnEventStream_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventStream_IsCfnElement(x interface{}) *bool
- func CfnEventStream_IsCfnEventStream(x interface{}) *bool
- func CfnEventStream_IsCfnResource(x interface{}) *bool
- func CfnEventStream_IsConstruct(x interface{}) *bool
- func CfnEventTrigger_CFN_RESOURCE_TYPE_NAME() *string
- func CfnEventTrigger_IsCfnElement(x interface{}) *bool
- func CfnEventTrigger_IsCfnEventTrigger(x interface{}) *bool
- func CfnEventTrigger_IsCfnResource(x interface{}) *bool
- func CfnEventTrigger_IsConstruct(x interface{}) *bool
- func CfnIntegration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnIntegration_IsCfnElement(x interface{}) *bool
- func CfnIntegration_IsCfnIntegration(x interface{}) *bool
- func CfnIntegration_IsCfnResource(x interface{}) *bool
- func CfnIntegration_IsConstruct(x interface{}) *bool
- func CfnObjectType_CFN_RESOURCE_TYPE_NAME() *string
- func CfnObjectType_IsCfnElement(x interface{}) *bool
- func CfnObjectType_IsCfnObjectType(x interface{}) *bool
- func CfnObjectType_IsCfnResource(x interface{}) *bool
- func CfnObjectType_IsConstruct(x interface{}) *bool
- func CfnRecommender_ArnForRecommender(resource interfacesawscustomerprofiles.IRecommenderRef) *string
- func CfnRecommender_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRecommender_IsCfnElement(x interface{}) *bool
- func CfnRecommender_IsCfnRecommender(x interface{}) *bool
- func CfnRecommender_IsCfnResource(x interface{}) *bool
- func CfnRecommender_IsConstruct(x interface{}) *bool
- func CfnSegmentDefinition_ArnForSegmentDefinition(resource interfacesawscustomerprofiles.ISegmentDefinitionRef) *string
- func CfnSegmentDefinition_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSegmentDefinition_IsCfnElement(x interface{}) *bool
- func CfnSegmentDefinition_IsCfnResource(x interface{}) *bool
- func CfnSegmentDefinition_IsCfnSegmentDefinition(x interface{}) *bool
- func CfnSegmentDefinition_IsConstruct(x interface{}) *bool
- func NewCfnCalculatedAttributeDefinition_Override(c CfnCalculatedAttributeDefinition, scope constructs.Construct, id *string, ...)
- func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
- func NewCfnEventStream_Override(c CfnEventStream, scope constructs.Construct, id *string, ...)
- func NewCfnEventTrigger_Override(c CfnEventTrigger, scope constructs.Construct, id *string, ...)
- func NewCfnIntegration_Override(c CfnIntegration, scope constructs.Construct, id *string, ...)
- func NewCfnObjectType_Override(c CfnObjectType, scope constructs.Construct, id *string, ...)
- func NewCfnRecommender_Override(c CfnRecommender, scope constructs.Construct, id *string, ...)
- func NewCfnSegmentDefinition_Override(c CfnSegmentDefinition, scope constructs.Construct, id *string, ...)
- type CfnCalculatedAttributeDefinition
- type CfnCalculatedAttributeDefinitionProps
- type CfnCalculatedAttributeDefinition_AttributeDetailsProperty
- type CfnCalculatedAttributeDefinition_AttributeItemProperty
- type CfnCalculatedAttributeDefinition_ConditionsProperty
- type CfnCalculatedAttributeDefinition_RangeProperty
- type CfnCalculatedAttributeDefinition_ReadinessProperty
- type CfnCalculatedAttributeDefinition_ThresholdProperty
- type CfnCalculatedAttributeDefinition_ValueRangeProperty
- type CfnDomain
- type CfnDomainProps
- type CfnDomain_AttributeTypesSelectorProperty
- type CfnDomain_AutoMergingProperty
- type CfnDomain_ConflictResolutionProperty
- type CfnDomain_ConsolidationProperty
- type CfnDomain_DataStoreProperty
- type CfnDomain_DomainStatsProperty
- type CfnDomain_ExportingConfigProperty
- type CfnDomain_JobScheduleProperty
- type CfnDomain_MatchingProperty
- type CfnDomain_MatchingRuleProperty
- type CfnDomain_ReadinessProperty
- type CfnDomain_RuleBasedMatchingProperty
- type CfnDomain_S3ExportingConfigProperty
- type CfnEventStream
- type CfnEventStreamProps
- type CfnEventStream_DestinationDetailsProperty
- type CfnEventTrigger
- type CfnEventTriggerProps
- type CfnEventTrigger_EventTriggerConditionProperty
- type CfnEventTrigger_EventTriggerDimensionProperty
- type CfnEventTrigger_EventTriggerLimitsProperty
- type CfnEventTrigger_ObjectAttributeProperty
- type CfnEventTrigger_PeriodProperty
- type CfnIntegration
- type CfnIntegrationProps
- type CfnIntegration_ConnectorOperatorProperty
- type CfnIntegration_FlowDefinitionProperty
- type CfnIntegration_IncrementalPullConfigProperty
- type CfnIntegration_MarketoSourcePropertiesProperty
- type CfnIntegration_ObjectTypeMappingProperty
- type CfnIntegration_S3SourcePropertiesProperty
- type CfnIntegration_SalesforceSourcePropertiesProperty
- type CfnIntegration_ScheduledTriggerPropertiesProperty
- type CfnIntegration_ServiceNowSourcePropertiesProperty
- type CfnIntegration_SourceConnectorPropertiesProperty
- type CfnIntegration_SourceFlowConfigProperty
- type CfnIntegration_TaskPropertiesMapProperty
- type CfnIntegration_TaskProperty
- type CfnIntegration_TriggerConfigProperty
- type CfnIntegration_TriggerPropertiesProperty
- type CfnIntegration_ZendeskSourcePropertiesProperty
- type CfnObjectType
- type CfnObjectTypeProps
- type CfnObjectType_FieldMapProperty
- type CfnObjectType_KeyMapProperty
- type CfnObjectType_ObjectTypeFieldProperty
- type CfnObjectType_ObjectTypeKeyProperty
- type CfnRecommender
- type CfnRecommenderProps
- type CfnRecommender_EventParametersProperty
- type CfnRecommender_EventsConfigProperty
- type CfnRecommender_MetricsProperty
- type CfnRecommender_RecommenderConfigProperty
- type CfnRecommender_RecommenderUpdateProperty
- type CfnRecommender_TrainingMetricsProperty
- type CfnSegmentDefinition
- type CfnSegmentDefinitionProps
- type CfnSegmentDefinition_AddressDimensionProperty
- type CfnSegmentDefinition_AttributeDimensionProperty
- type CfnSegmentDefinition_CalculatedAttributeDimensionProperty
- type CfnSegmentDefinition_ConditionOverridesProperty
- type CfnSegmentDefinition_DateDimensionProperty
- type CfnSegmentDefinition_DimensionProperty
- type CfnSegmentDefinition_ExtraLengthValueProfileDimensionProperty
- type CfnSegmentDefinition_GroupProperty
- type CfnSegmentDefinition_ProfileAttributesProperty
- type CfnSegmentDefinition_ProfileDimensionProperty
- type CfnSegmentDefinition_ProfileTypeDimensionProperty
- type CfnSegmentDefinition_RangeOverrideProperty
- type CfnSegmentDefinition_SegmentGroupProperty
- type CfnSegmentDefinition_SegmentSortProperty
- type CfnSegmentDefinition_SortAttributeProperty
- type CfnSegmentDefinition_SourceSegmentProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCalculatedAttributeDefinition_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnCalculatedAttributeDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnCalculatedAttributeDefinition_IsCfnCalculatedAttributeDefinition ¶ added in v2.231.0
func CfnCalculatedAttributeDefinition_IsCfnCalculatedAttributeDefinition(x interface{}) *bool
Checks whether the given object is a CfnCalculatedAttributeDefinition.
func CfnCalculatedAttributeDefinition_IsCfnElement ¶ added in v2.85.0
func CfnCalculatedAttributeDefinition_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCalculatedAttributeDefinition_IsCfnResource ¶ added in v2.85.0
func CfnCalculatedAttributeDefinition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCalculatedAttributeDefinition_IsConstruct ¶ added in v2.85.0
func CfnCalculatedAttributeDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDomain_ArnForDomain ¶ added in v2.227.0
func CfnDomain_ArnForDomain(resource interfacesawscustomerprofiles.IDomainRef) *string
func CfnDomain_CFN_RESOURCE_TYPE_NAME ¶
func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
func CfnDomain_FromDomainName ¶ added in v2.218.0
func CfnDomain_FromDomainName(scope constructs.Construct, id *string, domainName *string) interfacesawscustomerprofiles.IDomainRef
Creates a new IDomainRef from a domainName.
func CfnDomain_IsCfnDomain ¶ added in v2.231.0
func CfnDomain_IsCfnDomain(x interface{}) *bool
Checks whether the given object is a CfnDomain.
func CfnDomain_IsCfnElement ¶
func CfnDomain_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDomain_IsCfnResource ¶
func CfnDomain_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDomain_IsConstruct ¶
func CfnDomain_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEventStream_ArnForEventStream ¶ added in v2.227.0
func CfnEventStream_ArnForEventStream(resource interfacesawscustomerprofiles.IEventStreamRef) *string
func CfnEventStream_CFN_RESOURCE_TYPE_NAME ¶ added in v2.85.0
func CfnEventStream_CFN_RESOURCE_TYPE_NAME() *string
func CfnEventStream_IsCfnElement ¶ added in v2.85.0
func CfnEventStream_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEventStream_IsCfnEventStream ¶ added in v2.231.0
func CfnEventStream_IsCfnEventStream(x interface{}) *bool
Checks whether the given object is a CfnEventStream.
func CfnEventStream_IsCfnResource ¶ added in v2.85.0
func CfnEventStream_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEventStream_IsConstruct ¶ added in v2.85.0
func CfnEventStream_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnEventTrigger_CFN_RESOURCE_TYPE_NAME ¶ added in v2.176.0
func CfnEventTrigger_CFN_RESOURCE_TYPE_NAME() *string
func CfnEventTrigger_IsCfnElement ¶ added in v2.176.0
func CfnEventTrigger_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnEventTrigger_IsCfnEventTrigger ¶ added in v2.231.0
func CfnEventTrigger_IsCfnEventTrigger(x interface{}) *bool
Checks whether the given object is a CfnEventTrigger.
func CfnEventTrigger_IsCfnResource ¶ added in v2.176.0
func CfnEventTrigger_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnEventTrigger_IsConstruct ¶ added in v2.176.0
func CfnEventTrigger_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnIntegration_CFN_RESOURCE_TYPE_NAME ¶
func CfnIntegration_CFN_RESOURCE_TYPE_NAME() *string
func CfnIntegration_IsCfnElement ¶
func CfnIntegration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnIntegration_IsCfnIntegration ¶ added in v2.231.0
func CfnIntegration_IsCfnIntegration(x interface{}) *bool
Checks whether the given object is a CfnIntegration.
func CfnIntegration_IsCfnResource ¶
func CfnIntegration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnIntegration_IsConstruct ¶
func CfnIntegration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnObjectType_CFN_RESOURCE_TYPE_NAME ¶
func CfnObjectType_CFN_RESOURCE_TYPE_NAME() *string
func CfnObjectType_IsCfnElement ¶
func CfnObjectType_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnObjectType_IsCfnObjectType ¶ added in v2.231.0
func CfnObjectType_IsCfnObjectType(x interface{}) *bool
Checks whether the given object is a CfnObjectType.
func CfnObjectType_IsCfnResource ¶
func CfnObjectType_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnObjectType_IsConstruct ¶
func CfnObjectType_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRecommender_ArnForRecommender ¶ added in v2.247.0
func CfnRecommender_ArnForRecommender(resource interfacesawscustomerprofiles.IRecommenderRef) *string
func CfnRecommender_CFN_RESOURCE_TYPE_NAME ¶ added in v2.247.0
func CfnRecommender_CFN_RESOURCE_TYPE_NAME() *string
func CfnRecommender_IsCfnElement ¶ added in v2.247.0
func CfnRecommender_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRecommender_IsCfnRecommender ¶ added in v2.247.0
func CfnRecommender_IsCfnRecommender(x interface{}) *bool
Checks whether the given object is a CfnRecommender.
func CfnRecommender_IsCfnResource ¶ added in v2.247.0
func CfnRecommender_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRecommender_IsConstruct ¶ added in v2.247.0
func CfnRecommender_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSegmentDefinition_ArnForSegmentDefinition ¶ added in v2.227.0
func CfnSegmentDefinition_ArnForSegmentDefinition(resource interfacesawscustomerprofiles.ISegmentDefinitionRef) *string
func CfnSegmentDefinition_CFN_RESOURCE_TYPE_NAME ¶ added in v2.172.0
func CfnSegmentDefinition_CFN_RESOURCE_TYPE_NAME() *string
func CfnSegmentDefinition_IsCfnElement ¶ added in v2.172.0
func CfnSegmentDefinition_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSegmentDefinition_IsCfnResource ¶ added in v2.172.0
func CfnSegmentDefinition_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSegmentDefinition_IsCfnSegmentDefinition ¶ added in v2.231.0
func CfnSegmentDefinition_IsCfnSegmentDefinition(x interface{}) *bool
Checks whether the given object is a CfnSegmentDefinition.
func CfnSegmentDefinition_IsConstruct ¶ added in v2.172.0
func CfnSegmentDefinition_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCalculatedAttributeDefinition_Override ¶ added in v2.85.0
func NewCfnCalculatedAttributeDefinition_Override(c CfnCalculatedAttributeDefinition, scope constructs.Construct, id *string, props *CfnCalculatedAttributeDefinitionProps)
Create a new `AWS::CustomerProfiles::CalculatedAttributeDefinition`.
func NewCfnDomain_Override ¶
func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
Create a new `AWS::CustomerProfiles::Domain`.
func NewCfnEventStream_Override ¶ added in v2.85.0
func NewCfnEventStream_Override(c CfnEventStream, scope constructs.Construct, id *string, props *CfnEventStreamProps)
Create a new `AWS::CustomerProfiles::EventStream`.
func NewCfnEventTrigger_Override ¶ added in v2.176.0
func NewCfnEventTrigger_Override(c CfnEventTrigger, scope constructs.Construct, id *string, props *CfnEventTriggerProps)
Create a new `AWS::CustomerProfiles::EventTrigger`.
func NewCfnIntegration_Override ¶
func NewCfnIntegration_Override(c CfnIntegration, scope constructs.Construct, id *string, props *CfnIntegrationProps)
Create a new `AWS::CustomerProfiles::Integration`.
func NewCfnObjectType_Override ¶
func NewCfnObjectType_Override(c CfnObjectType, scope constructs.Construct, id *string, props *CfnObjectTypeProps)
Create a new `AWS::CustomerProfiles::ObjectType`.
func NewCfnRecommender_Override ¶ added in v2.247.0
func NewCfnRecommender_Override(c CfnRecommender, scope constructs.Construct, id *string, props *CfnRecommenderProps)
Create a new `AWS::CustomerProfiles::Recommender`.
func NewCfnSegmentDefinition_Override ¶ added in v2.172.0
func NewCfnSegmentDefinition_Override(c CfnSegmentDefinition, scope constructs.Construct, id *string, props *CfnSegmentDefinitionProps)
Create a new `AWS::CustomerProfiles::SegmentDefinition`.
Types ¶
type CfnCalculatedAttributeDefinition ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.ICalculatedAttributeDefinitionRef
awscdk.ITaggableV2
// The timestamp of when the calculated attribute definition was created.
AttrCreatedAt() *string
// Mathematical expression and a list of attribute items specified in that expression.
AttributeDetails() interface{}
SetAttributeDetails(val interface{})
// The timestamp of when the calculated attribute definition was most recently edited.
AttrLastUpdatedAt() *string
// The readiness status of the calculated attribute.
AttrReadiness() awscdk.IResolvable
// Status of the Calculated Attribute creation (whether all historical data has been indexed.).
AttrStatus() *string
// A reference to a CalculatedAttributeDefinition resource.
CalculatedAttributeDefinitionRef() *interfacesawscustomerprofiles.CalculatedAttributeDefinitionReference
// The name of an attribute defined in a profile object type.
CalculatedAttributeName() *string
SetCalculatedAttributeName(val *string)
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// The conditions including range, object count, and threshold for the calculated attribute.
Conditions() interface{}
SetConditions(val interface{})
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the calculated attribute.
Description() *string
SetDescription(val *string)
// The display name of the calculated attribute.
DisplayName() *string
SetDisplayName(val *string)
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The aggregation operation to perform for the calculated attribute.
Statistic() *string
SetStatistic(val *string)
// An array of key-value pairs to apply to this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
UseHistoricalData() interface{}
SetUseHistoricalData(val interface{})
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
A calculated attribute definition for Customer Profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCalculatedAttributeDefinition := awscdk.Aws_customerprofiles.NewCfnCalculatedAttributeDefinition(this, jsii.String("MyCfnCalculatedAttributeDefinition"), &CfnCalculatedAttributeDefinitionProps{
AttributeDetails: &AttributeDetailsProperty{
Attributes: []interface{}{
&AttributeItemProperty{
Name: jsii.String("name"),
},
},
Expression: jsii.String("expression"),
},
CalculatedAttributeName: jsii.String("calculatedAttributeName"),
DomainName: jsii.String("domainName"),
Statistic: jsii.String("statistic"),
// the properties below are optional
Conditions: &ConditionsProperty{
ObjectCount: jsii.Number(123),
Range: &RangeProperty{
Unit: jsii.String("unit"),
// the properties below are optional
TimestampFormat: jsii.String("timestampFormat"),
TimestampSource: jsii.String("timestampSource"),
Value: jsii.Number(123),
ValueRange: &ValueRangeProperty{
End: jsii.Number(123),
Start: jsii.Number(123),
},
},
Threshold: &ThresholdProperty{
Operator: jsii.String("operator"),
Value: jsii.String("value"),
},
},
Description: jsii.String("description"),
DisplayName: jsii.String("displayName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UseHistoricalData: jsii.Boolean(false),
})
func NewCfnCalculatedAttributeDefinition ¶ added in v2.85.0
func NewCfnCalculatedAttributeDefinition(scope constructs.Construct, id *string, props *CfnCalculatedAttributeDefinitionProps) CfnCalculatedAttributeDefinition
Create a new `AWS::CustomerProfiles::CalculatedAttributeDefinition`.
type CfnCalculatedAttributeDefinitionProps ¶ added in v2.85.0
type CfnCalculatedAttributeDefinitionProps struct {
// Mathematical expression and a list of attribute items specified in that expression.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails
//
AttributeDetails interface{} `field:"required" json:"attributeDetails" yaml:"attributeDetails"`
// The name of an attribute defined in a profile object type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-calculatedattributename
//
CalculatedAttributeName *string `field:"required" json:"calculatedAttributeName" yaml:"calculatedAttributeName"`
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// The aggregation operation to perform for the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-statistic
//
Statistic *string `field:"required" json:"statistic" yaml:"statistic"`
// The conditions including range, object count, and threshold for the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-conditions
//
Conditions interface{} `field:"optional" json:"conditions" yaml:"conditions"`
// The description of the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The display name of the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-displayname
//
DisplayName *string `field:"optional" json:"displayName" yaml:"displayName"`
// An array of key-value pairs to apply to this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// Whether historical data ingested before the Calculated Attribute was created should be included in calculations.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-calculatedattributedefinition.html#cfn-customerprofiles-calculatedattributedefinition-usehistoricaldata
//
UseHistoricalData interface{} `field:"optional" json:"useHistoricalData" yaml:"useHistoricalData"`
}
Properties for defining a `CfnCalculatedAttributeDefinition`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCalculatedAttributeDefinitionProps := &CfnCalculatedAttributeDefinitionProps{
AttributeDetails: &AttributeDetailsProperty{
Attributes: []interface{}{
&AttributeItemProperty{
Name: jsii.String("name"),
},
},
Expression: jsii.String("expression"),
},
CalculatedAttributeName: jsii.String("calculatedAttributeName"),
DomainName: jsii.String("domainName"),
Statistic: jsii.String("statistic"),
// the properties below are optional
Conditions: &ConditionsProperty{
ObjectCount: jsii.Number(123),
Range: &RangeProperty{
Unit: jsii.String("unit"),
// the properties below are optional
TimestampFormat: jsii.String("timestampFormat"),
TimestampSource: jsii.String("timestampSource"),
Value: jsii.Number(123),
ValueRange: &ValueRangeProperty{
End: jsii.Number(123),
Start: jsii.Number(123),
},
},
Threshold: &ThresholdProperty{
Operator: jsii.String("operator"),
Value: jsii.String("value"),
},
},
Description: jsii.String("description"),
DisplayName: jsii.String("displayName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UseHistoricalData: jsii.Boolean(false),
}
type CfnCalculatedAttributeDefinition_AttributeDetailsProperty ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition_AttributeDetailsProperty struct {
// Mathematical expression and a list of attribute items specified in that expression.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-attributes
//
Attributes interface{} `field:"required" json:"attributes" yaml:"attributes"`
// Mathematical expression that is performed on attribute items provided in the attribute list.
//
// Each element in the expression should follow the structure of \"{ObjectTypeName.AttributeName}\".
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributedetails.html#cfn-customerprofiles-calculatedattributedefinition-attributedetails-expression
//
Expression *string `field:"required" json:"expression" yaml:"expression"`
}
Mathematical expression and a list of attribute items specified in that expression.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
attributeDetailsProperty := &AttributeDetailsProperty{
Attributes: []interface{}{
&AttributeItemProperty{
Name: jsii.String("name"),
},
},
Expression: jsii.String("expression"),
}
type CfnCalculatedAttributeDefinition_AttributeItemProperty ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition_AttributeItemProperty struct {
// The unique name of the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-attributeitem.html#cfn-customerprofiles-calculatedattributedefinition-attributeitem-name
//
Name *string `field:"required" json:"name" yaml:"name"`
}
The details of a single attribute item specified in the mathematical expression.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
attributeItemProperty := &AttributeItemProperty{
Name: jsii.String("name"),
}
type CfnCalculatedAttributeDefinition_ConditionsProperty ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition_ConditionsProperty struct {
// The number of profile objects used for the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-objectcount
//
ObjectCount *float64 `field:"optional" json:"objectCount" yaml:"objectCount"`
// The relative time period over which data is included in the aggregation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-range
//
Range interface{} `field:"optional" json:"range" yaml:"range"`
// The threshold for the calculated attribute.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-conditions.html#cfn-customerprofiles-calculatedattributedefinition-conditions-threshold
//
Threshold interface{} `field:"optional" json:"threshold" yaml:"threshold"`
}
The conditions including range, object count, and threshold for the calculated attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
conditionsProperty := &ConditionsProperty{
ObjectCount: jsii.Number(123),
Range: &RangeProperty{
Unit: jsii.String("unit"),
// the properties below are optional
TimestampFormat: jsii.String("timestampFormat"),
TimestampSource: jsii.String("timestampSource"),
Value: jsii.Number(123),
ValueRange: &ValueRangeProperty{
End: jsii.Number(123),
Start: jsii.Number(123),
},
},
Threshold: &ThresholdProperty{
Operator: jsii.String("operator"),
Value: jsii.String("value"),
},
}
type CfnCalculatedAttributeDefinition_RangeProperty ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition_RangeProperty struct {
// The unit of time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-unit
//
Unit *string `field:"required" json:"unit" yaml:"unit"`
// The format the timestamp field in your JSON object is specified.
//
// This value should be one of EPOCHMILLI (for Unix epoch timestamps with second/millisecond level precision) or ISO_8601 (following ISO_8601 format with second/millisecond level precision, with an optional offset of Z or in the format HH:MM or HHMM.). E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "2001-07-04T12:08:56.235-0700"}}, then TimestampFormat should be "ISO_8601"
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampformat
//
TimestampFormat *string `field:"optional" json:"timestampFormat" yaml:"timestampFormat"`
// An expression specifying the field in your JSON object from which the date should be parsed.
//
// The expression should follow the structure of \"{ObjectTypeName.<Location of timestamp field in JSON pointer format>}\". E.g. if your object type is MyType and source JSON is {"generatedAt": {"timestamp": "1737587945945"}}, then TimestampSource should be "{MyType.generatedAt.timestamp}"
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-timestampsource
//
TimestampSource *string `field:"optional" json:"timestampSource" yaml:"timestampSource"`
// The amount of time of the specified unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-value
//
Value *float64 `field:"optional" json:"value" yaml:"value"`
// A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.
//
// Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-range.html#cfn-customerprofiles-calculatedattributedefinition-range-valuerange
//
ValueRange interface{} `field:"optional" json:"valueRange" yaml:"valueRange"`
}
The relative time period over which data is included in the aggregation.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
rangeProperty := &RangeProperty{
Unit: jsii.String("unit"),
// the properties below are optional
TimestampFormat: jsii.String("timestampFormat"),
TimestampSource: jsii.String("timestampSource"),
Value: jsii.Number(123),
ValueRange: &ValueRangeProperty{
End: jsii.Number(123),
Start: jsii.Number(123),
},
}
type CfnCalculatedAttributeDefinition_ReadinessProperty ¶ added in v2.201.0
type CfnCalculatedAttributeDefinition_ReadinessProperty struct {
// Any customer messaging.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-message
//
Message *string `field:"optional" json:"message" yaml:"message"`
// Approximately how far the Calculated Attribute creation is from completion.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-readiness.html#cfn-customerprofiles-calculatedattributedefinition-readiness-progresspercentage
//
ProgressPercentage *float64 `field:"optional" json:"progressPercentage" yaml:"progressPercentage"`
}
Information indicating if the Calculated Attribute is ready for use by confirming all historical data has been processed and reflected.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
readinessProperty := &ReadinessProperty{
Message: jsii.String("message"),
ProgressPercentage: jsii.Number(123),
}
type CfnCalculatedAttributeDefinition_ThresholdProperty ¶ added in v2.85.0
type CfnCalculatedAttributeDefinition_ThresholdProperty struct {
// The operator of the threshold.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-operator
//
Operator *string `field:"required" json:"operator" yaml:"operator"`
// The value of the threshold.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-threshold.html#cfn-customerprofiles-calculatedattributedefinition-threshold-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
The threshold for the calculated attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
thresholdProperty := &ThresholdProperty{
Operator: jsii.String("operator"),
Value: jsii.String("value"),
}
type CfnCalculatedAttributeDefinition_ValueRangeProperty ¶ added in v2.201.0
type CfnCalculatedAttributeDefinition_ValueRangeProperty struct {
// The ending point for this overridden range.
//
// Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-end
//
End *float64 `field:"required" json:"end" yaml:"end"`
// The starting point for this overridden range.
//
// Positive numbers indicate how many days in the past data should be included, and negative numbers indicate how many days in the future.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-calculatedattributedefinition-valuerange.html#cfn-customerprofiles-calculatedattributedefinition-valuerange-start
//
Start *float64 `field:"required" json:"start" yaml:"start"`
}
A structure letting customers specify a relative time window over which over which data is included in the Calculated Attribute.
Use positive numbers to indicate that the endpoint is in the past, and negative numbers to indicate it is in the future. ValueRange overrides Value.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
valueRangeProperty := &ValueRangeProperty{
End: jsii.Number(123),
Start: jsii.Number(123),
}
type CfnDomain ¶
type CfnDomain interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IDomainRef
awscdk.ITaggable
// The timestamp of when the domain was created.
AttrCreatedAt() *string
// Progress information for data store setup.
AttrDataStoreReadiness() awscdk.IResolvable
// The timestamp of when the domain was most recently edited.
AttrLastUpdatedAt() *string
// The status of rule-based matching rule.
AttrRuleBasedMatchingStatus() *string
// Usage-specific statistics about the domain.
AttrStats() awscdk.IResolvable
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Configuration and status of the data store for the domain.
DataStore() interface{}
SetDataStore(val interface{})
// The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
DeadLetterQueueUrl() *string
SetDeadLetterQueueUrl(val *string)
// The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
DefaultEncryptionKey() *string
SetDefaultEncryptionKey(val *string)
// The default number of days until the data within the domain expires.
DefaultExpirationDays() *float64
SetDefaultExpirationDays(val *float64)
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
// A reference to a Domain resource.
DomainRef() *interfacesawscustomerprofiles.DomainReference
Env() *interfaces.ResourceEnvironment
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The process of matching duplicate profiles.
Matching() interface{}
SetMatching(val interface{})
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The process of matching duplicate profiles using Rule-Based matching.
RuleBasedMatching() interface{}
SetRuleBasedMatching(val interface{})
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags used to organize, track, or control access for this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Specifies an Amazon Connect Customer Profiles Domain.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomain := awscdk.Aws_customerprofiles.NewCfnDomain(this, jsii.String("MyCfnDomain"), &CfnDomainProps{
DefaultExpirationDays: jsii.Number(123),
DomainName: jsii.String("domainName"),
// the properties below are optional
DataStore: &DataStoreProperty{
Enabled: jsii.Boolean(false),
Readiness: &ReadinessProperty{
Message: jsii.String("message"),
ProgressPercentage: jsii.Number(123),
},
},
DeadLetterQueueUrl: jsii.String("deadLetterQueueUrl"),
DefaultEncryptionKey: jsii.String("defaultEncryptionKey"),
Matching: &MatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AutoMerging: &AutoMergingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
Consolidation: &ConsolidationProperty{
MatchingAttributesList: []interface{}{
[]*string{
jsii.String("matchingAttributesList"),
},
},
},
MinAllowedConfidenceScoreForMerging: jsii.Number(123),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
JobSchedule: &JobScheduleProperty{
DayOfTheWeek: jsii.String("dayOfTheWeek"),
Time: jsii.String("time"),
},
},
RuleBasedMatching: &RuleBasedMatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AttributeTypesSelector: &AttributeTypesSelectorProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
// the properties below are optional
Address: []*string{
jsii.String("address"),
},
EmailAddress: []*string{
jsii.String("emailAddress"),
},
PhoneNumber: []*string{
jsii.String("phoneNumber"),
},
},
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
MatchingRules: []interface{}{
&MatchingRuleProperty{
Rule: []*string{
jsii.String("rule"),
},
},
},
MaxAllowedRuleLevelForMatching: jsii.Number(123),
MaxAllowedRuleLevelForMerging: jsii.Number(123),
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnDomain ¶
func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
Create a new `AWS::CustomerProfiles::Domain`.
type CfnDomainProps ¶
type CfnDomainProps struct {
// The default number of days until the data within the domain expires.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultexpirationdays
//
DefaultExpirationDays *float64 `field:"required" json:"defaultExpirationDays" yaml:"defaultExpirationDays"`
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// Configuration and status of the data store for the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-datastore
//
DataStore interface{} `field:"optional" json:"dataStore" yaml:"dataStore"`
// The URL of the SQS dead letter queue, which is used for reporting errors associated with ingesting data from third party applications.
//
// You must set up a policy on the `DeadLetterQueue` for the `SendMessage` operation to enable Amazon Connect Customer Profiles to send messages to the `DeadLetterQueue` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-deadletterqueueurl
//
DeadLetterQueueUrl *string `field:"optional" json:"deadLetterQueueUrl" yaml:"deadLetterQueueUrl"`
// The default encryption key, which is an AWS managed key, is used when no specific type of encryption key is specified.
//
// It is used to encrypt all data before it is placed in permanent or semi-permanent storage.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-defaultencryptionkey
//
DefaultEncryptionKey *string `field:"optional" json:"defaultEncryptionKey" yaml:"defaultEncryptionKey"`
// The process of matching duplicate profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-matching
//
Matching interface{} `field:"optional" json:"matching" yaml:"matching"`
// The process of matching duplicate profiles using Rule-Based matching.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-rulebasedmatching
//
RuleBasedMatching interface{} `field:"optional" json:"ruleBasedMatching" yaml:"ruleBasedMatching"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-domain.html#cfn-customerprofiles-domain-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnDomain`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnDomainProps := &CfnDomainProps{
DefaultExpirationDays: jsii.Number(123),
DomainName: jsii.String("domainName"),
// the properties below are optional
DataStore: &DataStoreProperty{
Enabled: jsii.Boolean(false),
Readiness: &ReadinessProperty{
Message: jsii.String("message"),
ProgressPercentage: jsii.Number(123),
},
},
DeadLetterQueueUrl: jsii.String("deadLetterQueueUrl"),
DefaultEncryptionKey: jsii.String("defaultEncryptionKey"),
Matching: &MatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AutoMerging: &AutoMergingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
Consolidation: &ConsolidationProperty{
MatchingAttributesList: []interface{}{
[]*string{
jsii.String("matchingAttributesList"),
},
},
},
MinAllowedConfidenceScoreForMerging: jsii.Number(123),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
JobSchedule: &JobScheduleProperty{
DayOfTheWeek: jsii.String("dayOfTheWeek"),
Time: jsii.String("time"),
},
},
RuleBasedMatching: &RuleBasedMatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AttributeTypesSelector: &AttributeTypesSelectorProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
// the properties below are optional
Address: []*string{
jsii.String("address"),
},
EmailAddress: []*string{
jsii.String("emailAddress"),
},
PhoneNumber: []*string{
jsii.String("phoneNumber"),
},
},
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
MatchingRules: []interface{}{
&MatchingRuleProperty{
Rule: []*string{
jsii.String("rule"),
},
},
},
MaxAllowedRuleLevelForMatching: jsii.Number(123),
MaxAllowedRuleLevelForMerging: jsii.Number(123),
Status: jsii.String("status"),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnDomain_AttributeTypesSelectorProperty ¶ added in v2.103.0
type CfnDomain_AttributeTypesSelectorProperty struct {
// Configures the `AttributeMatchingModel` , you can either choose `ONE_TO_ONE` or `MANY_TO_MANY` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-attributematchingmodel
//
AttributeMatchingModel *string `field:"required" json:"attributeMatchingModel" yaml:"attributeMatchingModel"`
// The `Address` type.
//
// You can choose from `Address` , `BusinessAddress` , `MaillingAddress` , and `ShippingAddress` . You only can use the `Address` type in the `MatchingRule` . For example, if you want to match a profile based on `BusinessAddress.City` or `MaillingAddress.City` , you can choose the `BusinessAddress` and the `MaillingAddress` to represent the `Address` type and specify the `Address.City` on the matching rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-address
//
Address *[]*string `field:"optional" json:"address" yaml:"address"`
// The Email type.
//
// You can choose from `EmailAddress` , `BusinessEmailAddress` and `PersonalEmailAddress` . You only can use the `EmailAddress` type in the `MatchingRule` . For example, if you want to match profile based on `PersonalEmailAddress` or `BusinessEmailAddress` , you can choose the `PersonalEmailAddress` and the `BusinessEmailAddress` to represent the `EmailAddress` type and only specify the `EmailAddress` on the matching rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-emailaddress
//
EmailAddress *[]*string `field:"optional" json:"emailAddress" yaml:"emailAddress"`
// The `PhoneNumber` type.
//
// You can choose from `PhoneNumber` , `HomePhoneNumber` , and `MobilePhoneNumber` . You only can use the `PhoneNumber` type in the `MatchingRule` . For example, if you want to match a profile based on `Phone` or `HomePhone` , you can choose the `Phone` and the `HomePhone` to represent the `PhoneNumber` type and only specify the `PhoneNumber` on the matching rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-attributetypesselector.html#cfn-customerprofiles-domain-attributetypesselector-phonenumber
//
PhoneNumber *[]*string `field:"optional" json:"phoneNumber" yaml:"phoneNumber"`
}
Configures information about the `AttributeTypesSelector` which rule-based identity resolution uses to match profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
attributeTypesSelectorProperty := &AttributeTypesSelectorProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
// the properties below are optional
Address: []*string{
jsii.String("address"),
},
EmailAddress: []*string{
jsii.String("emailAddress"),
},
PhoneNumber: []*string{
jsii.String("phoneNumber"),
},
}
type CfnDomain_AutoMergingProperty ¶ added in v2.103.0
type CfnDomain_AutoMergingProperty struct {
// The flag that enables the auto-merging of duplicate profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// Determines how the auto-merging process should resolve conflicts between different profiles.
//
// For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-conflictresolution
//
ConflictResolution interface{} `field:"optional" json:"conflictResolution" yaml:"conflictResolution"`
// A list of matching attributes that represent matching criteria.
//
// If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-consolidation
//
Consolidation interface{} `field:"optional" json:"consolidation" yaml:"consolidation"`
// A number between 0 and 1 that represents the minimum confidence score required for profiles within a matching group to be merged during the auto-merge process.
//
// A higher score means that a higher similarity is required to merge profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-automerging.html#cfn-customerprofiles-domain-automerging-minallowedconfidencescoreformerging
//
MinAllowedConfidenceScoreForMerging *float64 `field:"optional" json:"minAllowedConfidenceScoreForMerging" yaml:"minAllowedConfidenceScoreForMerging"`
}
Configuration information about the auto-merging process.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
autoMergingProperty := &AutoMergingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
Consolidation: &ConsolidationProperty{
MatchingAttributesList: []interface{}{
[]*string{
jsii.String("matchingAttributesList"),
},
},
},
MinAllowedConfidenceScoreForMerging: jsii.Number(123),
}
type CfnDomain_ConflictResolutionProperty ¶ added in v2.103.0
type CfnDomain_ConflictResolutionProperty struct {
// How the auto-merging process should resolve conflicts between different profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-conflictresolvingmodel
//
ConflictResolvingModel *string `field:"required" json:"conflictResolvingModel" yaml:"conflictResolvingModel"`
// The `ObjectType` name that is used to resolve profile merging conflicts when choosing `SOURCE` as the `ConflictResolvingModel` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-conflictresolution.html#cfn-customerprofiles-domain-conflictresolution-sourcename
//
SourceName *string `field:"optional" json:"sourceName" yaml:"sourceName"`
}
Determines how the auto-merging process should resolve conflicts between different profiles.
For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
conflictResolutionProperty := &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
}
type CfnDomain_ConsolidationProperty ¶ added in v2.103.0
type CfnDomain_ConsolidationProperty struct {
// A list of matching criteria.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-consolidation.html#cfn-customerprofiles-domain-consolidation-matchingattributeslist
//
MatchingAttributesList interface{} `field:"required" json:"matchingAttributesList" yaml:"matchingAttributesList"`
}
A list of matching attributes that represent matching criteria.
If two profiles meet at least one of the requirements in the matching attributes list, they will be merged.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
consolidationProperty := &ConsolidationProperty{
MatchingAttributesList: []interface{}{
[]*string{
jsii.String("matchingAttributesList"),
},
},
}
type CfnDomain_DataStoreProperty ¶ added in v2.227.0
type CfnDomain_DataStoreProperty struct {
// Whether the data store is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-enabled
//
Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"`
// Progress information for data store setup.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-datastore.html#cfn-customerprofiles-domain-datastore-readiness
//
Readiness interface{} `field:"optional" json:"readiness" yaml:"readiness"`
}
Configuration and status of the data store for the domain.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dataStoreProperty := &DataStoreProperty{
Enabled: jsii.Boolean(false),
Readiness: &ReadinessProperty{
Message: jsii.String("message"),
ProgressPercentage: jsii.Number(123),
},
}
type CfnDomain_DomainStatsProperty ¶ added in v2.103.0
type CfnDomain_DomainStatsProperty struct {
// The number of profiles that you are currently paying for in the domain.
//
// If you have more than 100 objects associated with a single profile, that profile counts as two profiles. If you have more than 200 objects, that profile counts as three, and so on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-meteringprofilecount
//
MeteringProfileCount *float64 `field:"optional" json:"meteringProfileCount" yaml:"meteringProfileCount"`
// The total number of objects in domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-objectcount
//
ObjectCount *float64 `field:"optional" json:"objectCount" yaml:"objectCount"`
// The total number of profiles currently in the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-profilecount
//
ProfileCount *float64 `field:"optional" json:"profileCount" yaml:"profileCount"`
// The total size, in bytes, of all objects in the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-domainstats.html#cfn-customerprofiles-domain-domainstats-totalsize
//
TotalSize *float64 `field:"optional" json:"totalSize" yaml:"totalSize"`
}
Usage-specific statistics about the domain.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
domainStatsProperty := &DomainStatsProperty{
MeteringProfileCount: jsii.Number(123),
ObjectCount: jsii.Number(123),
ProfileCount: jsii.Number(123),
TotalSize: jsii.Number(123),
}
type CfnDomain_ExportingConfigProperty ¶ added in v2.103.0
type CfnDomain_ExportingConfigProperty struct {
// The S3 location where Identity Resolution Jobs write result files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-exportingconfig.html#cfn-customerprofiles-domain-exportingconfig-s3exporting
//
S3Exporting interface{} `field:"optional" json:"s3Exporting" yaml:"s3Exporting"`
}
Configuration information for exporting Identity Resolution results, for example, to an S3 bucket.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
exportingConfigProperty := &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
}
type CfnDomain_JobScheduleProperty ¶ added in v2.103.0
type CfnDomain_JobScheduleProperty struct {
// The day when the Identity Resolution Job should run every week.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-dayoftheweek
//
DayOfTheWeek *string `field:"required" json:"dayOfTheWeek" yaml:"dayOfTheWeek"`
// The time when the Identity Resolution Job should run every week.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-jobschedule.html#cfn-customerprofiles-domain-jobschedule-time
//
Time *string `field:"required" json:"time" yaml:"time"`
}
The day and time when do you want to start the Identity Resolution Job every week.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
jobScheduleProperty := &JobScheduleProperty{
DayOfTheWeek: jsii.String("dayOfTheWeek"),
Time: jsii.String("time"),
}
type CfnDomain_MatchingProperty ¶ added in v2.103.0
type CfnDomain_MatchingProperty struct {
// The flag that enables the matching process of duplicate profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// Configuration information about the auto-merging process.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-automerging
//
AutoMerging interface{} `field:"optional" json:"autoMerging" yaml:"autoMerging"`
// The S3 location where Identity Resolution Jobs write result files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-exportingconfig
//
ExportingConfig interface{} `field:"optional" json:"exportingConfig" yaml:"exportingConfig"`
// The day and time when do you want to start the Identity Resolution Job every week.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matching.html#cfn-customerprofiles-domain-matching-jobschedule
//
JobSchedule interface{} `field:"optional" json:"jobSchedule" yaml:"jobSchedule"`
}
The process of matching duplicate profiles.
If `Matching = true` , Amazon Connect Customer Profiles starts a weekly batch process called *Identity Resolution Job* . If you do not specify a date and time for the *Identity Resolution Job* to run, by default it runs every Saturday at 12AM UTC to detect duplicate profiles in your domains. After the *Identity Resolution Job* completes, use the `GetMatches` API to return and review the results. Or, if you have configured `ExportingConfig` in the `MatchingRequest` , you can download the results from S3.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
matchingProperty := &MatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AutoMerging: &AutoMergingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
Consolidation: &ConsolidationProperty{
MatchingAttributesList: []interface{}{
[]*string{
jsii.String("matchingAttributesList"),
},
},
},
MinAllowedConfidenceScoreForMerging: jsii.Number(123),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
JobSchedule: &JobScheduleProperty{
DayOfTheWeek: jsii.String("dayOfTheWeek"),
Time: jsii.String("time"),
},
}
type CfnDomain_MatchingRuleProperty ¶ added in v2.103.0
type CfnDomain_MatchingRuleProperty struct {
// A single rule level of the `MatchRules` .
//
// Configures how the rule-based matching process should match profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-matchingrule.html#cfn-customerprofiles-domain-matchingrule-rule
//
Rule *[]*string `field:"required" json:"rule" yaml:"rule"`
}
Specifies how the rule-based matching process should match profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
matchingRuleProperty := &MatchingRuleProperty{
Rule: []*string{
jsii.String("rule"),
},
}
type CfnDomain_ReadinessProperty ¶ added in v2.227.0
type CfnDomain_ReadinessProperty struct {
// A message describing the current progress.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-message
//
Message *string `field:"optional" json:"message" yaml:"message"`
// The percentage of progress completed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-readiness.html#cfn-customerprofiles-domain-readiness-progresspercentage
//
ProgressPercentage *float64 `field:"optional" json:"progressPercentage" yaml:"progressPercentage"`
}
Progress information for data store setup.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
readinessProperty := &ReadinessProperty{
Message: jsii.String("message"),
ProgressPercentage: jsii.Number(123),
}
type CfnDomain_RuleBasedMatchingProperty ¶ added in v2.103.0
type CfnDomain_RuleBasedMatchingProperty struct {
// The flag that enables the matching process of duplicate profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-enabled
//
Enabled interface{} `field:"required" json:"enabled" yaml:"enabled"`
// Configures information about the `AttributeTypesSelector` where the rule-based identity resolution uses to match profiles.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-attributetypesselector
//
AttributeTypesSelector interface{} `field:"optional" json:"attributeTypesSelector" yaml:"attributeTypesSelector"`
// Determines how the auto-merging process should resolve conflicts between different profiles.
//
// For example, if Profile A and Profile B have the same `FirstName` and `LastName` , `ConflictResolution` specifies which `EmailAddress` should be used.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-conflictresolution
//
ConflictResolution interface{} `field:"optional" json:"conflictResolution" yaml:"conflictResolution"`
// The S3 location where Identity Resolution Jobs write result files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-exportingconfig
//
ExportingConfig interface{} `field:"optional" json:"exportingConfig" yaml:"exportingConfig"`
// Configures how the rule-based matching process should match profiles.
//
// You can have up to 15 `MatchingRule` in the `MatchingRules` .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-matchingrules
//
MatchingRules interface{} `field:"optional" json:"matchingRules" yaml:"matchingRules"`
// Indicates the maximum allowed rule level for matching.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformatching
//
MaxAllowedRuleLevelForMatching *float64 `field:"optional" json:"maxAllowedRuleLevelForMatching" yaml:"maxAllowedRuleLevelForMatching"`
// Indicates the maximum allowed rule level for merging.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-maxallowedrulelevelformerging
//
MaxAllowedRuleLevelForMerging *float64 `field:"optional" json:"maxAllowedRuleLevelForMerging" yaml:"maxAllowedRuleLevelForMerging"`
// The status of rule-based matching rule.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-rulebasedmatching.html#cfn-customerprofiles-domain-rulebasedmatching-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
The process of matching duplicate profiles using Rule-Based matching.
If `RuleBasedMatching = true` , Amazon Connect Customer Profiles will start to match and merge your profiles according to your configuration in the `RuleBasedMatchingRequest` . You can use the `ListRuleBasedMatches` and `GetSimilarProfiles` API to return and review the results. Also, if you have configured `ExportingConfig` in the `RuleBasedMatchingRequest` , you can download the results from S3.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
ruleBasedMatchingProperty := &RuleBasedMatchingProperty{
Enabled: jsii.Boolean(false),
// the properties below are optional
AttributeTypesSelector: &AttributeTypesSelectorProperty{
AttributeMatchingModel: jsii.String("attributeMatchingModel"),
// the properties below are optional
Address: []*string{
jsii.String("address"),
},
EmailAddress: []*string{
jsii.String("emailAddress"),
},
PhoneNumber: []*string{
jsii.String("phoneNumber"),
},
},
ConflictResolution: &ConflictResolutionProperty{
ConflictResolvingModel: jsii.String("conflictResolvingModel"),
// the properties below are optional
SourceName: jsii.String("sourceName"),
},
ExportingConfig: &ExportingConfigProperty{
S3Exporting: &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
},
},
MatchingRules: []interface{}{
&MatchingRuleProperty{
Rule: []*string{
jsii.String("rule"),
},
},
},
MaxAllowedRuleLevelForMatching: jsii.Number(123),
MaxAllowedRuleLevelForMerging: jsii.Number(123),
Status: jsii.String("status"),
}
type CfnDomain_S3ExportingConfigProperty ¶ added in v2.103.0
type CfnDomain_S3ExportingConfigProperty struct {
// The name of the S3 bucket where Identity Resolution Jobs write result files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3bucketname
//
S3BucketName *string `field:"required" json:"s3BucketName" yaml:"s3BucketName"`
// The S3 key name of the location where Identity Resolution Jobs write result files.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-domain-s3exportingconfig.html#cfn-customerprofiles-domain-s3exportingconfig-s3keyname
//
S3KeyName *string `field:"optional" json:"s3KeyName" yaml:"s3KeyName"`
}
The S3 location where Identity Resolution Jobs write result files.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3ExportingConfigProperty := &S3ExportingConfigProperty{
S3BucketName: jsii.String("s3BucketName"),
// the properties below are optional
S3KeyName: jsii.String("s3KeyName"),
}
type CfnEventStream ¶ added in v2.85.0
type CfnEventStream interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IEventStreamRef
awscdk.ITaggableV2
// The timestamp of when the export was created.
AttrCreatedAt() *string
// Details regarding the Kinesis stream.
AttrDestinationDetails() awscdk.IResolvable
AttrDestinationDetailsStatus() *string
AttrDestinationDetailsUri() *string
// A unique identifier for the event stream.
AttrEventStreamArn() *string
// The operational state of destination stream for export.
AttrState() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// The name of the event stream.
EventStreamName() *string
SetEventStreamName(val *string)
// A reference to a EventStream resource.
EventStreamRef() *interfacesawscustomerprofiles.EventStreamReference
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The StreamARN of the destination to deliver profile events to.
Uri() *string
SetUri(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
An Event Stream resource of Amazon Connect Customer Profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEventStream := awscdk.Aws_customerprofiles.NewCfnEventStream(this, jsii.String("MyCfnEventStream"), &CfnEventStreamProps{
DomainName: jsii.String("domainName"),
EventStreamName: jsii.String("eventStreamName"),
Uri: jsii.String("uri"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnEventStream ¶ added in v2.85.0
func NewCfnEventStream(scope constructs.Construct, id *string, props *CfnEventStreamProps) CfnEventStream
Create a new `AWS::CustomerProfiles::EventStream`.
type CfnEventStreamProps ¶ added in v2.85.0
type CfnEventStreamProps struct {
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// The name of the event stream.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-eventstreamname
//
EventStreamName *string `field:"required" json:"eventStreamName" yaml:"eventStreamName"`
// The StreamARN of the destination to deliver profile events to.
//
// For example, arn:aws:kinesis:region:account-id:stream/stream-name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-uri
//
Uri *string `field:"required" json:"uri" yaml:"uri"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventstream.html#cfn-customerprofiles-eventstream-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnEventStream`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEventStreamProps := &CfnEventStreamProps{
DomainName: jsii.String("domainName"),
EventStreamName: jsii.String("eventStreamName"),
Uri: jsii.String("uri"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnEventStream_DestinationDetailsProperty ¶ added in v2.85.0
type CfnEventStream_DestinationDetailsProperty struct {
// The status of enabling the Kinesis stream as a destination for export.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventstream-destinationdetails.html#cfn-customerprofiles-eventstream-destinationdetails-status
//
Status *string `field:"required" json:"status" yaml:"status"`
// The StreamARN of the destination to deliver profile events to.
//
// For example, arn:aws:kinesis:region:account-id:stream/stream-name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventstream-destinationdetails.html#cfn-customerprofiles-eventstream-destinationdetails-uri
//
Uri *string `field:"required" json:"uri" yaml:"uri"`
}
Details regarding the Kinesis stream.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
destinationDetailsProperty := &DestinationDetailsProperty{
Status: jsii.String("status"),
Uri: jsii.String("uri"),
}
type CfnEventTrigger ¶ added in v2.176.0
type CfnEventTrigger interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IEventTriggerRef
awscdk.ITaggableV2
// The timestamp of when the event trigger was created.
AttrCreatedAt() *string
// The timestamp of when the event trigger was most recently updated.
AttrLastUpdatedAt() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the event trigger.
Description() *string
SetDescription(val *string)
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// A list of conditions that determine when an event should trigger the destination.
EventTriggerConditions() interface{}
SetEventTriggerConditions(val interface{})
// Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
EventTriggerLimits() interface{}
SetEventTriggerLimits(val interface{})
// The unique name of the event trigger.
EventTriggerName() *string
SetEventTriggerName(val *string)
// A reference to a EventTrigger resource.
EventTriggerRef() *interfacesawscustomerprofiles.EventTriggerReference
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The unique name of the object type.
ObjectTypeName() *string
SetObjectTypeName(val *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 })`.
Ref() *string
// The destination is triggered only for profiles that meet the criteria of a segment definition.
SegmentFilter() *string
SetSegmentFilter(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// An array of key-value pairs to apply to this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Specifies the rules to perform an action based on customer ingested data.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEventTrigger := awscdk.Aws_customerprofiles.NewCfnEventTrigger(this, jsii.String("MyCfnEventTrigger"), &CfnEventTriggerProps{
DomainName: jsii.String("domainName"),
EventTriggerConditions: []interface{}{
&EventTriggerConditionProperty{
EventTriggerDimensions: []interface{}{
&EventTriggerDimensionProperty{
ObjectAttributes: []interface{}{
&ObjectAttributeProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
FieldName: jsii.String("fieldName"),
Source: jsii.String("source"),
},
},
},
},
LogicalOperator: jsii.String("logicalOperator"),
},
},
EventTriggerName: jsii.String("eventTriggerName"),
ObjectTypeName: jsii.String("objectTypeName"),
// the properties below are optional
Description: jsii.String("description"),
EventTriggerLimits: &EventTriggerLimitsProperty{
EventExpiration: jsii.Number(123),
Periods: []interface{}{
&PeriodProperty{
Unit: jsii.String("unit"),
Value: jsii.Number(123),
// the properties below are optional
MaxInvocationsPerProfile: jsii.Number(123),
Unlimited: jsii.Boolean(false),
},
},
},
SegmentFilter: jsii.String("segmentFilter"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnEventTrigger ¶ added in v2.176.0
func NewCfnEventTrigger(scope constructs.Construct, id *string, props *CfnEventTriggerProps) CfnEventTrigger
Create a new `AWS::CustomerProfiles::EventTrigger`.
type CfnEventTriggerProps ¶ added in v2.176.0
type CfnEventTriggerProps struct {
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// A list of conditions that determine when an event should trigger the destination.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerconditions
//
EventTriggerConditions interface{} `field:"required" json:"eventTriggerConditions" yaml:"eventTriggerConditions"`
// The unique name of the event trigger.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggername
//
EventTriggerName *string `field:"required" json:"eventTriggerName" yaml:"eventTriggerName"`
// The unique name of the object type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-objecttypename
//
ObjectTypeName *string `field:"required" json:"objectTypeName" yaml:"objectTypeName"`
// The description of the event trigger.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits
//
EventTriggerLimits interface{} `field:"optional" json:"eventTriggerLimits" yaml:"eventTriggerLimits"`
// The destination is triggered only for profiles that meet the criteria of a segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-segmentfilter
//
SegmentFilter *string `field:"optional" json:"segmentFilter" yaml:"segmentFilter"`
// An array of key-value pairs to apply to this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-eventtrigger.html#cfn-customerprofiles-eventtrigger-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnEventTrigger`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnEventTriggerProps := &CfnEventTriggerProps{
DomainName: jsii.String("domainName"),
EventTriggerConditions: []interface{}{
&EventTriggerConditionProperty{
EventTriggerDimensions: []interface{}{
&EventTriggerDimensionProperty{
ObjectAttributes: []interface{}{
&ObjectAttributeProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
FieldName: jsii.String("fieldName"),
Source: jsii.String("source"),
},
},
},
},
LogicalOperator: jsii.String("logicalOperator"),
},
},
EventTriggerName: jsii.String("eventTriggerName"),
ObjectTypeName: jsii.String("objectTypeName"),
// the properties below are optional
Description: jsii.String("description"),
EventTriggerLimits: &EventTriggerLimitsProperty{
EventExpiration: jsii.Number(123),
Periods: []interface{}{
&PeriodProperty{
Unit: jsii.String("unit"),
Value: jsii.Number(123),
// the properties below are optional
MaxInvocationsPerProfile: jsii.Number(123),
Unlimited: jsii.Boolean(false),
},
},
},
SegmentFilter: jsii.String("segmentFilter"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnEventTrigger_EventTriggerConditionProperty ¶ added in v2.176.0
type CfnEventTrigger_EventTriggerConditionProperty struct {
// A list of dimensions to be evaluated for the event.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-eventtriggerdimensions
//
EventTriggerDimensions interface{} `field:"required" json:"eventTriggerDimensions" yaml:"eventTriggerDimensions"`
// The operator used to combine multiple dimensions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggercondition.html#cfn-customerprofiles-eventtrigger-eventtriggercondition-logicaloperator
//
LogicalOperator *string `field:"required" json:"logicalOperator" yaml:"logicalOperator"`
}
Specifies the circumstances under which the event should trigger the destination.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eventTriggerConditionProperty := &EventTriggerConditionProperty{
EventTriggerDimensions: []interface{}{
&EventTriggerDimensionProperty{
ObjectAttributes: []interface{}{
&ObjectAttributeProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
FieldName: jsii.String("fieldName"),
Source: jsii.String("source"),
},
},
},
},
LogicalOperator: jsii.String("logicalOperator"),
}
type CfnEventTrigger_EventTriggerDimensionProperty ¶ added in v2.176.0
type CfnEventTrigger_EventTriggerDimensionProperty struct {
// A list of object attributes to be evaluated.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerdimension.html#cfn-customerprofiles-eventtrigger-eventtriggerdimension-objectattributes
//
ObjectAttributes interface{} `field:"required" json:"objectAttributes" yaml:"objectAttributes"`
}
A specific event dimension to be assessed.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eventTriggerDimensionProperty := &EventTriggerDimensionProperty{
ObjectAttributes: []interface{}{
&ObjectAttributeProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
FieldName: jsii.String("fieldName"),
Source: jsii.String("source"),
},
},
}
type CfnEventTrigger_EventTriggerLimitsProperty ¶ added in v2.176.0
type CfnEventTrigger_EventTriggerLimitsProperty struct {
// Specifies that an event will only trigger the destination if it is processed within a certain latency period.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits-eventexpiration
//
EventExpiration *float64 `field:"optional" json:"eventExpiration" yaml:"eventExpiration"`
// A list of time periods during which the limits apply.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-eventtriggerlimits.html#cfn-customerprofiles-eventtrigger-eventtriggerlimits-periods
//
Periods interface{} `field:"optional" json:"periods" yaml:"periods"`
}
Defines limits controlling whether an event triggers the destination, based on ingestion latency and the number of invocations per profile over specific time periods.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eventTriggerLimitsProperty := &EventTriggerLimitsProperty{
EventExpiration: jsii.Number(123),
Periods: []interface{}{
&PeriodProperty{
Unit: jsii.String("unit"),
Value: jsii.Number(123),
// the properties below are optional
MaxInvocationsPerProfile: jsii.Number(123),
Unlimited: jsii.Boolean(false),
},
},
}
type CfnEventTrigger_ObjectAttributeProperty ¶ added in v2.176.0
type CfnEventTrigger_ObjectAttributeProperty struct {
// The operator used to compare an attribute against a list of values.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-comparisonoperator
//
ComparisonOperator *string `field:"required" json:"comparisonOperator" yaml:"comparisonOperator"`
// The amount of time of the specified unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
// A field defined within an object type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-fieldname
//
FieldName *string `field:"optional" json:"fieldName" yaml:"fieldName"`
// An attribute contained within a source object.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-objectattribute.html#cfn-customerprofiles-eventtrigger-objectattribute-source
//
Source *string `field:"optional" json:"source" yaml:"source"`
}
The criteria that a specific object attribute must meet to trigger the destination.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
objectAttributeProperty := &ObjectAttributeProperty{
ComparisonOperator: jsii.String("comparisonOperator"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
FieldName: jsii.String("fieldName"),
Source: jsii.String("source"),
}
type CfnEventTrigger_PeriodProperty ¶ added in v2.176.0
type CfnEventTrigger_PeriodProperty struct {
// The unit of time.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unit
//
Unit *string `field:"required" json:"unit" yaml:"unit"`
// The amount of time of the specified unit.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-value
//
Value *float64 `field:"required" json:"value" yaml:"value"`
// The maximum allowed number of destination invocations per profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-maxinvocationsperprofile
//
MaxInvocationsPerProfile *float64 `field:"optional" json:"maxInvocationsPerProfile" yaml:"maxInvocationsPerProfile"`
// If set to true, there is no limit on the number of destination invocations per profile.
//
// The default is false.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-eventtrigger-period.html#cfn-customerprofiles-eventtrigger-period-unlimited
//
Unlimited interface{} `field:"optional" json:"unlimited" yaml:"unlimited"`
}
Defines a limit and the time period during which it is enforced.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
periodProperty := &PeriodProperty{
Unit: jsii.String("unit"),
Value: jsii.Number(123),
// the properties below are optional
MaxInvocationsPerProfile: jsii.Number(123),
Unlimited: jsii.Boolean(false),
}
type CfnIntegration ¶
type CfnIntegration interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IIntegrationRef
awscdk.ITaggable
// The timestamp of when the integration was created.
AttrCreatedAt() *string
// The timestamp of when the integration was most recently edited.
AttrLastUpdatedAt() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// A list of unique names for active event triggers associated with the integration.
EventTriggerNames() *[]*string
SetEventTriggerNames(val *[]*string)
// The configuration that controls how Customer Profiles retrieves data from the source.
FlowDefinition() interface{}
SetFlowDefinition(val interface{})
// A reference to a Integration resource.
IntegrationRef() *interfacesawscustomerprofiles.IntegrationReference
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The name of the profile object type mapping to use.
ObjectTypeName() *string
SetObjectTypeName(val *string)
// The object type mapping.
ObjectTypeNames() interface{}
SetObjectTypeNames(val interface{})
// 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 })`.
Ref() *string
// Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
Scope() *string
SetScope(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags used to organize, track, or control access for this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The URI of the S3 bucket or any other type of data source.
Uri() *string
SetUri(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Specifies an Amazon Connect Customer Profiles Integration.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIntegration := awscdk.Aws_customerprofiles.NewCfnIntegration(this, jsii.String("MyCfnIntegration"), &CfnIntegrationProps{
DomainName: jsii.String("domainName"),
// the properties below are optional
EventTriggerNames: []*string{
jsii.String("eventTriggerNames"),
},
FlowDefinition: &FlowDefinitionProperty{
FlowName: jsii.String("flowName"),
KmsArn: jsii.String("kmsArn"),
SourceFlowConfig: &SourceFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
SourceConnectorProperties: &SourceConnectorPropertiesProperty{
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
},
// the properties below are optional
ConnectorProfileName: jsii.String("connectorProfileName"),
IncrementalPullConfig: &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
},
},
Tasks: []interface{}{
&TaskProperty{
SourceFields: []*string{
jsii.String("sourceFields"),
},
TaskType: jsii.String("taskType"),
// the properties below are optional
ConnectorOperator: &ConnectorOperatorProperty{
Marketo: jsii.String("marketo"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
ServiceNow: jsii.String("serviceNow"),
Zendesk: jsii.String("zendesk"),
},
DestinationField: jsii.String("destinationField"),
TaskProperties: []interface{}{
&TaskPropertiesMapProperty{
OperatorPropertyKey: jsii.String("operatorPropertyKey"),
Property: jsii.String("property"),
},
},
},
},
TriggerConfig: &TriggerConfigProperty{
TriggerType: jsii.String("triggerType"),
// the properties below are optional
TriggerProperties: &TriggerPropertiesProperty{
Scheduled: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
},
},
},
// the properties below are optional
Description: jsii.String("description"),
},
ObjectTypeName: jsii.String("objectTypeName"),
ObjectTypeNames: []interface{}{
&ObjectTypeMappingProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Scope: jsii.String("scope"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Uri: jsii.String("uri"),
})
func NewCfnIntegration ¶
func NewCfnIntegration(scope constructs.Construct, id *string, props *CfnIntegrationProps) CfnIntegration
Create a new `AWS::CustomerProfiles::Integration`.
type CfnIntegrationProps ¶
type CfnIntegrationProps struct {
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// A list of unique names for active event triggers associated with the integration.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-eventtriggernames
//
EventTriggerNames *[]*string `field:"optional" json:"eventTriggerNames" yaml:"eventTriggerNames"`
// The configuration that controls how Customer Profiles retrieves data from the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-flowdefinition
//
FlowDefinition interface{} `field:"optional" json:"flowDefinition" yaml:"flowDefinition"`
// The name of the profile object type mapping to use.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypename
//
ObjectTypeName *string `field:"optional" json:"objectTypeName" yaml:"objectTypeName"`
// The object type mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-objecttypenames
//
ObjectTypeNames interface{} `field:"optional" json:"objectTypeNames" yaml:"objectTypeNames"`
// Scope of the integration, such as 'PROFILE' or 'DOMAIN'.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-scope
//
Scope *string `field:"optional" json:"scope" yaml:"scope"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The URI of the S3 bucket or any other type of data source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-integration.html#cfn-customerprofiles-integration-uri
//
Uri *string `field:"optional" json:"uri" yaml:"uri"`
}
Properties for defining a `CfnIntegration`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnIntegrationProps := &CfnIntegrationProps{
DomainName: jsii.String("domainName"),
// the properties below are optional
EventTriggerNames: []*string{
jsii.String("eventTriggerNames"),
},
FlowDefinition: &FlowDefinitionProperty{
FlowName: jsii.String("flowName"),
KmsArn: jsii.String("kmsArn"),
SourceFlowConfig: &SourceFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
SourceConnectorProperties: &SourceConnectorPropertiesProperty{
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
},
// the properties below are optional
ConnectorProfileName: jsii.String("connectorProfileName"),
IncrementalPullConfig: &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
},
},
Tasks: []interface{}{
&TaskProperty{
SourceFields: []*string{
jsii.String("sourceFields"),
},
TaskType: jsii.String("taskType"),
// the properties below are optional
ConnectorOperator: &ConnectorOperatorProperty{
Marketo: jsii.String("marketo"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
ServiceNow: jsii.String("serviceNow"),
Zendesk: jsii.String("zendesk"),
},
DestinationField: jsii.String("destinationField"),
TaskProperties: []interface{}{
&TaskPropertiesMapProperty{
OperatorPropertyKey: jsii.String("operatorPropertyKey"),
Property: jsii.String("property"),
},
},
},
},
TriggerConfig: &TriggerConfigProperty{
TriggerType: jsii.String("triggerType"),
// the properties below are optional
TriggerProperties: &TriggerPropertiesProperty{
Scheduled: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
},
},
},
// the properties below are optional
Description: jsii.String("description"),
},
ObjectTypeName: jsii.String("objectTypeName"),
ObjectTypeNames: []interface{}{
&ObjectTypeMappingProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Scope: jsii.String("scope"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
Uri: jsii.String("uri"),
}
type CfnIntegration_ConnectorOperatorProperty ¶
type CfnIntegration_ConnectorOperatorProperty struct {
// The operation to be performed on the provided Marketo source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-marketo
//
Marketo *string `field:"optional" json:"marketo" yaml:"marketo"`
// The operation to be performed on the provided Amazon S3 source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-s3
//
S3 *string `field:"optional" json:"s3" yaml:"s3"`
// The operation to be performed on the provided Salesforce source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-salesforce
//
Salesforce *string `field:"optional" json:"salesforce" yaml:"salesforce"`
// The operation to be performed on the provided ServiceNow source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-servicenow
//
ServiceNow *string `field:"optional" json:"serviceNow" yaml:"serviceNow"`
// The operation to be performed on the provided Zendesk source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-connectoroperator.html#cfn-customerprofiles-integration-connectoroperator-zendesk
//
Zendesk *string `field:"optional" json:"zendesk" yaml:"zendesk"`
}
The operation to be performed on the provided source fields.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
connectorOperatorProperty := &ConnectorOperatorProperty{
Marketo: jsii.String("marketo"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
ServiceNow: jsii.String("serviceNow"),
Zendesk: jsii.String("zendesk"),
}
type CfnIntegration_FlowDefinitionProperty ¶
type CfnIntegration_FlowDefinitionProperty struct {
// The specified name of the flow.
//
// Use underscores (_) or hyphens (-) only. Spaces are not allowed.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-flowname
//
FlowName *string `field:"required" json:"flowName" yaml:"flowName"`
// The Amazon Resource Name (ARN) of the AWS Key Management Service (KMS) key you provide for encryption.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-kmsarn
//
KmsArn *string `field:"required" json:"kmsArn" yaml:"kmsArn"`
// The configuration that controls how Customer Profiles retrieves data from the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-sourceflowconfig
//
SourceFlowConfig interface{} `field:"required" json:"sourceFlowConfig" yaml:"sourceFlowConfig"`
// A list of tasks that Customer Profiles performs while transferring the data in the flow run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-tasks
//
Tasks interface{} `field:"required" json:"tasks" yaml:"tasks"`
// The trigger settings that determine how and when the flow runs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-triggerconfig
//
TriggerConfig interface{} `field:"required" json:"triggerConfig" yaml:"triggerConfig"`
// A description of the flow you want to create.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-flowdefinition.html#cfn-customerprofiles-integration-flowdefinition-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
}
The configurations that control how Customer Profiles retrieves data from the source, Amazon AppFlow.
Customer Profiles uses this information to create an AppFlow flow on behalf of customers.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
flowDefinitionProperty := &FlowDefinitionProperty{
FlowName: jsii.String("flowName"),
KmsArn: jsii.String("kmsArn"),
SourceFlowConfig: &SourceFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
SourceConnectorProperties: &SourceConnectorPropertiesProperty{
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
},
// the properties below are optional
ConnectorProfileName: jsii.String("connectorProfileName"),
IncrementalPullConfig: &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
},
},
Tasks: []interface{}{
&TaskProperty{
SourceFields: []*string{
jsii.String("sourceFields"),
},
TaskType: jsii.String("taskType"),
// the properties below are optional
ConnectorOperator: &ConnectorOperatorProperty{
Marketo: jsii.String("marketo"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
ServiceNow: jsii.String("serviceNow"),
Zendesk: jsii.String("zendesk"),
},
DestinationField: jsii.String("destinationField"),
TaskProperties: []interface{}{
&TaskPropertiesMapProperty{
OperatorPropertyKey: jsii.String("operatorPropertyKey"),
Property: jsii.String("property"),
},
},
},
},
TriggerConfig: &TriggerConfigProperty{
TriggerType: jsii.String("triggerType"),
// the properties below are optional
TriggerProperties: &TriggerPropertiesProperty{
Scheduled: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
},
},
},
// the properties below are optional
Description: jsii.String("description"),
}
type CfnIntegration_IncrementalPullConfigProperty ¶
type CfnIntegration_IncrementalPullConfigProperty struct {
// A field that specifies the date time or timestamp field as the criteria to use when importing incremental records from the source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-incrementalpullconfig.html#cfn-customerprofiles-integration-incrementalpullconfig-datetimetypefieldname
//
DatetimeTypeFieldName *string `field:"optional" json:"datetimeTypeFieldName" yaml:"datetimeTypeFieldName"`
}
Specifies the configuration used when importing incremental records from the source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
incrementalPullConfigProperty := &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
}
type CfnIntegration_MarketoSourcePropertiesProperty ¶
type CfnIntegration_MarketoSourcePropertiesProperty struct {
// The object specified in the Marketo flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-marketosourceproperties.html#cfn-customerprofiles-integration-marketosourceproperties-object
//
Object *string `field:"required" json:"object" yaml:"object"`
}
The properties that are applied when Marketo is being used as a source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
marketoSourcePropertiesProperty := &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
}
type CfnIntegration_ObjectTypeMappingProperty ¶ added in v2.13.0
type CfnIntegration_ObjectTypeMappingProperty struct {
// The key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// The value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-objecttypemapping.html#cfn-customerprofiles-integration-objecttypemapping-value
//
Value *string `field:"required" json:"value" yaml:"value"`
}
A map in which each key is an event type from an external application such as Segment or Shopify, and each value is an `ObjectTypeName` (template) used to ingest the event.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
objectTypeMappingProperty := &ObjectTypeMappingProperty{
Key: jsii.String("key"),
Value: jsii.String("value"),
}
type CfnIntegration_S3SourcePropertiesProperty ¶
type CfnIntegration_S3SourcePropertiesProperty struct {
// The Amazon S3 bucket name where the source files are stored.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketname
//
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
// The object key for the Amazon S3 bucket in which the source files are stored.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-s3sourceproperties.html#cfn-customerprofiles-integration-s3sourceproperties-bucketprefix
//
BucketPrefix *string `field:"optional" json:"bucketPrefix" yaml:"bucketPrefix"`
}
The properties that are applied when Amazon S3 is being used as the flow source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3SourcePropertiesProperty := &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
}
type CfnIntegration_SalesforceSourcePropertiesProperty ¶
type CfnIntegration_SalesforceSourcePropertiesProperty struct {
// The object specified in the Salesforce flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-object
//
Object *string `field:"required" json:"object" yaml:"object"`
// The flag that enables dynamic fetching of new (recently added) fields in the Salesforce objects while running a flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-enabledynamicfieldupdate
//
EnableDynamicFieldUpdate interface{} `field:"optional" json:"enableDynamicFieldUpdate" yaml:"enableDynamicFieldUpdate"`
// Indicates whether Amazon AppFlow includes deleted files in the flow run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-salesforcesourceproperties.html#cfn-customerprofiles-integration-salesforcesourceproperties-includedeletedrecords
//
IncludeDeletedRecords interface{} `field:"optional" json:"includeDeletedRecords" yaml:"includeDeletedRecords"`
}
The properties that are applied when Salesforce is being used as a source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
salesforceSourcePropertiesProperty := &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
}
type CfnIntegration_ScheduledTriggerPropertiesProperty ¶
type CfnIntegration_ScheduledTriggerPropertiesProperty struct {
// The scheduling expression that determines the rate at which the schedule will run, for example rate (5 minutes).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleexpression
//
ScheduleExpression *string `field:"required" json:"scheduleExpression" yaml:"scheduleExpression"`
// Specifies whether a scheduled flow has an incremental data transfer or a complete data transfer for each flow run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-datapullmode
//
DataPullMode *string `field:"optional" json:"dataPullMode" yaml:"dataPullMode"`
// Specifies the date range for the records to import from the connector in the first flow run.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-firstexecutionfrom
//
FirstExecutionFrom *float64 `field:"optional" json:"firstExecutionFrom" yaml:"firstExecutionFrom"`
// Specifies the scheduled end time for a scheduled-trigger flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleendtime
//
ScheduleEndTime *float64 `field:"optional" json:"scheduleEndTime" yaml:"scheduleEndTime"`
// Specifies the optional offset that is added to the time interval for a schedule-triggered flow.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-scheduleoffset
//
ScheduleOffset *float64 `field:"optional" json:"scheduleOffset" yaml:"scheduleOffset"`
// Specifies the scheduled start time for a scheduled-trigger flow.
//
// The value must be a date/time value in EPOCH format.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-schedulestarttime
//
ScheduleStartTime *float64 `field:"optional" json:"scheduleStartTime" yaml:"scheduleStartTime"`
// Specifies the time zone used when referring to the date and time of a scheduled-triggered flow, such as America/New_York.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-scheduledtriggerproperties.html#cfn-customerprofiles-integration-scheduledtriggerproperties-timezone
//
Timezone *string `field:"optional" json:"timezone" yaml:"timezone"`
}
Specifies the configuration details of a scheduled-trigger flow that you define.
Currently, these settings only apply to the scheduled-trigger type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
scheduledTriggerPropertiesProperty := &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
}
type CfnIntegration_ServiceNowSourcePropertiesProperty ¶
type CfnIntegration_ServiceNowSourcePropertiesProperty struct {
// The object specified in the ServiceNow flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-servicenowsourceproperties.html#cfn-customerprofiles-integration-servicenowsourceproperties-object
//
Object *string `field:"required" json:"object" yaml:"object"`
}
The properties that are applied when ServiceNow is being used as a source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
serviceNowSourcePropertiesProperty := &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
}
type CfnIntegration_SourceConnectorPropertiesProperty ¶
type CfnIntegration_SourceConnectorPropertiesProperty struct {
// The properties that are applied when Marketo is being used as a source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-marketo
//
Marketo interface{} `field:"optional" json:"marketo" yaml:"marketo"`
// The properties that are applied when Amazon S3 is being used as the flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
// The properties that are applied when Salesforce is being used as a source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-salesforce
//
Salesforce interface{} `field:"optional" json:"salesforce" yaml:"salesforce"`
// The properties that are applied when ServiceNow is being used as a source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-servicenow
//
ServiceNow interface{} `field:"optional" json:"serviceNow" yaml:"serviceNow"`
// The properties that are applied when using Zendesk as a flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceconnectorproperties.html#cfn-customerprofiles-integration-sourceconnectorproperties-zendesk
//
Zendesk interface{} `field:"optional" json:"zendesk" yaml:"zendesk"`
}
Specifies the information that is required to query a particular Amazon AppFlow connector.
Customer Profiles supports Salesforce, Zendesk, Marketo, ServiceNow and Amazon S3.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sourceConnectorPropertiesProperty := &SourceConnectorPropertiesProperty{
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
}
type CfnIntegration_SourceFlowConfigProperty ¶
type CfnIntegration_SourceFlowConfigProperty struct {
// The type of connector, such as Salesforce, Marketo, and so on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectortype
//
ConnectorType *string `field:"required" json:"connectorType" yaml:"connectorType"`
// Specifies the information that is required to query a particular source connector.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-sourceconnectorproperties
//
SourceConnectorProperties interface{} `field:"required" json:"sourceConnectorProperties" yaml:"sourceConnectorProperties"`
// The name of the Amazon AppFlow connector profile.
//
// This name must be unique for each connector profile in the AWS account .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-connectorprofilename
//
ConnectorProfileName *string `field:"optional" json:"connectorProfileName" yaml:"connectorProfileName"`
// Defines the configuration for a scheduled incremental data pull.
//
// If a valid configuration is provided, the fields specified in the configuration are used when querying for the incremental data pull.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-sourceflowconfig.html#cfn-customerprofiles-integration-sourceflowconfig-incrementalpullconfig
//
IncrementalPullConfig interface{} `field:"optional" json:"incrementalPullConfig" yaml:"incrementalPullConfig"`
}
The configuration that controls how Customer Profiles retrieves data from the source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sourceFlowConfigProperty := &SourceFlowConfigProperty{
ConnectorType: jsii.String("connectorType"),
SourceConnectorProperties: &SourceConnectorPropertiesProperty{
Marketo: &MarketoSourcePropertiesProperty{
Object: jsii.String("object"),
},
S3: &S3SourcePropertiesProperty{
BucketName: jsii.String("bucketName"),
// the properties below are optional
BucketPrefix: jsii.String("bucketPrefix"),
},
Salesforce: &SalesforceSourcePropertiesProperty{
Object: jsii.String("object"),
// the properties below are optional
EnableDynamicFieldUpdate: jsii.Boolean(false),
IncludeDeletedRecords: jsii.Boolean(false),
},
ServiceNow: &ServiceNowSourcePropertiesProperty{
Object: jsii.String("object"),
},
Zendesk: &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
},
},
// the properties below are optional
ConnectorProfileName: jsii.String("connectorProfileName"),
IncrementalPullConfig: &IncrementalPullConfigProperty{
DatetimeTypeFieldName: jsii.String("datetimeTypeFieldName"),
},
}
type CfnIntegration_TaskPropertiesMapProperty ¶
type CfnIntegration_TaskPropertiesMapProperty struct {
// The task property key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-operatorpropertykey
//
OperatorPropertyKey *string `field:"required" json:"operatorPropertyKey" yaml:"operatorPropertyKey"`
// The task property value.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-taskpropertiesmap.html#cfn-customerprofiles-integration-taskpropertiesmap-property
//
Property *string `field:"required" json:"property" yaml:"property"`
}
A map used to store task-related information.
The execution service looks for particular information based on the `TaskType` .
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
taskPropertiesMapProperty := &TaskPropertiesMapProperty{
OperatorPropertyKey: jsii.String("operatorPropertyKey"),
Property: jsii.String("property"),
}
type CfnIntegration_TaskProperty ¶
type CfnIntegration_TaskProperty struct {
// The source fields to which a particular task is applied.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-sourcefields
//
SourceFields *[]*string `field:"required" json:"sourceFields" yaml:"sourceFields"`
// Specifies the particular task implementation that Amazon AppFlow performs.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-tasktype
//
TaskType *string `field:"required" json:"taskType" yaml:"taskType"`
// The operation to be performed on the provided source fields.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-connectoroperator
//
ConnectorOperator interface{} `field:"optional" json:"connectorOperator" yaml:"connectorOperator"`
// A field in a destination connector, or a field value against which Amazon AppFlow validates a source field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-destinationfield
//
DestinationField *string `field:"optional" json:"destinationField" yaml:"destinationField"`
// A map used to store task-related information.
//
// The service looks for particular information based on the TaskType.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-task.html#cfn-customerprofiles-integration-task-taskproperties
//
TaskProperties interface{} `field:"optional" json:"taskProperties" yaml:"taskProperties"`
}
The `Task` property type specifies the class for modeling different type of tasks.
Task implementation varies based on the TaskType.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
taskProperty := &TaskProperty{
SourceFields: []*string{
jsii.String("sourceFields"),
},
TaskType: jsii.String("taskType"),
// the properties below are optional
ConnectorOperator: &ConnectorOperatorProperty{
Marketo: jsii.String("marketo"),
S3: jsii.String("s3"),
Salesforce: jsii.String("salesforce"),
ServiceNow: jsii.String("serviceNow"),
Zendesk: jsii.String("zendesk"),
},
DestinationField: jsii.String("destinationField"),
TaskProperties: []interface{}{
&TaskPropertiesMapProperty{
OperatorPropertyKey: jsii.String("operatorPropertyKey"),
Property: jsii.String("property"),
},
},
}
type CfnIntegration_TriggerConfigProperty ¶
type CfnIntegration_TriggerConfigProperty struct {
// Specifies the type of flow trigger.
//
// It can be OnDemand, Scheduled, or Event.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggertype
//
TriggerType *string `field:"required" json:"triggerType" yaml:"triggerType"`
// Specifies the configuration details of a schedule-triggered flow that you define.
//
// Currently, these settings only apply to the Scheduled trigger type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerconfig.html#cfn-customerprofiles-integration-triggerconfig-triggerproperties
//
TriggerProperties interface{} `field:"optional" json:"triggerProperties" yaml:"triggerProperties"`
}
The trigger settings that determine how and when Amazon AppFlow runs the specified flow.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
triggerConfigProperty := &TriggerConfigProperty{
TriggerType: jsii.String("triggerType"),
// the properties below are optional
TriggerProperties: &TriggerPropertiesProperty{
Scheduled: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
},
},
}
type CfnIntegration_TriggerPropertiesProperty ¶
type CfnIntegration_TriggerPropertiesProperty struct {
// Specifies the configuration details of a schedule-triggered flow that you define.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-triggerproperties.html#cfn-customerprofiles-integration-triggerproperties-scheduled
//
Scheduled interface{} `field:"optional" json:"scheduled" yaml:"scheduled"`
}
Specifies the configuration details that control the trigger for a flow.
Currently, these settings only apply to the Scheduled trigger type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
triggerPropertiesProperty := &TriggerPropertiesProperty{
Scheduled: &ScheduledTriggerPropertiesProperty{
ScheduleExpression: jsii.String("scheduleExpression"),
// the properties below are optional
DataPullMode: jsii.String("dataPullMode"),
FirstExecutionFrom: jsii.Number(123),
ScheduleEndTime: jsii.Number(123),
ScheduleOffset: jsii.Number(123),
ScheduleStartTime: jsii.Number(123),
Timezone: jsii.String("timezone"),
},
}
type CfnIntegration_ZendeskSourcePropertiesProperty ¶
type CfnIntegration_ZendeskSourcePropertiesProperty struct {
// The object specified in the Zendesk flow source.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-integration-zendesksourceproperties.html#cfn-customerprofiles-integration-zendesksourceproperties-object
//
Object *string `field:"required" json:"object" yaml:"object"`
}
The properties that are applied when using Zendesk as a flow source.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
zendeskSourcePropertiesProperty := &ZendeskSourcePropertiesProperty{
Object: jsii.String("object"),
}
type CfnObjectType ¶
type CfnObjectType interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IObjectTypeRef
awscdk.ITaggable
// Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
AllowProfileCreation() interface{}
SetAllowProfileCreation(val interface{})
// The timestamp of when the object type was created.
AttrCreatedAt() *string
// The timestamp of when the object type was most recently edited.
AttrLastUpdatedAt() *string
// The amount of provisioned profile object max count available.
AttrMaxAvailableProfileObjectCount() *float64
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the profile object type mapping.
Description() *string
SetDescription(val *string)
// The unique name of the domain.
DomainName() *string
SetDomainName(val *string)
// The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
EncryptionKey() *string
SetEncryptionKey(val *string)
Env() *interfaces.ResourceEnvironment
// The number of days until the data of this type expires.
ExpirationDays() *float64
SetExpirationDays(val *float64)
// A list of field definitions for the object type mapping.
Fields() interface{}
SetFields(val interface{})
// A list of keys that can be used to map data to the profile or search for the profile.
Keys() interface{}
SetKeys(val interface{})
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The amount of profile object max count assigned to the object type.
MaxProfileObjectCount() *float64
SetMaxProfileObjectCount(val *float64)
// The tree node.
Node() constructs.Node
// The name of the profile object type.
ObjectTypeName() *string
SetObjectTypeName(val *string)
// A reference to a ObjectType resource.
ObjectTypeRef() *interfacesawscustomerprofiles.ObjectTypeReference
// 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 })`.
Ref() *string
// The format of your sourceLastUpdatedTimestamp that was previously set up.
SourceLastUpdatedTimestampFormat() *string
SetSourceLastUpdatedTimestampFormat(val *string)
// Defines the priority order of object types.
SourcePriority() *float64
SetSourcePriority(val *float64)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// The tags used to organize, track, or control access for this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// A unique identifier for the template mapping.
TemplateId() *string
SetTemplateId(val *string)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Specifies an Amazon Connect Customer Profiles Object Type Mapping.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnObjectType := awscdk.Aws_customerprofiles.NewCfnObjectType(this, jsii.String("MyCfnObjectType"), &CfnObjectTypeProps{
Description: jsii.String("description"),
DomainName: jsii.String("domainName"),
ObjectTypeName: jsii.String("objectTypeName"),
// the properties below are optional
AllowProfileCreation: jsii.Boolean(false),
EncryptionKey: jsii.String("encryptionKey"),
ExpirationDays: jsii.Number(123),
Fields: []interface{}{
&FieldMapProperty{
Name: jsii.String("name"),
ObjectTypeField: &ObjectTypeFieldProperty{
ContentType: jsii.String("contentType"),
Source: jsii.String("source"),
Target: jsii.String("target"),
},
},
},
Keys: []interface{}{
&KeyMapProperty{
Name: jsii.String("name"),
ObjectTypeKeyList: []interface{}{
&ObjectTypeKeyProperty{
FieldNames: []*string{
jsii.String("fieldNames"),
},
StandardIdentifiers: []*string{
jsii.String("standardIdentifiers"),
},
},
},
},
},
MaxProfileObjectCount: jsii.Number(123),
SourceLastUpdatedTimestampFormat: jsii.String("sourceLastUpdatedTimestampFormat"),
SourcePriority: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateId: jsii.String("templateId"),
})
func NewCfnObjectType ¶
func NewCfnObjectType(scope constructs.Construct, id *string, props *CfnObjectTypeProps) CfnObjectType
Create a new `AWS::CustomerProfiles::ObjectType`.
type CfnObjectTypeProps ¶
type CfnObjectTypeProps struct {
// The description of the profile object type mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-description
//
Description *string `field:"required" json:"description" yaml:"description"`
// The unique name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// The name of the profile object type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-objecttypename
//
ObjectTypeName *string `field:"required" json:"objectTypeName" yaml:"objectTypeName"`
// Indicates whether a profile should be created when data is received if one doesn’t exist for an object of this type.
//
// The default is `FALSE` . If the AllowProfileCreation flag is set to `FALSE` , then the service tries to fetch a standard profile and associate this object with the profile. If it is set to `TRUE` , and if no match is found, then the service creates a new standard profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-allowprofilecreation
//
AllowProfileCreation interface{} `field:"optional" json:"allowProfileCreation" yaml:"allowProfileCreation"`
// The customer-provided key to encrypt the profile object that will be created in this profile object type mapping.
//
// If not specified the system will use the encryption key of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-encryptionkey
//
EncryptionKey *string `field:"optional" json:"encryptionKey" yaml:"encryptionKey"`
// The number of days until the data of this type expires.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-expirationdays
//
ExpirationDays *float64 `field:"optional" json:"expirationDays" yaml:"expirationDays"`
// A list of field definitions for the object type mapping.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-fields
//
Fields interface{} `field:"optional" json:"fields" yaml:"fields"`
// A list of keys that can be used to map data to the profile or search for the profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-keys
//
Keys interface{} `field:"optional" json:"keys" yaml:"keys"`
// The amount of profile object max count assigned to the object type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-maxprofileobjectcount
//
MaxProfileObjectCount *float64 `field:"optional" json:"maxProfileObjectCount" yaml:"maxProfileObjectCount"`
// The format of your sourceLastUpdatedTimestamp that was previously set up.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-sourcelastupdatedtimestampformat
//
SourceLastUpdatedTimestampFormat *string `field:"optional" json:"sourceLastUpdatedTimestampFormat" yaml:"sourceLastUpdatedTimestampFormat"`
// Defines the priority order of object types.
//
// Lower value indicates higher priority.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-sourcepriority
//
SourcePriority *float64 `field:"optional" json:"sourcePriority" yaml:"sourcePriority"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// A unique identifier for the template mapping.
//
// This can be used instead of specifying the Keys and Fields properties directly.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-objecttype.html#cfn-customerprofiles-objecttype-templateid
//
TemplateId *string `field:"optional" json:"templateId" yaml:"templateId"`
}
Properties for defining a `CfnObjectType`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnObjectTypeProps := &CfnObjectTypeProps{
Description: jsii.String("description"),
DomainName: jsii.String("domainName"),
ObjectTypeName: jsii.String("objectTypeName"),
// the properties below are optional
AllowProfileCreation: jsii.Boolean(false),
EncryptionKey: jsii.String("encryptionKey"),
ExpirationDays: jsii.Number(123),
Fields: []interface{}{
&FieldMapProperty{
Name: jsii.String("name"),
ObjectTypeField: &ObjectTypeFieldProperty{
ContentType: jsii.String("contentType"),
Source: jsii.String("source"),
Target: jsii.String("target"),
},
},
},
Keys: []interface{}{
&KeyMapProperty{
Name: jsii.String("name"),
ObjectTypeKeyList: []interface{}{
&ObjectTypeKeyProperty{
FieldNames: []*string{
jsii.String("fieldNames"),
},
StandardIdentifiers: []*string{
jsii.String("standardIdentifiers"),
},
},
},
},
},
MaxProfileObjectCount: jsii.Number(123),
SourceLastUpdatedTimestampFormat: jsii.String("sourceLastUpdatedTimestampFormat"),
SourcePriority: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TemplateId: jsii.String("templateId"),
}
type CfnObjectType_FieldMapProperty ¶
type CfnObjectType_FieldMapProperty struct {
// Name of the field.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// Represents a field in a ProfileObjectType.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-fieldmap.html#cfn-customerprofiles-objecttype-fieldmap-objecttypefield
//
ObjectTypeField interface{} `field:"optional" json:"objectTypeField" yaml:"objectTypeField"`
}
A map of the name and ObjectType field.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
fieldMapProperty := &FieldMapProperty{
Name: jsii.String("name"),
ObjectTypeField: &ObjectTypeFieldProperty{
ContentType: jsii.String("contentType"),
Source: jsii.String("source"),
Target: jsii.String("target"),
},
}
type CfnObjectType_KeyMapProperty ¶
type CfnObjectType_KeyMapProperty struct {
// Name of the key.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-name
//
Name *string `field:"optional" json:"name" yaml:"name"`
// A list of ObjectTypeKey.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-keymap.html#cfn-customerprofiles-objecttype-keymap-objecttypekeylist
//
ObjectTypeKeyList interface{} `field:"optional" json:"objectTypeKeyList" yaml:"objectTypeKeyList"`
}
A unique key map that can be used to map data to the profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
keyMapProperty := &KeyMapProperty{
Name: jsii.String("name"),
ObjectTypeKeyList: []interface{}{
&ObjectTypeKeyProperty{
FieldNames: []*string{
jsii.String("fieldNames"),
},
StandardIdentifiers: []*string{
jsii.String("standardIdentifiers"),
},
},
},
}
type CfnObjectType_ObjectTypeFieldProperty ¶
type CfnObjectType_ObjectTypeFieldProperty struct {
// The content type of the field.
//
// Used for determining equality when searching.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-contenttype
//
ContentType *string `field:"optional" json:"contentType" yaml:"contentType"`
// A field of a ProfileObject.
//
// For example: _source.FirstName, where “_source” is a ProfileObjectType of a Zendesk user and “FirstName” is a field in that ObjectType.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-source
//
Source *string `field:"optional" json:"source" yaml:"source"`
// The location of the data in the standard ProfileObject model.
//
// For example: _profile.Address.PostalCode.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypefield.html#cfn-customerprofiles-objecttype-objecttypefield-target
//
Target *string `field:"optional" json:"target" yaml:"target"`
}
Represents a field in a ProfileObjectType.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
objectTypeFieldProperty := &ObjectTypeFieldProperty{
ContentType: jsii.String("contentType"),
Source: jsii.String("source"),
Target: jsii.String("target"),
}
type CfnObjectType_ObjectTypeKeyProperty ¶
type CfnObjectType_ObjectTypeKeyProperty struct {
// The reference for the key name of the fields map.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-fieldnames
//
FieldNames *[]*string `field:"optional" json:"fieldNames" yaml:"fieldNames"`
// 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.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-objecttype-objecttypekey.html#cfn-customerprofiles-objecttype-objecttypekey-standardidentifiers
//
StandardIdentifiers *[]*string `field:"optional" json:"standardIdentifiers" yaml:"standardIdentifiers"`
}
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.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
objectTypeKeyProperty := &ObjectTypeKeyProperty{
FieldNames: []*string{
jsii.String("fieldNames"),
},
StandardIdentifiers: []*string{
jsii.String("standardIdentifiers"),
},
}
type CfnRecommender ¶ added in v2.247.0
type CfnRecommender interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.IRecommenderRef
awscdk.ITaggableV2
// The timestamp of when the recommender was created.
AttrCreatedAt() *string
// The reason for recommender failure.
AttrFailureReason() *string
// The timestamp of when the recommender was last updated.
AttrLastUpdatedAt() *string
// Information about the latest recommender update.
AttrLatestRecommenderUpdate() awscdk.IResolvable
// The Amazon Resource Name (ARN) of the recommender.
AttrRecommenderArn() *string
// The status of the recommender.
AttrStatus() *string
AttrTrainingMetrics() awscdk.IResolvable
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the recommender.
Description() *string
SetDescription(val *string)
// The name of the domain for which the recommender will be created.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Configuration for the recommender.
RecommenderConfig() interface{}
SetRecommenderConfig(val interface{})
// The name of the recommender.
RecommenderName() *string
SetRecommenderName(val *string)
// The name of the recommender recipe.
RecommenderRecipeName() *string
SetRecommenderRecipeName(val *string)
// A reference to a Recommender resource.
RecommenderRef() *interfacesawscustomerprofiles.RecommenderReference
// 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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags used to organize, track, or control access for this resource.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Resource Type definition for AWS::CustomerProfiles::Recommender.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRecommender := awscdk.Aws_customerprofiles.NewCfnRecommender(this, jsii.String("MyCfnRecommender"), &CfnRecommenderProps{
DomainName: jsii.String("domainName"),
RecommenderName: jsii.String("recommenderName"),
RecommenderRecipeName: jsii.String("recommenderRecipeName"),
// the properties below are optional
Description: jsii.String("description"),
RecommenderConfig: &RecommenderConfigProperty{
EventsConfig: &EventsConfigProperty{
EventParametersList: []interface{}{
&EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnRecommender ¶ added in v2.247.0
func NewCfnRecommender(scope constructs.Construct, id *string, props *CfnRecommenderProps) CfnRecommender
Create a new `AWS::CustomerProfiles::Recommender`.
type CfnRecommenderProps ¶ added in v2.247.0
type CfnRecommenderProps struct {
// The name of the domain for which the recommender will be created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// The name of the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommendername
//
RecommenderName *string `field:"required" json:"recommenderName" yaml:"recommenderName"`
// The name of the recommender recipe.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderrecipename
//
RecommenderRecipeName *string `field:"required" json:"recommenderRecipeName" yaml:"recommenderRecipeName"`
// The description of the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Configuration for the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-recommenderconfig
//
RecommenderConfig interface{} `field:"optional" json:"recommenderConfig" yaml:"recommenderConfig"`
// The tags used to organize, track, or control access for this resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-recommender.html#cfn-customerprofiles-recommender-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnRecommender`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnRecommenderProps := &CfnRecommenderProps{
DomainName: jsii.String("domainName"),
RecommenderName: jsii.String("recommenderName"),
RecommenderRecipeName: jsii.String("recommenderRecipeName"),
// the properties below are optional
Description: jsii.String("description"),
RecommenderConfig: &RecommenderConfigProperty{
EventsConfig: &EventsConfigProperty{
EventParametersList: []interface{}{
&EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
},
},
},
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnRecommender_EventParametersProperty ¶ added in v2.247.0
type CfnRecommender_EventParametersProperty struct {
// The type of event.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventtype
//
EventType *string `field:"required" json:"eventType" yaml:"eventType"`
// The threshold of the event type.
//
// Only events with a value greater or equal to this threshold will be considered for solution creation.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventparameters.html#cfn-customerprofiles-recommender-eventparameters-eventvaluethreshold
//
EventValueThreshold *float64 `field:"optional" json:"eventValueThreshold" yaml:"eventValueThreshold"`
}
Event parameters with type and value threshold.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eventParametersProperty := &EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
}
type CfnRecommender_EventsConfigProperty ¶ added in v2.247.0
type CfnRecommender_EventsConfigProperty struct {
// List of event parameters with their value thresholds.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-eventsconfig.html#cfn-customerprofiles-recommender-eventsconfig-eventparameterslist
//
EventParametersList interface{} `field:"required" json:"eventParametersList" yaml:"eventParametersList"`
}
Configuration for events used in the recommender.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
eventsConfigProperty := &EventsConfigProperty{
EventParametersList: []interface{}{
&EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
},
},
}
type CfnRecommender_MetricsProperty ¶ added in v2.247.0
type CfnRecommender_MetricsProperty struct {
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-coverage
//
Coverage *float64 `field:"optional" json:"coverage" yaml:"coverage"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-freshness
//
Freshness *float64 `field:"optional" json:"freshness" yaml:"freshness"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-hit
//
Hit *float64 `field:"optional" json:"hit" yaml:"hit"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-popularity
//
Popularity *float64 `field:"optional" json:"popularity" yaml:"popularity"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-recall
//
Recall *float64 `field:"optional" json:"recall" yaml:"recall"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-metrics.html#cfn-customerprofiles-recommender-metrics-similarity
//
Similarity *float64 `field:"optional" json:"similarity" yaml:"similarity"`
}
Training metrics by type.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
metricsProperty := &MetricsProperty{
Coverage: jsii.Number(123),
Freshness: jsii.Number(123),
Hit: jsii.Number(123),
Popularity: jsii.Number(123),
Recall: jsii.Number(123),
Similarity: jsii.Number(123),
}
type CfnRecommender_RecommenderConfigProperty ¶ added in v2.247.0
type CfnRecommender_RecommenderConfigProperty struct {
// Configuration for events used in the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderconfig.html#cfn-customerprofiles-recommender-recommenderconfig-eventsconfig
//
EventsConfig interface{} `field:"optional" json:"eventsConfig" yaml:"eventsConfig"`
}
Configuration for the recommender.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
recommenderConfigProperty := &RecommenderConfigProperty{
EventsConfig: &EventsConfigProperty{
EventParametersList: []interface{}{
&EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
},
},
},
}
type CfnRecommender_RecommenderUpdateProperty ¶ added in v2.247.0
type CfnRecommender_RecommenderUpdateProperty struct {
// The timestamp of when the update was created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-creationdatetime
//
CreationDateTime *string `field:"optional" json:"creationDateTime" yaml:"creationDateTime"`
// The reason for update failure.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-failurereason
//
FailureReason *string `field:"optional" json:"failureReason" yaml:"failureReason"`
// The timestamp of when the update was last modified.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-lastupdateddatetime
//
LastUpdatedDateTime *string `field:"optional" json:"lastUpdatedDateTime" yaml:"lastUpdatedDateTime"`
// Configuration for the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-recommenderconfig
//
RecommenderConfig interface{} `field:"optional" json:"recommenderConfig" yaml:"recommenderConfig"`
// The status of the recommender.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-recommenderupdate.html#cfn-customerprofiles-recommender-recommenderupdate-status
//
Status *string `field:"optional" json:"status" yaml:"status"`
}
Information about the latest recommender update.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
recommenderUpdateProperty := &RecommenderUpdateProperty{
CreationDateTime: jsii.String("creationDateTime"),
FailureReason: jsii.String("failureReason"),
LastUpdatedDateTime: jsii.String("lastUpdatedDateTime"),
RecommenderConfig: &RecommenderConfigProperty{
EventsConfig: &EventsConfigProperty{
EventParametersList: []interface{}{
&EventParametersProperty{
EventType: jsii.String("eventType"),
// the properties below are optional
EventValueThreshold: jsii.Number(123),
},
},
},
},
Status: jsii.String("status"),
}
type CfnRecommender_TrainingMetricsProperty ¶ added in v2.247.0
type CfnRecommender_TrainingMetricsProperty struct {
// Training metrics by type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-metrics
//
Metrics interface{} `field:"optional" json:"metrics" yaml:"metrics"`
// Timestamp of the training metrics.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-recommender-trainingmetrics.html#cfn-customerprofiles-recommender-trainingmetrics-time
//
Time *string `field:"optional" json:"time" yaml:"time"`
}
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
trainingMetricsProperty := &TrainingMetricsProperty{
Metrics: &MetricsProperty{
Coverage: jsii.Number(123),
Freshness: jsii.Number(123),
Hit: jsii.Number(123),
Popularity: jsii.Number(123),
Recall: jsii.Number(123),
Similarity: jsii.Number(123),
},
Time: jsii.String("time"),
}
type CfnSegmentDefinition ¶ added in v2.172.0
type CfnSegmentDefinition interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawscustomerprofiles.ISegmentDefinitionRef
awscdk.ITaggableV2
// When the segment definition was created.
AttrCreatedAt() *string
// The arn of the segment definition.
AttrSegmentDefinitionArn() *string
// The segment type.
//
// Classic : Segments created using traditional SegmentGroup structure
//
// Enhanced : Segments created using SQL queries.
AttrSegmentType() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the segment definition.
Description() *string
SetDescription(val *string)
// Display name of the segment definition.
DisplayName() *string
SetDisplayName(val *string)
// The name of the domain.
DomainName() *string
SetDomainName(val *string)
Env() *interfaces.ResourceEnvironment
// 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 `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// 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 })`.
Ref() *string
// Name of the segment definition.
SegmentDefinitionName() *string
SetSegmentDefinitionName(val *string)
// A reference to a SegmentDefinition resource.
SegmentDefinitionRef() *interfacesawscustomerprofiles.SegmentDefinitionReference
// Contains all groups of the segment definition.
SegmentGroups() interface{}
SetSegmentGroups(val interface{})
// Defines how segments should be sorted and ordered in the results.
SegmentSort() interface{}
SetSegmentSort(val interface{})
// The SQL query that defines the segment criteria.
SegmentSqlQuery() *string
SetSegmentSqlQuery(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The tags belonging to the segment definition.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// 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.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// 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.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` 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,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` 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.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// 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:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// 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.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// 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.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// 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.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
A segment definition resource of Amazon Connect Customer Profiles.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSegmentDefinition := awscdk.Aws_customerprofiles.NewCfnSegmentDefinition(this, jsii.String("MyCfnSegmentDefinition"), &CfnSegmentDefinitionProps{
DisplayName: jsii.String("displayName"),
DomainName: jsii.String("domainName"),
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
// the properties below are optional
Description: jsii.String("description"),
SegmentGroups: &SegmentGroupProperty{
Groups: []interface{}{
&GroupProperty{
Dimensions: []interface{}{
&DimensionProperty{
CalculatedAttributes: map[string]interface{}{
"calculatedAttributesKey": &CalculatedAttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
// the properties below are optional
"conditionOverrides": &ConditionOverridesProperty{
"range": &RangeOverrideProperty{
"start": jsii.Number(123),
"unit": jsii.String("unit"),
// the properties below are optional
"end": jsii.Number(123),
},
},
},
},
ProfileAttributes: &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
},
},
},
SourceSegments: []interface{}{
&SourceSegmentProperty{
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
},
},
SourceType: jsii.String("sourceType"),
Type: jsii.String("type"),
},
},
Include: jsii.String("include"),
},
SegmentSort: &SegmentSortProperty{
Attributes: []interface{}{
&SortAttributeProperty{
Name: jsii.String("name"),
Order: jsii.String("order"),
// the properties below are optional
DataType: jsii.String("dataType"),
Type: jsii.String("type"),
},
},
},
SegmentSqlQuery: jsii.String("segmentSqlQuery"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnSegmentDefinition ¶ added in v2.172.0
func NewCfnSegmentDefinition(scope constructs.Construct, id *string, props *CfnSegmentDefinitionProps) CfnSegmentDefinition
Create a new `AWS::CustomerProfiles::SegmentDefinition`.
type CfnSegmentDefinitionProps ¶ added in v2.172.0
type CfnSegmentDefinitionProps struct {
// Display name of the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-displayname
//
DisplayName *string `field:"required" json:"displayName" yaml:"displayName"`
// The name of the domain.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-domainname
//
DomainName *string `field:"required" json:"domainName" yaml:"domainName"`
// Name of the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentdefinitionname
//
SegmentDefinitionName *string `field:"required" json:"segmentDefinitionName" yaml:"segmentDefinitionName"`
// The description of the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Contains all groups of the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentgroups
//
SegmentGroups interface{} `field:"optional" json:"segmentGroups" yaml:"segmentGroups"`
// Defines how segments should be sorted and ordered in the results.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsort
//
SegmentSort interface{} `field:"optional" json:"segmentSort" yaml:"segmentSort"`
// The SQL query that defines the segment criteria.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-segmentsqlquery
//
SegmentSqlQuery *string `field:"optional" json:"segmentSqlQuery" yaml:"segmentSqlQuery"`
// The tags belonging to the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-customerprofiles-segmentdefinition.html#cfn-customerprofiles-segmentdefinition-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSegmentDefinition`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSegmentDefinitionProps := &CfnSegmentDefinitionProps{
DisplayName: jsii.String("displayName"),
DomainName: jsii.String("domainName"),
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
// the properties below are optional
Description: jsii.String("description"),
SegmentGroups: &SegmentGroupProperty{
Groups: []interface{}{
&GroupProperty{
Dimensions: []interface{}{
&DimensionProperty{
CalculatedAttributes: map[string]interface{}{
"calculatedAttributesKey": &CalculatedAttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
// the properties below are optional
"conditionOverrides": &ConditionOverridesProperty{
"range": &RangeOverrideProperty{
"start": jsii.Number(123),
"unit": jsii.String("unit"),
// the properties below are optional
"end": jsii.Number(123),
},
},
},
},
ProfileAttributes: &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
},
},
},
SourceSegments: []interface{}{
&SourceSegmentProperty{
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
},
},
SourceType: jsii.String("sourceType"),
Type: jsii.String("type"),
},
},
Include: jsii.String("include"),
},
SegmentSort: &SegmentSortProperty{
Attributes: []interface{}{
&SortAttributeProperty{
Name: jsii.String("name"),
Order: jsii.String("order"),
// the properties below are optional
DataType: jsii.String("dataType"),
Type: jsii.String("type"),
},
},
},
SegmentSqlQuery: jsii.String("segmentSqlQuery"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnSegmentDefinition_AddressDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_AddressDimensionProperty struct {
// The city belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-city
//
City interface{} `field:"optional" json:"city" yaml:"city"`
// The country belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-country
//
Country interface{} `field:"optional" json:"country" yaml:"country"`
// The county belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-county
//
County interface{} `field:"optional" json:"county" yaml:"county"`
// The postal code belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-postalcode
//
PostalCode interface{} `field:"optional" json:"postalCode" yaml:"postalCode"`
// The province belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-province
//
Province interface{} `field:"optional" json:"province" yaml:"province"`
// The state belonging to the address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-addressdimension.html#cfn-customerprofiles-segmentdefinition-addressdimension-state
//
State interface{} `field:"optional" json:"state" yaml:"state"`
}
Object that segments on Customer Profile's address object.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
addressDimensionProperty := &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
}
type CfnSegmentDefinition_AttributeDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_AttributeDimensionProperty struct {
// The action to segment with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// The values to apply the DimensionType on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-attributedimension.html#cfn-customerprofiles-segmentdefinition-attributedimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
}
Object that defines how to filter the incoming objects for the calculated attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
attributeDimensionProperty := &AttributeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
}
type CfnSegmentDefinition_CalculatedAttributeDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_CalculatedAttributeDimensionProperty struct {
// The action to segment with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// The values to apply the DimensionType with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
// Applies the given condition over the initial Calculated Attribute's definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-calculatedattributedimension.html#cfn-customerprofiles-segmentdefinition-calculatedattributedimension-conditionoverrides
//
ConditionOverrides interface{} `field:"optional" json:"conditionOverrides" yaml:"conditionOverrides"`
}
Object that segments on Customer Profile's Calculated Attributes.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
calculatedAttributeDimensionProperty := &CalculatedAttributeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
// the properties below are optional
ConditionOverrides: &ConditionOverridesProperty{
Range: &RangeOverrideProperty{
Start: jsii.Number(123),
Unit: jsii.String("unit"),
// the properties below are optional
End: jsii.Number(123),
},
},
}
type CfnSegmentDefinition_ConditionOverridesProperty ¶ added in v2.172.0
type CfnSegmentDefinition_ConditionOverridesProperty struct {
// The relative time period over which data is included in the aggregation for this override.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-conditionoverrides.html#cfn-customerprofiles-segmentdefinition-conditionoverrides-range
//
Range interface{} `field:"optional" json:"range" yaml:"range"`
}
An object to override the original condition block of a calculated attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
conditionOverridesProperty := &ConditionOverridesProperty{
Range: &RangeOverrideProperty{
Start: jsii.Number(123),
Unit: jsii.String("unit"),
// the properties below are optional
End: jsii.Number(123),
},
}
type CfnSegmentDefinition_DateDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_DateDimensionProperty struct {
// The action to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// The values to apply the DimensionType on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-datedimension.html#cfn-customerprofiles-segmentdefinition-datedimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
}
Object that segments on various Customer Profile's date fields.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dateDimensionProperty := &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
}
type CfnSegmentDefinition_DimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_DimensionProperty struct {
// Object that holds the calculated attributes to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-calculatedattributes
//
CalculatedAttributes interface{} `field:"optional" json:"calculatedAttributes" yaml:"calculatedAttributes"`
// Object that holds the profile attributes to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-dimension.html#cfn-customerprofiles-segmentdefinition-dimension-profileattributes
//
ProfileAttributes interface{} `field:"optional" json:"profileAttributes" yaml:"profileAttributes"`
}
Defines the attribute to segment on.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
dimensionProperty := &DimensionProperty{
CalculatedAttributes: map[string]interface{}{
"calculatedAttributesKey": &CalculatedAttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
// the properties below are optional
"conditionOverrides": &ConditionOverridesProperty{
"range": &RangeOverrideProperty{
"start": jsii.Number(123),
"unit": jsii.String("unit"),
// the properties below are optional
"end": jsii.Number(123),
},
},
},
},
ProfileAttributes: &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
},
}
type CfnSegmentDefinition_ExtraLengthValueProfileDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_ExtraLengthValueProfileDimensionProperty struct {
// The action to segment with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// The values to apply the DimensionType on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-extralengthvalueprofiledimension.html#cfn-customerprofiles-segmentdefinition-extralengthvalueprofiledimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
}
Object that segments on various Customer profile's fields that are larger than normal.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
extraLengthValueProfileDimensionProperty := &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
}
type CfnSegmentDefinition_GroupProperty ¶ added in v2.172.0
type CfnSegmentDefinition_GroupProperty struct {
// Defines the attributes to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-dimensions
//
Dimensions interface{} `field:"optional" json:"dimensions" yaml:"dimensions"`
// Defines the starting source of data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcesegments
//
SourceSegments interface{} `field:"optional" json:"sourceSegments" yaml:"sourceSegments"`
// Defines how to interact with the source data.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-sourcetype
//
SourceType *string `field:"optional" json:"sourceType" yaml:"sourceType"`
// Defines how to interact with the profiles found in the current filtering.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-group.html#cfn-customerprofiles-segmentdefinition-group-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Contains dimensions that determine what to segment on.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
groupProperty := &GroupProperty{
Dimensions: []interface{}{
&DimensionProperty{
CalculatedAttributes: map[string]interface{}{
"calculatedAttributesKey": &CalculatedAttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
// the properties below are optional
"conditionOverrides": &ConditionOverridesProperty{
"range": &RangeOverrideProperty{
"start": jsii.Number(123),
"unit": jsii.String("unit"),
// the properties below are optional
"end": jsii.Number(123),
},
},
},
},
ProfileAttributes: &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
},
},
},
SourceSegments: []interface{}{
&SourceSegmentProperty{
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
},
},
SourceType: jsii.String("sourceType"),
Type: jsii.String("type"),
}
type CfnSegmentDefinition_ProfileAttributesProperty ¶ added in v2.172.0
type CfnSegmentDefinition_ProfileAttributesProperty struct {
// A field to describe values to segment on within account number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-accountnumber
//
AccountNumber interface{} `field:"optional" json:"accountNumber" yaml:"accountNumber"`
// A field to describe values to segment on within additional information.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-additionalinformation
//
AdditionalInformation interface{} `field:"optional" json:"additionalInformation" yaml:"additionalInformation"`
// A field to describe values to segment on within address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-address
//
Address interface{} `field:"optional" json:"address" yaml:"address"`
// A field to describe values to segment on within attributes.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-attributes
//
Attributes interface{} `field:"optional" json:"attributes" yaml:"attributes"`
// A field to describe values to segment on within billing address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-billingaddress
//
BillingAddress interface{} `field:"optional" json:"billingAddress" yaml:"billingAddress"`
// A field to describe values to segment on within birthDate.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-birthdate
//
BirthDate interface{} `field:"optional" json:"birthDate" yaml:"birthDate"`
// A field to describe values to segment on within business email address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessemailaddress
//
BusinessEmailAddress interface{} `field:"optional" json:"businessEmailAddress" yaml:"businessEmailAddress"`
// A field to describe values to segment on within business name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessname
//
BusinessName interface{} `field:"optional" json:"businessName" yaml:"businessName"`
// A field to describe values to segment on within business phone number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-businessphonenumber
//
BusinessPhoneNumber interface{} `field:"optional" json:"businessPhoneNumber" yaml:"businessPhoneNumber"`
// A field to describe values to segment on within email address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-emailaddress
//
EmailAddress interface{} `field:"optional" json:"emailAddress" yaml:"emailAddress"`
// A field to describe values to segment on within first name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-firstname
//
FirstName interface{} `field:"optional" json:"firstName" yaml:"firstName"`
// A field to describe values to segment on within genderString.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-genderstring
//
GenderString interface{} `field:"optional" json:"genderString" yaml:"genderString"`
// A field to describe values to segment on within home phone number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-homephonenumber
//
HomePhoneNumber interface{} `field:"optional" json:"homePhoneNumber" yaml:"homePhoneNumber"`
// A field to describe values to segment on within last name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-lastname
//
LastName interface{} `field:"optional" json:"lastName" yaml:"lastName"`
// A field to describe values to segment on within mailing address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mailingaddress
//
MailingAddress interface{} `field:"optional" json:"mailingAddress" yaml:"mailingAddress"`
// A field to describe values to segment on within middle name.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-middlename
//
MiddleName interface{} `field:"optional" json:"middleName" yaml:"middleName"`
// A field to describe values to segment on within mobile phone number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-mobilephonenumber
//
MobilePhoneNumber interface{} `field:"optional" json:"mobilePhoneNumber" yaml:"mobilePhoneNumber"`
// A field to describe values to segment on within partyTypeString.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-partytypestring
//
PartyTypeString interface{} `field:"optional" json:"partyTypeString" yaml:"partyTypeString"`
// A field to describe values to segment on within personal email address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-personalemailaddress
//
PersonalEmailAddress interface{} `field:"optional" json:"personalEmailAddress" yaml:"personalEmailAddress"`
// A field to describe values to segment on within phone number.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-phonenumber
//
PhoneNumber interface{} `field:"optional" json:"phoneNumber" yaml:"phoneNumber"`
// The type of profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-profiletype
//
ProfileType interface{} `field:"optional" json:"profileType" yaml:"profileType"`
// A field to describe values to segment on within shipping address.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profileattributes.html#cfn-customerprofiles-segmentdefinition-profileattributes-shippingaddress
//
ShippingAddress interface{} `field:"optional" json:"shippingAddress" yaml:"shippingAddress"`
}
The object used to segment on attributes within the customer profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
profileAttributesProperty := &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
}
type CfnSegmentDefinition_ProfileDimensionProperty ¶ added in v2.172.0
type CfnSegmentDefinition_ProfileDimensionProperty struct {
// The action to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiledimension.html#cfn-customerprofiles-segmentdefinition-profiledimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
}
Object that segments on various Customer profile's fields that are larger than normal.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
profileDimensionProperty := &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
}
type CfnSegmentDefinition_ProfileTypeDimensionProperty ¶ added in v2.203.0
type CfnSegmentDefinition_ProfileTypeDimensionProperty struct {
// The action to segment on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiletypedimension.html#cfn-customerprofiles-segmentdefinition-profiletypedimension-dimensiontype
//
DimensionType *string `field:"required" json:"dimensionType" yaml:"dimensionType"`
// The values to apply the DimensionType on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-profiletypedimension.html#cfn-customerprofiles-segmentdefinition-profiletypedimension-values
//
Values *[]*string `field:"required" json:"values" yaml:"values"`
}
Specifies profile type based criteria for a segment.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
profileTypeDimensionProperty := &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
}
type CfnSegmentDefinition_RangeOverrideProperty ¶ added in v2.172.0
type CfnSegmentDefinition_RangeOverrideProperty struct {
// The start time of when to include objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-start
//
Start *float64 `field:"required" json:"start" yaml:"start"`
// The unit for start and end.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-unit
//
Unit *string `field:"required" json:"unit" yaml:"unit"`
// The end time of when to include objects.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-rangeoverride.html#cfn-customerprofiles-segmentdefinition-rangeoverride-end
//
End *float64 `field:"optional" json:"end" yaml:"end"`
}
Overrides the original range on a calculated attribute definition.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
rangeOverrideProperty := &RangeOverrideProperty{
Start: jsii.Number(123),
Unit: jsii.String("unit"),
// the properties below are optional
End: jsii.Number(123),
}
type CfnSegmentDefinition_SegmentGroupProperty ¶ added in v2.172.0
type CfnSegmentDefinition_SegmentGroupProperty struct {
// Holds the list of groups within the segment definition.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-groups
//
Groups interface{} `field:"optional" json:"groups" yaml:"groups"`
// Defines whether to include or exclude the profiles that fit the segment criteria.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentgroup.html#cfn-customerprofiles-segmentdefinition-segmentgroup-include
//
Include *string `field:"optional" json:"include" yaml:"include"`
}
Contains all groups of the segment definition.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
segmentGroupProperty := &SegmentGroupProperty{
Groups: []interface{}{
&GroupProperty{
Dimensions: []interface{}{
&DimensionProperty{
CalculatedAttributes: map[string]interface{}{
"calculatedAttributesKey": &CalculatedAttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
// the properties below are optional
"conditionOverrides": &ConditionOverridesProperty{
"range": &RangeOverrideProperty{
"start": jsii.Number(123),
"unit": jsii.String("unit"),
// the properties below are optional
"end": jsii.Number(123),
},
},
},
},
ProfileAttributes: &ProfileAttributesProperty{
AccountNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
AdditionalInformation: &ExtraLengthValueProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Address: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
Attributes: map[string]interface{}{
"attributesKey": &AttributeDimensionProperty{
"dimensionType": jsii.String("dimensionType"),
"values": []*string{
jsii.String("values"),
},
},
},
BillingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
BirthDate: &DateDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
BusinessPhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
EmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
FirstName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
GenderString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
HomePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
LastName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MailingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
MiddleName: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
MobilePhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PartyTypeString: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PersonalEmailAddress: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PhoneNumber: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ProfileType: &ProfileTypeDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
ShippingAddress: &AddressDimensionProperty{
City: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Country: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
County: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
PostalCode: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
Province: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
State: &ProfileDimensionProperty{
DimensionType: jsii.String("dimensionType"),
Values: []*string{
jsii.String("values"),
},
},
},
},
},
},
SourceSegments: []interface{}{
&SourceSegmentProperty{
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
},
},
SourceType: jsii.String("sourceType"),
Type: jsii.String("type"),
},
},
Include: jsii.String("include"),
}
type CfnSegmentDefinition_SegmentSortProperty ¶ added in v2.249.0
type CfnSegmentDefinition_SegmentSortProperty struct {
// A list of attributes used to sort the segments and their ordering preferences.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-segmentsort.html#cfn-customerprofiles-segmentdefinition-segmentsort-attributes
//
Attributes interface{} `field:"required" json:"attributes" yaml:"attributes"`
}
Defines how segments should be sorted and ordered in the results.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
segmentSortProperty := &SegmentSortProperty{
Attributes: []interface{}{
&SortAttributeProperty{
Name: jsii.String("name"),
Order: jsii.String("order"),
// the properties below are optional
DataType: jsii.String("dataType"),
Type: jsii.String("type"),
},
},
}
type CfnSegmentDefinition_SortAttributeProperty ¶ added in v2.249.0
type CfnSegmentDefinition_SortAttributeProperty struct {
// The name of the attribute to sort by.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-name
//
Name *string `field:"required" json:"name" yaml:"name"`
// The sort order for the attribute (ascending or descending).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-order
//
Order *string `field:"required" json:"order" yaml:"order"`
// The data type of the sort attribute (e.g., string, number, date).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-datatype
//
DataType *string `field:"optional" json:"dataType" yaml:"dataType"`
// The type of attribute (e.g., profile, calculated).
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sortattribute.html#cfn-customerprofiles-segmentdefinition-sortattribute-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Defines the characteristics and rules for sorting by a specific attribute.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sortAttributeProperty := &SortAttributeProperty{
Name: jsii.String("name"),
Order: jsii.String("order"),
// the properties below are optional
DataType: jsii.String("dataType"),
Type: jsii.String("type"),
}
type CfnSegmentDefinition_SourceSegmentProperty ¶ added in v2.172.0
type CfnSegmentDefinition_SourceSegmentProperty struct {
// The name of the source segment.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-customerprofiles-segmentdefinition-sourcesegment.html#cfn-customerprofiles-segmentdefinition-sourcesegment-segmentdefinitionname
//
SegmentDefinitionName *string `field:"optional" json:"segmentDefinitionName" yaml:"segmentDefinitionName"`
}
The source segments to build off of.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sourceSegmentProperty := &SourceSegmentProperty{
SegmentDefinitionName: jsii.String("segmentDefinitionName"),
}
Source Files
¶
- CfnCalculatedAttributeDefinition.go
- CfnCalculatedAttributeDefinitionProps.go
- CfnCalculatedAttributeDefinition_AttributeDetailsProperty.go
- CfnCalculatedAttributeDefinition_AttributeItemProperty.go
- CfnCalculatedAttributeDefinition_ConditionsProperty.go
- CfnCalculatedAttributeDefinition_RangeProperty.go
- CfnCalculatedAttributeDefinition_ReadinessProperty.go
- CfnCalculatedAttributeDefinition_ThresholdProperty.go
- CfnCalculatedAttributeDefinition_ValueRangeProperty.go
- CfnCalculatedAttributeDefinition__checks.go
- CfnDomain.go
- CfnDomainProps.go
- CfnDomain_AttributeTypesSelectorProperty.go
- CfnDomain_AutoMergingProperty.go
- CfnDomain_ConflictResolutionProperty.go
- CfnDomain_ConsolidationProperty.go
- CfnDomain_DataStoreProperty.go
- CfnDomain_DomainStatsProperty.go
- CfnDomain_ExportingConfigProperty.go
- CfnDomain_JobScheduleProperty.go
- CfnDomain_MatchingProperty.go
- CfnDomain_MatchingRuleProperty.go
- CfnDomain_ReadinessProperty.go
- CfnDomain_RuleBasedMatchingProperty.go
- CfnDomain_S3ExportingConfigProperty.go
- CfnDomain__checks.go
- CfnEventStream.go
- CfnEventStreamProps.go
- CfnEventStream_DestinationDetailsProperty.go
- CfnEventStream__checks.go
- CfnEventTrigger.go
- CfnEventTriggerProps.go
- CfnEventTrigger_EventTriggerConditionProperty.go
- CfnEventTrigger_EventTriggerDimensionProperty.go
- CfnEventTrigger_EventTriggerLimitsProperty.go
- CfnEventTrigger_ObjectAttributeProperty.go
- CfnEventTrigger_PeriodProperty.go
- CfnEventTrigger__checks.go
- CfnIntegration.go
- CfnIntegrationProps.go
- CfnIntegration_ConnectorOperatorProperty.go
- CfnIntegration_FlowDefinitionProperty.go
- CfnIntegration_IncrementalPullConfigProperty.go
- CfnIntegration_MarketoSourcePropertiesProperty.go
- CfnIntegration_ObjectTypeMappingProperty.go
- CfnIntegration_S3SourcePropertiesProperty.go
- CfnIntegration_SalesforceSourcePropertiesProperty.go
- CfnIntegration_ScheduledTriggerPropertiesProperty.go
- CfnIntegration_ServiceNowSourcePropertiesProperty.go
- CfnIntegration_SourceConnectorPropertiesProperty.go
- CfnIntegration_SourceFlowConfigProperty.go
- CfnIntegration_TaskPropertiesMapProperty.go
- CfnIntegration_TaskProperty.go
- CfnIntegration_TriggerConfigProperty.go
- CfnIntegration_TriggerPropertiesProperty.go
- CfnIntegration_ZendeskSourcePropertiesProperty.go
- CfnIntegration__checks.go
- CfnObjectType.go
- CfnObjectTypeProps.go
- CfnObjectType_FieldMapProperty.go
- CfnObjectType_KeyMapProperty.go
- CfnObjectType_ObjectTypeFieldProperty.go
- CfnObjectType_ObjectTypeKeyProperty.go
- CfnObjectType__checks.go
- CfnRecommender.go
- CfnRecommenderProps.go
- CfnRecommender_EventParametersProperty.go
- CfnRecommender_EventsConfigProperty.go
- CfnRecommender_MetricsProperty.go
- CfnRecommender_RecommenderConfigProperty.go
- CfnRecommender_RecommenderUpdateProperty.go
- CfnRecommender_TrainingMetricsProperty.go
- CfnRecommender__checks.go
- CfnSegmentDefinition.go
- CfnSegmentDefinitionProps.go
- CfnSegmentDefinition_AddressDimensionProperty.go
- CfnSegmentDefinition_AttributeDimensionProperty.go
- CfnSegmentDefinition_CalculatedAttributeDimensionProperty.go
- CfnSegmentDefinition_ConditionOverridesProperty.go
- CfnSegmentDefinition_DateDimensionProperty.go
- CfnSegmentDefinition_DimensionProperty.go
- CfnSegmentDefinition_ExtraLengthValueProfileDimensionProperty.go
- CfnSegmentDefinition_GroupProperty.go
- CfnSegmentDefinition_ProfileAttributesProperty.go
- CfnSegmentDefinition_ProfileDimensionProperty.go
- CfnSegmentDefinition_ProfileTypeDimensionProperty.go
- CfnSegmentDefinition_RangeOverrideProperty.go
- CfnSegmentDefinition_SegmentGroupProperty.go
- CfnSegmentDefinition_SegmentSortProperty.go
- CfnSegmentDefinition_SortAttributeProperty.go
- CfnSegmentDefinition_SourceSegmentProperty.go
- CfnSegmentDefinition__checks.go
- main.go