Class: Aws::IdentityStore::Types::Group

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb

Overview

A group object that contains the metadata and attributes for a specified group.

See Also:

Constant Summary collapse

SENSITIVE = 
[:display_name, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ String

A string containing a description of the specified group.

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 868

class Group < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#display_name ⇒ String

The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 868

class Group < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#external_ids ⇒ Array<Types::ExternalId>

A list of ExternalId objects that contains the identifiers issued to this resource by an external identity provider.

Returns:



868
869
870
871
872
873
874
875
876
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 868

class Group < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#group_id ⇒ String

The identifier for a group in the identity store.

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 868

class Group < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end

#identity_store_id ⇒ String

The globally unique identifier for the identity store.

Returns:

  • (String) 


868
869
870
871
872
873
874
875
876
 
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 868

class Group < Struct.new(
  :group_id,
  :display_name,
  :external_ids,
  :description,
  :identity_store_id)
  SENSITIVE = [:display_name, :description]
  include Aws::Structure
end