Class CfnSegmentDefinition
A segment definition resource of Amazon Connect Customer Profiles.
Inherited Members
Namespace: Amazon.CDK.AWS.CustomerProfiles
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSegmentDefinition : CfnResource, IInspectable, ISegmentDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnSegmentDefinition Inherits CfnResource Implements IInspectable, ISegmentDefinitionRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CustomerProfiles;
var cfnSegmentDefinition = new CfnSegmentDefinition(this, "MyCfnSegmentDefinition", new CfnSegmentDefinitionProps {
DisplayName = "displayName",
DomainName = "domainName",
SegmentDefinitionName = "segmentDefinitionName",
// the properties below are optional
Description = "description",
SegmentGroups = new SegmentGroupProperty {
Groups = new [] { new GroupProperty {
Dimensions = new [] { new DimensionProperty {
CalculatedAttributes = new Dictionary<string, object> {
{ "calculatedAttributesKey", new CalculatedAttributeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" },
// the properties below are optional
ConditionOverrides = new ConditionOverridesProperty {
Range = new RangeOverrideProperty {
Start = 123,
Unit = "unit",
// the properties below are optional
End = 123
}
}
} }
},
ProfileAttributes = new ProfileAttributesProperty {
AccountNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
AdditionalInformation = new ExtraLengthValueProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Address = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
Attributes = new Dictionary<string, object> {
{ "attributesKey", new AttributeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
} }
},
BillingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
BirthDate = new DateDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessEmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessPhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
EmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
FirstName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
GenderString = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
HomePhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
LastName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
MailingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
MiddleName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
MobilePhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PartyTypeString = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PersonalEmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
ProfileType = new ProfileTypeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
ShippingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
}
}
} },
SourceSegments = new [] { new SourceSegmentProperty {
SegmentDefinitionName = "segmentDefinitionName"
} },
SourceType = "sourceType",
Type = "type"
} },
Include = "include"
},
SegmentSort = new SegmentSortProperty {
Attributes = new [] { new SortAttributeProperty {
Name = "name",
Order = "order",
// the properties below are optional
DataType = "dataType",
Type = "type"
} }
},
SegmentSqlQuery = "segmentSqlQuery",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
| CfnSegmentDefinition(Construct, string, ICfnSegmentDefinitionProps) | Create a new |
Properties
| AttrCreatedAt | When the segment definition was created. |
| AttrSegmentDefinitionArn | The arn of the segment definition. |
| AttrSegmentType | The segment type. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CdkTagManager | Tag Manager which manages the tags for this resource. |
| CfnProperties | A segment definition resource of Amazon Connect Customer Profiles. |
| CfnPropertyNames | A segment definition resource of Amazon Connect Customer Profiles. |
| Description | The description of the segment definition. |
| DisplayName | Display name of the segment definition. |
| DomainName | The name of the domain. |
| SegmentDefinitionName | Name of the segment definition. |
| SegmentDefinitionRef | A reference to a SegmentDefinition resource. |
| SegmentGroups | Contains all groups of the segment definition. |
| SegmentSort | Defines how segments should be sorted and ordered in the results. |
| SegmentSqlQuery | The SQL query that defines the segment criteria. |
| Tags | The tags belonging to the segment definition. |
Methods
| ArnForSegmentDefinition(ISegmentDefinitionRef) | A segment definition resource of Amazon Connect Customer Profiles. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnSegmentDefinition(object) | Checks whether the given object is a CfnSegmentDefinition. |
| RenderProperties(IDictionary<string, object>) | A segment definition resource of Amazon Connect Customer Profiles. |
Constructors
CfnSegmentDefinition(Construct, string, ICfnSegmentDefinitionProps)
Create a new AWS::CustomerProfiles::SegmentDefinition.
public CfnSegmentDefinition(Construct scope, string id, ICfnSegmentDefinitionProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnSegmentDefinitionProps
Resource properties.
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Properties
AttrCreatedAt
When the segment definition was created.
public virtual string AttrCreatedAt { get; }
Property Value
Remarks
CloudformationAttribute: CreatedAt
AttrSegmentDefinitionArn
The arn of the segment definition.
public virtual string AttrSegmentDefinitionArn { get; }
Property Value
Remarks
CloudformationAttribute: SegmentDefinitionArn
AttrSegmentType
The segment type.
public virtual string AttrSegmentType { get; }
Property Value
Remarks
Classic : Segments created using traditional SegmentGroup structure
Enhanced : Segments created using SQL queries
CloudformationAttribute: SegmentType
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
CfnProperties
A segment definition resource of Amazon Connect Customer Profiles.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
CfnPropertyNames
A segment definition resource of Amazon Connect Customer Profiles.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Description
The description of the segment definition.
public virtual string? Description { get; set; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
DisplayName
Display name of the segment definition.
public virtual string DisplayName { get; set; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
DomainName
The name of the domain.
public virtual string DomainName { get; set; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
SegmentDefinitionName
Name of the segment definition.
public virtual string SegmentDefinitionName { get; set; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
SegmentDefinitionRef
A reference to a SegmentDefinition resource.
public virtual ISegmentDefinitionReference SegmentDefinitionRef { get; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
SegmentGroups
Contains all groups of the segment definition.
public virtual object? SegmentGroups { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnSegmentDefinition.ISegmentGroupProperty
SegmentSort
Defines how segments should be sorted and ordered in the results.
public virtual object? SegmentSort { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnSegmentDefinition.ISegmentSortProperty
SegmentSqlQuery
The SQL query that defines the segment criteria.
public virtual string? SegmentSqlQuery { get; set; }
Property Value
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Tags
The tags belonging to the segment definition.
public virtual ICfnTag[]? Tags { get; set; }
Property Value
ICfnTag[]
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Methods
ArnForSegmentDefinition(ISegmentDefinitionRef)
A segment definition resource of Amazon Connect Customer Profiles.
public static string ArnForSegmentDefinition(ISegmentDefinitionRef resource)
Parameters
- resource ISegmentDefinitionRef
Returns
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CustomerProfiles;
var cfnSegmentDefinition = new CfnSegmentDefinition(this, "MyCfnSegmentDefinition", new CfnSegmentDefinitionProps {
DisplayName = "displayName",
DomainName = "domainName",
SegmentDefinitionName = "segmentDefinitionName",
// the properties below are optional
Description = "description",
SegmentGroups = new SegmentGroupProperty {
Groups = new [] { new GroupProperty {
Dimensions = new [] { new DimensionProperty {
CalculatedAttributes = new Dictionary<string, object> {
{ "calculatedAttributesKey", new CalculatedAttributeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" },
// the properties below are optional
ConditionOverrides = new ConditionOverridesProperty {
Range = new RangeOverrideProperty {
Start = 123,
Unit = "unit",
// the properties below are optional
End = 123
}
}
} }
},
ProfileAttributes = new ProfileAttributesProperty {
AccountNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
AdditionalInformation = new ExtraLengthValueProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Address = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
Attributes = new Dictionary<string, object> {
{ "attributesKey", new AttributeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
} }
},
BillingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
BirthDate = new DateDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessEmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
BusinessPhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
EmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
FirstName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
GenderString = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
HomePhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
LastName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
MailingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
MiddleName = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
MobilePhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PartyTypeString = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PersonalEmailAddress = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PhoneNumber = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
ProfileType = new ProfileTypeDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
ShippingAddress = new AddressDimensionProperty {
City = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Country = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
County = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
PostalCode = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Province = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
State = new ProfileDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
}
}
} },
SourceSegments = new [] { new SourceSegmentProperty {
SegmentDefinitionName = "segmentDefinitionName"
} },
SourceType = "sourceType",
Type = "type"
} },
Include = "include"
},
SegmentSort = new SegmentSortProperty {
Attributes = new [] { new SortAttributeProperty {
Name = "name",
Order = "order",
// the properties below are optional
DataType = "dataType",
Type = "type"
} }
},
SegmentSqlQuery = "segmentSqlQuery",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
IsCfnSegmentDefinition(object)
Checks whether the given object is a CfnSegmentDefinition.
public static bool IsCfnSegmentDefinition(object x)
Parameters
- x object
Returns
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
A segment definition resource of Amazon Connect Customer Profiles.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
CloudformationResource: AWS::CustomerProfiles::SegmentDefinition
ExampleMetadata: fixture=_generated