Aws/ram
@swamp/aws/ramv2026.10.25.1
01README
AWS RAM infrastructure models
02Release Notes
- Updated: resource_share
03Behaviors
@swamp/aws/ram/permissionv2026.10.23.1permission.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. |
| ResourceType | string | The resource type this permission can be used with. |
| PolicyTemplate | record | Policy template for the permission. |
| Tags? | array | |
| Name | string | The name of the permission. |
fn create()
Create a RAM Permission
fn get(identifier: string)
Get a RAM Permission
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM Permission |
fn update()
Update a RAM Permission
fn delete(identifier: string)
Delete a RAM Permission
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM Permission |
fn sync()
Sync RAM Permission state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM Permission 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)— RAM Permission resource state
@swamp/aws/ram/permission-associationv2026.10.23.1permission_association.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. |
| Replace? | boolean | Specifies whether to replace the existing permission on the resource share. Use `true` to replace the current permission. Use `false` to add the permission when no permission is currently associated. The default value is `false`. Updating an existing association also requires `true`, because AWS RAM applies the change by re-associating the permission. |
| ResourceShareArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource share. |
| PermissionArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. |
fn create()
Create a RAM PermissionAssociation
fn get(identifier: string)
Get a RAM PermissionAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM PermissionAssociation |
fn update()
Update a RAM PermissionAssociation
fn delete(identifier: string)
Delete a RAM PermissionAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM PermissionAssociation |
fn sync()
Sync RAM PermissionAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM PermissionAssociation 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)— RAM PermissionAssociation resource state
@swamp/aws/ram/principal-associationv2026.10.23.1principal_association.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. |
| ResourceShareArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource share. |
| Principal | string | Specifies the principal to associate with the resource share. The possible values are: - An AWS account ID - An Amazon Resource Name (ARN) of an organization in AWS Organizations - An ARN of an organizational unit (OU) in AWS Organizations - An ARN of an IAM role - An ARN of an IAM user |
fn create()
Create a RAM PrincipalAssociation
fn get(identifier: string)
Get a RAM PrincipalAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM PrincipalAssociation |
fn delete(identifier: string)
Delete a RAM PrincipalAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM PrincipalAssociation |
fn sync()
Sync RAM PrincipalAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM PrincipalAssociation 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)— RAM PrincipalAssociation resource state
@swamp/aws/ram/resource-associationv2026.10.23.1resource_association.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. |
| ResourceShareArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource share. |
| ResourceArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource to associate with the resource share. |
fn create()
Create a RAM ResourceAssociation
fn get(identifier: string)
Get a RAM ResourceAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM ResourceAssociation |
fn delete(identifier: string)
Delete a RAM ResourceAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM ResourceAssociation |
fn sync()
Sync RAM ResourceAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM ResourceAssociation 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)— RAM ResourceAssociation resource state
@swamp/aws/ram/resource-sharev2026.10.25.1resource_share.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. |
| ResourceShareConfiguration? | object | Specifies the configuration for the resource share |
| PermissionArns? | array | Specifies the [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the AWS RAM permission to associate with the resource share. If you do not specify an ARN for the permission, AWS RAM automatically attaches the default version of the permission for each resource type. You can associate only one permission with each resource type included in the resource share. |
| Principals? | array | Specifies the principals to associate with the resource share. The possible values are: - An AWS account ID - An Amazon Resource Name (ARN) of an organization in AWS Organizations - An ARN of an organizational unit (OU) in AWS Organizations - An ARN of an IAM role - An ARN of an IAM user |
| Sources? | array | Specifies from which source accounts the service principal has access to the resources in this resource share. |
| Name | string | Specifies the name of the resource share. |
| AllowExternalPrincipals? | boolean | Specifies whether principals outside your organization in AWS Organizations can be associated with a resource share. A value of `true` lets you share with individual AWS accounts that are not in your organization. A value of `false` only has meaning if your account is a member of an AWS Organization. The default value is `true`. |
| ResourceArns? | array | Specifies a list of one or more ARNs of the resources to associate with the resource share. |
| Tags? | array | Specifies one or more tags to attach to the resource share itself. It doesn't attach the tags to the resources associated with the resource share. |
fn create()
Create a RAM ResourceShare
fn get(identifier: string)
Get a RAM ResourceShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM ResourceShare |
fn update()
Update a RAM ResourceShare
fn delete(identifier: string)
Delete a RAM ResourceShare
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM ResourceShare |
fn sync()
Sync RAM ResourceShare state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM ResourceShare 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)— RAM ResourceShare resource state
@swamp/aws/ram/source-associationv2026.10.23.1source_association.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. |
| ResourceShareArn | string | Specifies the [Amazon Resource Name (ARN)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) of the resource share. |
| SourceId | string | Specifies the ID of the source account to associate with the resource share. |
fn create()
Create a RAM SourceAssociation
fn get(identifier: string)
Get a RAM SourceAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM SourceAssociation |
fn delete(identifier: string)
Delete a RAM SourceAssociation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the RAM SourceAssociation |
fn sync()
Sync RAM SourceAssociation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List RAM SourceAssociation 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)— RAM SourceAssociation resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: permission, permission_association, principal_association, resource_association, resource_share, source_association
2026.10.13.1
- Updated: permission, permission_association, principal_association, resource_association, resource_share, source_association
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
- Added: permission_association, principal_association, resource_association, source_association
Added 4 behaviors
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
05Stats
A
100 / 100
Downloads
116
Archive size
1.2 MB
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
06Platforms
07Labels