Class: Aws::PinpointSMSVoiceV2::Types::TemplateVariableMetadata

Inherits:

Struct

• Object
• Struct
• Aws::PinpointSMSVoiceV2::Types::TemplateVariableMetadata

Includes:

Structure

Defined in:

lib/aws-sdk-pinpointsmsvoicev2/types.rb

Overview

Contains metadata about a template variable.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #default_value ⇒ String

  The default value for the variable.

• #description ⇒ String

  A description of the variable.

• #max_length ⇒ Integer

  The maximum length for string variables.

• #max_value ⇒ Integer

  The maximum value for numeric variables.

• #min_value ⇒ Integer

  The minimum value for numeric variables.

• #pattern ⇒ String

  The regex pattern the variable value must match.

• #required ⇒ Boolean

  Whether the variable is required.

• #sample ⇒ String

  A sample value for the variable.

• #source ⇒ String

  The source of the variable, either CUSTOMER or SYSTEM.

• #type ⇒ String

  The type of the variable.

Instance Attribute Details

#default_value ⇒ String

The default value for the variable.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the variable.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#max_length ⇒ Integer

The maximum length for string variables.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#max_value ⇒ Integer

The maximum value for numeric variables.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#min_value ⇒ Integer

The minimum value for numeric variables.

Returns:

• (Integer)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#pattern ⇒ String

The regex pattern the variable value must match.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#required ⇒ Boolean

Whether the variable is required.

Returns:

• (Boolean)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#sample ⇒ String

A sample value for the variable.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The source of the variable, either CUSTOMER or SYSTEM.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of the variable.

Returns:

• (String)

# File 'lib/aws-sdk-pinpointsmsvoicev2/types.rb', line 9206

class TemplateVariableMetadata < Struct.new(
  :type,
  :required,
  :description,
  :max_length,
  :min_value,
  :max_value,
  :default_value,
  :pattern,
  :sample,
  :source)
  SENSITIVE = []
  include Aws::Structure
end