Class: Aws::IdentityStore::Types::Photo

Inherits:

Struct

• Object
• Struct
• Aws::IdentityStore::Types::Photo

Includes:

Structure

Defined in:

lib/aws-sdk-identitystore/types.rb

Overview

Contains information about a user’s photo. Users can have up to 3 photos, with one designated as primary. Supports common image formats, including jpg, jpeg, png, and gif.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:value, :type, :display, :primary]

Instance Attribute Summary

• #display ⇒ String

  A human-readable description of the photo for display purposes.

• #primary ⇒ Boolean

  Specifies whether this is the user’s primary photo.

• #type ⇒ String

  The type of photo.

• #value ⇒ String

  The photo data or URL.

Instance Attribute Details

#display ⇒ String

A human-readable description of the photo for display purposes. This optional field provides context about the photo.

Returns:

• (String)

# File 'lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#primary ⇒ Boolean

Specifies whether this is the user’s primary photo. Default value is ‘false`. Only one photo can be designated as primary per user.

Returns:

• (Boolean)

# File 'lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#type ⇒ String

The type of photo. This field is optional and can be used to categorize different types of photos.

Returns:

• (String)

# File 'lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end

#value ⇒ String

The photo data or URL. Supported formats include jpg, jpeg, png, and gif. This field is required for all photo entries.

Returns:

• (String)

# File 'lib/aws-sdk-identitystore/types.rb', line 1532

class Photo < Struct.new(
  :value,
  :type,
  :display,
  :primary)
  SENSITIVE = [:value, :type, :display, :primary]
  include Aws::Structure
end