Class CfnSegment

Updates the configuration, dimension, and other settings for an existing segment.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnSegment

Implements

IInspectable

ISegmentRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.Pinpoint

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnSegment : CfnResource, IInspectable, ISegmentRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnSegment Inherits CfnResource Implements IInspectable, ISegmentRef, IConstruct, IDependable, IEnvironmentAware, 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(Construct, string, ICfnSegmentProps)

Create a new AWS::Pinpoint::Segment.

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	Updates the configuration, dimension, and other settings for an existing segment.
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.
SegmentRef	A reference to a Segment resource.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	An array of key-value pairs to apply to this resource.

Methods

ArnForSegment(ISegmentRef)	Updates the configuration, dimension, and other settings for an existing segment.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnSegment(object)	Checks whether the given object is a CfnSegment.
RenderProperties(IDictionary<string, object>)	Updates the configuration, dimension, and other settings for an existing segment.

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 string: Construct identifier for this resource (unique in its scope).
props ICfnSegmentProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

Properties

ApplicationId

The unique identifier for the Amazon Pinpoint application that the segment is associated with.

public virtual string ApplicationId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

AttrArn

The Amazon Resource Name (ARN) of the segment.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrSegmentId

The unique identifier for the segment.

public virtual string AttrSegmentId { get; }

Property Value

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

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

CfnProperties

Updates the configuration, dimension, and other settings for an existing segment.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

Dimensions

An array that defines the dimensions for the segment.

public virtual object? Dimensions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnSegment.ISegmentDimensionsProperty

Name

The name of the segment.

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

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

object

Remarks

Type union: either IResolvable or CfnSegment.ISegmentGroupsProperty

SegmentRef

A reference to a Segment resource.

public virtual ISegmentReference SegmentRef { get; }

Property Value

ISegmentReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

TagsRaw

An array of key-value pairs to apply to this resource.

public virtual object TagsRaw { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

Methods

ArnForSegment(ISegmentRef)

Updates the configuration, dimension, and other settings for an existing segment.

public static string ArnForSegment(ISegmentRef resource)

Parameters

resource ISegmentRef

Returns

string

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
             });

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

IsCfnSegment(object)

Checks whether the given object is a CfnSegment.

public static bool IsCfnSegment(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Updates the configuration, dimension, and other settings for an existing segment.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-pinpoint-segment.html

CloudformationResource: AWS::Pinpoint::Segment

ExampleMetadata: fixture=_generated

Implements

IInspectable

ISegmentRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable