Class CfnSegment
Updates the configuration, dimension, and other settings for an existing segment.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnSegment : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnSegment
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
CloudformationResource: AWS::Pinpoint::Segment
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.Pinpoint;
var attributes;
var metrics;
var tags;
var userAttributes;
var cfnSegment = new CfnSegment(this, "MyCfnSegment", new CfnSegmentProps {
ApplicationId = "applicationId",
Name = "name",
// the properties below are optional
Dimensions = new SegmentDimensionsProperty {
Attributes = attributes,
Behavior = new BehaviorProperty {
Recency = new RecencyProperty {
Duration = "duration",
RecencyType = "recencyType"
}
},
Demographic = new DemographicProperty {
AppVersion = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Channel = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
DeviceType = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Make = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Model = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Platform = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
Location = new LocationProperty {
Country = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
GpsPoint = new GPSPointProperty {
Coordinates = new CoordinatesProperty {
Latitude = 123,
Longitude = 123
},
RangeInKilometers = 123
}
},
Metrics = metrics,
UserAttributes = userAttributes
},
SegmentGroups = new SegmentGroupsProperty {
Groups = new [] { new GroupsProperty {
Dimensions = new [] { new SegmentDimensionsProperty {
Attributes = attributes,
Behavior = new BehaviorProperty {
Recency = new RecencyProperty {
Duration = "duration",
RecencyType = "recencyType"
}
},
Demographic = new DemographicProperty {
AppVersion = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Channel = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
DeviceType = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Make = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Model = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
Platform = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
}
},
Location = new LocationProperty {
Country = new SetDimensionProperty {
DimensionType = "dimensionType",
Values = new [] { "values" }
},
GpsPoint = new GPSPointProperty {
Coordinates = new CoordinatesProperty {
Latitude = 123,
Longitude = 123
},
RangeInKilometers = 123
}
},
Metrics = metrics,
UserAttributes = userAttributes
} },
SourceSegments = new [] { new SourceSegmentsProperty {
Id = "id",
// the properties below are optional
Version = 123
} },
SourceType = "sourceType",
Type = "type"
} },
Include = "include"
},
Tags = tags
});
Synopsis
Constructors
CfnSegment(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnSegment(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnSegment(Construct, String, ICfnSegmentProps) |
Properties
ApplicationId | The unique identifier for the Amazon Pinpoint application that the segment is associated with. |
AttrArn | The Amazon Resource Name (ARN) of the segment. |
AttrSegmentId | The unique identifier for the segment. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Dimensions | An array that defines the dimensions for the segment. |
Name | The name of the segment. |
SegmentGroups | The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnSegment(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnSegment(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnSegment(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnSegment(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnSegment(Construct, String, ICfnSegmentProps)
public CfnSegment(Construct scope, string id, ICfnSegmentProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnSegmentProps
Resource properties.
Properties
ApplicationId
The unique identifier for the Amazon Pinpoint application that the segment is associated with.
public virtual string ApplicationId { get; set; }
Property Value
System.String
AttrArn
The Amazon Resource Name (ARN) of the segment.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrSegmentId
The unique identifier for the segment.
public virtual string AttrSegmentId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: SegmentId
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Dimensions
An array that defines the dimensions for the segment.
public virtual object Dimensions { get; set; }
Property Value
System.Object
Name
The name of the segment.
public virtual string Name { get; set; }
Property Value
System.String
SegmentGroups
The segment group to use and the dimensions to apply to the group's base segments in order to build the segment.
public virtual object SegmentGroups { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual object TagsRaw { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>