Aws/identitystore
@swamp/aws/identitystorev2026.10.25.1
01README
AWS IDENTITYSTORE infrastructure models
02Behaviors
@swamp/aws/identitystore/groupv2026.10.23.1group.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| Description? | string | A string containing the description of the group. |
| DisplayName | string | A string containing the name of the group. This value is commonly displayed when the group is referenced. |
| IdentityStoreId | string | The globally unique identifier for the identity store. |
fn create()
Create a IdentityStore Group
fn get(identifier: string)
Get a IdentityStore Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore Group |
fn update()
Update a IdentityStore Group
fn delete(identifier: string)
Delete a IdentityStore Group
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore Group |
fn sync()
Sync IdentityStore Group state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IdentityStore Group resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— IdentityStore Group resource state
@swamp/aws/identitystore/group-membershipv2026.10.23.1group_membership.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| GroupId | string | The unique identifier for a group in the identity store. |
| IdentityStoreId | string | The globally unique identifier for the identity store. |
| MemberId | object | An object containing the identifier of a group member. |
fn create()
Create a IdentityStore GroupMembership
fn get(identifier: string)
Get a IdentityStore GroupMembership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore GroupMembership |
fn delete(identifier: string)
Delete a IdentityStore GroupMembership
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore GroupMembership |
fn sync()
Sync IdentityStore GroupMembership state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IdentityStore GroupMembership resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— IdentityStore GroupMembership resource state
@swamp/aws/identitystore/userv2026.10.23.1user.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessKeyId? | string | AWS access key ID; overrides AWS_ACCESS_KEY_ID environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| secretAccessKey? | string | AWS secret access key; overrides AWS_SECRET_ACCESS_KEY environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| sessionToken? | string | AWS session token for temporary credentials; overrides AWS_SESSION_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| region? | string | AWS region; overrides AWS_REGION / AWS_DEFAULT_REGION environment variables and ~/.aws/config profile region. Defaults to us-east-1. |
| IdentityStoreId | string | The globally unique identifier for the identity store. |
| UserName? | string | A unique string used to identify the user. |
| Name? | object | The name of the user. |
| DisplayName? | string | A string containing the name of the user for display. |
| NickName? | string | An alternate name for the user. |
| ProfileUrl? | string | A URL associated with the user. |
| Emails? | array | A list of email addresses associated with the user. |
| Addresses? | array | A list of addresses associated with the user. |
| PhoneNumbers? | array | A list of phone numbers associated with the user. |
| UserType? | string | A string indicating the type of user. |
| Title? | string | The title of the user. |
| PreferredLanguage? | string | The preferred language of the user. |
| Locale? | string | The geographical region or location of the user. |
| Timezone? | string | The time zone for the user. |
| Photos? | array | A list of photos associated with the user. |
| Website? | string | The user's personal website or blog URL. |
| Birthdate? | string | The user's birthdate in YYYY-MM-DD format. |
| Roles? | array | A list of roles associated with the user. |
fn create()
Create a IdentityStore User
fn get(identifier: string)
Get a IdentityStore User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore User |
fn update()
Update a IdentityStore User
fn delete(identifier: string)
Delete a IdentityStore User
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the IdentityStore User |
fn sync()
Sync IdentityStore User state from AWS
fn list(maxPages?: number, resourceModel?: string)
List IdentityStore User resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
| resourceModel? | string | JSON resource model for parent-scoped listing (e.g. parent identifier) |
Resources
state(infinite)— IdentityStore User resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: group, group_membership, user
2026.10.13.1
- Updated: group, group_membership, user
2026.10.08.1
2026.10.06.1
2026.10.04.1
2026.10.03.1
2026.10.02.1
2026.10.01.1
2026.09.30.1
2026.09.29.1
2026.09.28.1
2026.09.27.1
2026.09.26.1
2026.09.25.1
2026.09.24.1
2026.09.23.1
2026.09.22.1
2026.09.21.1
04Stats
A
100 / 100
Downloads
58
Archive size
621.2 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
05Platforms
06Labels