Class: AWSCDK::Pinpoint::CfnSegment::SourceSegmentsProperty

Inherits:

Jsii::Struct

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

Defined in:

pinpoint/cfn_segment.rb

Overview

Specifies 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.

See Also:

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

Instance Attribute Summary

• #id ⇒ String readonly

  The unique identifier for the source segment.

• #version ⇒ Numeric^? readonly

  The version number of the source segment.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(id:, version: nil) ⇒ SourceSegmentsProperty constructor

  A new instance of SourceSegmentsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(id:, version: nil) ⇒ SourceSegmentsProperty

Returns a new instance of SourceSegmentsProperty.

Parameters:

• id (String) —

  The unique identifier for the source segment.

• version (Numeric, nil) (defaults to: nil) —

  The version number of the source segment.

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

def initialize(id:, version: nil)
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  @version = version
  Jsii::Type.check_type(@version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "version") unless @version.nil?
end

Instance Attribute Details

#id ⇒ String (readonly)

The unique identifier for the source segment.

Returns:

• (String)

See Also:

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

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

def id
  @id
end

#version ⇒ Numeric^? (readonly)

The version number of the source segment.

Returns:

• (Numeric, nil)

See Also:

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

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

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :id => "id",
    :version => "version",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "id" => @id,
    "version" => @version,
  })
  result.compact
end