Class: AWSCDK::Pinpoint::CfnCampaign::TemplateProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::Pinpoint::CfnCampaign::TemplateProperty

Defined in:

pinpoint/cfn_campaign.rb

Overview

Specifies the name and version of the message template to use for the message.

See Also:

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

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of the message template to use for the message.

• #version ⇒ String^? readonly

  The unique identifier for the version of the message template to use for the message.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, version: nil) ⇒ TemplateProperty constructor

  A new instance of TemplateProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, version: nil) ⇒ TemplateProperty

Returns a new instance of TemplateProperty.

Parameters:

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

  The name of the message template to use for the message.

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

  The unique identifier for the version of the message template to use for the message.

# File 'pinpoint/cfn_campaign.rb', line 2316

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

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of the message template to use for the message.

If specified, this value must match the name of an existing message template.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-pinpoint-campaign-template.html#cfn-pinpoint-campaign-template-name

# File 'pinpoint/cfn_campaign.rb', line 2329

def name
  @name
end

#version ⇒ String^? (readonly)

The unique identifier for the version of the message template to use for the message.

If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.

If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.

Returns:

• (String, nil)

See Also:

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

# File 'pinpoint/cfn_campaign.rb', line 2338

def version
  @version
end

Class Method Details

.jsii_properties ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 2340

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

Instance Method Details

#to_jsii ⇒ Object

# File 'pinpoint/cfn_campaign.rb', line 2347

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