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.

Constant Summary collapse

SENSITIVE =
[:display_name, :description]

Instance Attribute Summary collapse

Instance Attribute Details

#created_atTime

The date and time the group was created.

Returns:

  • (Time)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#created_byString

The identifier of the user or system that created the group.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#descriptionString

A string containing a description of the specified group.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#display_nameString

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.

Prefix search supports a maximum of 1,000 characters for the string.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#external_idsArray<Types::ExternalId>

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

Returns:



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#group_idString

The identifier for a group in the identity store.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#identity_store_idString

The globally unique identifier for the identity store.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#updated_atTime

The date and time the group was last updated.

Returns:

  • (Time)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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

#updated_byString

The identifier of the user or system that last updated the group.

Returns:

  • (String)


1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
# File 'gems/aws-sdk-identitystore/lib/aws-sdk-identitystore/types.rb', line 1017

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