Class: AWSCDK::Pinpoint::CfnSegment::SetDimensionProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pinpoint::CfnSegment::SetDimensionProperty

Defined in:

pinpoint/cfn_segment.rb

Overview

Specifies the dimension type and values for a segment dimension.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html

Instance Attribute Summary

• #dimension_type ⇒ String^? readonly

  The type of segment dimension to use.

• #values ⇒ Array<String>^? readonly

  The criteria values to use for the segment dimension.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(dimension_type: nil, values: nil) ⇒ SetDimensionProperty constructor

  A new instance of SetDimensionProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(dimension_type: nil, values: nil) ⇒ SetDimensionProperty

Returns a new instance of SetDimensionProperty.

Parameters:

• dimension_type (String, nil) (defaults to: nil) —

  The type of segment dimension to use.

• values (Array<String>, nil) (defaults to: nil) —

  The criteria values to use for the segment dimension.

# File 'pinpoint/cfn_segment.rb', line 1109

def initialize(dimension_type: nil, values: nil)
  @dimension_type = dimension_type
  Jsii::Type.check_type(@dimension_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dimensionType") unless @dimension_type.nil?
  @values = values
  Jsii::Type.check_type(@values, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "values") unless @values.nil?
end

Instance Attribute Details

#dimension_type ⇒ String^? (readonly)

The type of segment dimension to use.

Valid values are: INCLUSIVE , endpoints that match the criteria are included in the segment; and, EXCLUSIVE , endpoints that match the criteria are excluded from the segment.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-dimensiontype

# File 'pinpoint/cfn_segment.rb', line 1122

def dimension_type
  @dimension_type
end

#values ⇒ Array<String>^? (readonly)

The criteria values to use for the segment dimension.

Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-segment-setdimension.html#cfn-pinpoint-segment-setdimension-values

# File 'pinpoint/cfn_segment.rb', line 1129

def values
  @values
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint/cfn_segment.rb', line 1131

def self.jsii_properties
  {
    :dimension_type => "dimensionType",
    :values => "values",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint/cfn_segment.rb', line 1138

def to_jsii
  result = {}
  result.merge!({
    "dimensionType" => @dimension_type,
    "values" => @values,
  })
  result.compact
end