Aws/ssmcontacts
@swamp/aws/ssmcontactsv2026.10.25.1
01README
AWS SSMCONTACTS infrastructure models
02Behaviors
@swamp/aws/ssmcontacts/contactv2026.10.23.1contact.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. |
| Alias | string | Alias of the contact. String value with 20 to 256 characters. Only alphabetical, numeric characters, dash, or underscore allowed. |
| DisplayName | string | Name of the contact. String value with 3 to 256 characters. Only alphabetical, space, numeric characters, dash, or underscore allowed. |
| Type | enum | Contact type, which specify type of contact. Currently supported values: “PERSONAL”, “SHARED”, “OTHER“. |
| Plan? | array | The stages that an escalation plan or engagement plan engages contacts and contact methods in. |
| Tags? | array |
fn create()
Create a SSMContacts Contact
fn get(identifier: string)
Get a SSMContacts Contact
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Contact |
fn update()
Update a SSMContacts Contact
fn delete(identifier: string)
Delete a SSMContacts Contact
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Contact |
fn sync()
Sync SSMContacts Contact state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SSMContacts Contact 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)— SSMContacts Contact resource state
@swamp/aws/ssmcontacts/contact-channelv2026.10.23.1contact_channel.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. |
| ContactId? | string | ARN of the contact resource |
| ChannelName? | string | The device name. String of 6 to 50 alphabetical, numeric, dash, and underscore characters. |
| ChannelType? | enum | Device type, which specify notification channel. Currently supported values: “SMS”, “VOICE”, “EMAIL”, “CHATBOT. |
| DeferActivation? | boolean | If you want to activate the channel at a later time, you can choose to defer activation. SSM Incident Manager can't engage your contact channel until it has been activated. |
| ChannelAddress? | string | The details that SSM Incident Manager uses when trying to engage the contact channel. |
fn create()
Create a SSMContacts ContactChannel
fn get(identifier: string)
Get a SSMContacts ContactChannel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts ContactChannel |
fn update()
Update a SSMContacts ContactChannel
fn delete(identifier: string)
Delete a SSMContacts ContactChannel
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts ContactChannel |
fn sync()
Sync SSMContacts ContactChannel state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SSMContacts ContactChannel 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)— SSMContacts ContactChannel resource state
@swamp/aws/ssmcontacts/planv2026.10.23.1plan.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. |
| ContactId? | string | Contact ID for the AWS SSM Incident Manager Contact to associate the plan. |
| Stages? | array | The stages that an escalation plan or engagement plan engages contacts and contact methods in. |
| RotationIds? | array | Rotation Ids to associate with Oncall Contact for engagement. |
fn create()
Create a SSMContacts Plan
fn get(identifier: string)
Get a SSMContacts Plan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Plan |
fn update()
Update a SSMContacts Plan
fn delete(identifier: string)
Delete a SSMContacts Plan
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Plan |
fn sync()
Sync SSMContacts Plan state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SSMContacts Plan 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)— SSMContacts Plan resource state
@swamp/aws/ssmcontacts/rotationv2026.10.23.1rotation.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. |
| Name | string | Name of the Rotation |
| ContactIds | array | Members of the rotation |
| StartTime | string | Start time of the first shift of Oncall Schedule |
| TimeZoneId | string | TimeZone Identifier for the Oncall Schedule |
| Recurrence | object | Information about when an on-call rotation is in effect and how long the rotation period lasts. |
| Tags? | array |
fn create()
Create a SSMContacts Rotation
fn get(identifier: string)
Get a SSMContacts Rotation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Rotation |
fn update()
Update a SSMContacts Rotation
fn delete(identifier: string)
Delete a SSMContacts Rotation
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the SSMContacts Rotation |
fn sync()
Sync SSMContacts Rotation state from AWS
fn list(maxPages?: number, resourceModel?: string)
List SSMContacts Rotation 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)— SSMContacts Rotation resource state
03Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: contact, contact_channel, plan, rotation
2026.10.13.1
- Updated: contact, contact_channel, plan, rotation
2026.10.08.1
2026.10.06.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.21.1
2026.09.20.1
2026.09.19.1
04Stats
A
100 / 100
Downloads
115
Archive size
827.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