Class: AWSCDK::Pinpoint::CfnSegment::GroupsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
pinpoint/cfn_segment.rb

Overview

An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dimensions: nil, source_segments: nil, source_type: nil, type: nil) ⇒ GroupsProperty

Returns a new instance of GroupsProperty.

Parameters:



820
821
822
823
824
825
826
827
828
829
 
# File 'pinpoint/cfn_segment.rb', line 820

def initialize(dimensions: nil, source_segments: nil, source_type: nil, type: nil)
  @dimensions = dimensions
  Jsii::Type.check_type(@dimensions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlucG9pbnQuQ2ZuU2VnbWVudC5TZWdtZW50RGltZW5zaW9uc1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "dimensions") unless @dimensions.nil?
  @source_segments = source_segments
  Jsii::Type.check_type(@source_segments, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcGlucG9pbnQuQ2ZuU2VnbWVudC5Tb3VyY2VTZWdtZW50c1Byb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "sourceSegments") unless @source_segments.nil?
  @source_type = source_type
  Jsii::Type.check_type(@source_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceType") unless @source_type.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

#dimensions ⇒ AWSCDK::IResolvable, ... (readonly)

An array that defines the dimensions to include or exclude from the segment.

Returns:

See Also:



835
836
837
 
# File 'pinpoint/cfn_segment.rb', line 835

def dimensions
  @dimensions
end

#source_segments ⇒ AWSCDK::IResolvable, ... (readonly)

The base segment to build the segment on.

A base segment, also called a source segment , defines the initial population of endpoints for a segment. When you add dimensions to the segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify.

You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the segment size estimate that displays on the Amazon Pinpoint console indicates the size of the imported segment without any filters applied to it.

Returns:

See Also:



844
845
846
 
# File 'pinpoint/cfn_segment.rb', line 844

def source_segments
  @source_segments
end

#source_type ⇒ String? (readonly)

Specifies how to handle multiple base segments for the segment.

For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.

Returns:

  • (String, nil)

See Also:



851
852
853
 
# File 'pinpoint/cfn_segment.rb', line 851

def source_type
  @source_type
end

#type ⇒ String? (readonly)

Specifies how to handle multiple dimensions for the segment.

For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.

Returns:

  • (String, nil)

See Also:



858
859
860
 
# File 'pinpoint/cfn_segment.rb', line 858

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



860
861
862
863
864
865
866
867
 
# File 'pinpoint/cfn_segment.rb', line 860

def self.jsii_properties
  {
    :dimensions => "dimensions",
    :source_segments => "sourceSegments",
    :source_type => "sourceType",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



869
870
871
872
873
874
875
876
877
878
 
# File 'pinpoint/cfn_segment.rb', line 869

def to_jsii
  result = {}
  result.merge!({
    "dimensions" => @dimensions,
    "sourceSegments" => @source_segments,
    "sourceType" => @source_type,
    "type" => @type,
  })
  result.compact
end