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

Inherits:

Struct

• Object
• Struct
• Aws::IdentityStore::Types::Group

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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:display_name, :description]

Instance Attribute Summary

• #created_at ⇒ Time

  The date and time the group was created.

• #created_by ⇒ String

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

• #description ⇒ String

  A string containing a description of the specified group.

• #display_name ⇒ String

  The display name value for the group.

• #external_ids ⇒ Array<Types::ExternalId>

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

• #group_arn ⇒ String

  The Amazon Resource Name (ARN) of the group in the identity store.

• #group_id ⇒ String

  The identifier for a group in the identity store.

• #identity_store_id ⇒ String

  The globally unique identifier for the identity store.

• #revision ⇒ String

  The current revision of the group in the identity store.

• #updated_at ⇒ Time

  The date and time the group was last updated.

• #updated_by ⇒ String

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

Instance Attribute Details

#created_at ⇒ Time

The date and time the group was created.

Returns:

• (Time)

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

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

#created_by ⇒ String

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

Returns:

• (String)

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

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

#description ⇒ String

A string containing a description of the specified group.

Returns:

• (String)

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

class Group < Struct.new(
  :identity_store_id,
  :group_id,
  :group_arn,
  :revision,
  :display_name,
  :external_ids,
  :description,
  :created_at,
  :updated_at,
  :created_by,
  :updated_by)
  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.

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

Returns:

• (String)

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

class Group < Struct.new(
  :identity_store_id,
  :group_id,
  :group_arn,
  :revision,
  :display_name,
  :external_ids,
  :description,
  :created_at,
  :updated_at,
  :created_by,
  :updated_by)
  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:

• (Array<Types::ExternalId>)

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

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

#group_arn ⇒ String

The Amazon Resource Name (ARN) of the group in the identity store. For example, arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222.

Returns:

• (String)

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

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

#group_id ⇒ String

The identifier for a group in the identity store.

Returns:

• (String)

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

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

#identity_store_id ⇒ String

The globally unique identifier for the identity store.

Returns:

• (String)

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

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

#revision ⇒ String

The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the Revision parameter of an UpdateGroup or DeleteGroup request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.

Returns:

• (String)

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

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

#updated_at ⇒ Time

The date and time the group was last updated.

Returns:

• (Time)

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

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

#updated_by ⇒ String

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

Returns:

• (String)

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

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