Class CfnSegment
A CloudFormation AWS::Pinpoint::Segment
.
Inherited Members
Namespace: Amazon.CDK.AWS.Pinpoint
Assembly: Amazon.CDK.AWS.Pinpoint.dll
Syntax (csharp)
public class CfnSegment : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnSegment
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Updates the configuration, dimension, and other settings for an existing segment.
CloudformationResource: AWS::Pinpoint::Segment
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html
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(Construct, String, ICfnSegmentProps) | Create a new |
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 |
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 | The criteria that define 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 | 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(Construct, String, ICfnSegmentProps)
Create a new AWS::Pinpoint::Segment
.
public CfnSegment(Construct scope, string id, ICfnSegmentProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnSegmentProps
- resource properties.
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
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
Remarks
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
The criteria that define the dimensions for the segment.
public virtual object Dimensions { get; set; }
Property Value
System.Object
Remarks
Name
The name of the segment.
public virtual string Name { get; set; }
Property Value
System.String
Remarks
A segment must have a name otherwise it will not appear in the Amazon Pinpoint console.
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
Remarks
A segment group can consist of zero or more base segments. Your request can include only one segment group.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
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>