Aws/odb
@swamp/aws/odbv2026.10.25.1
01README
AWS ODB infrastructure models
02Release Notes
- Updated: cloud_vm_cluster
03Behaviors
@swamp/aws/odb/cloud-autonomous-vm-clusterv2026.10.23.1cloud_autonomous_vm_cluster.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. |
| OdbNetworkId? | string | The unique identifier of the ODB network associated with this Autonomous VM cluster. |
| DisplayName? | string | The display name of the Autonomous VM cluster. |
| CloudExadataInfrastructureId? | string | The unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster. |
| AutonomousDataStorageSizeInTBs? | number | The data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB. |
| CpuCoreCountPerNode? | number | The number of CPU cores enabled per node in the Autonomous VM cluster. |
| DbServers? | array | The list of database servers associated with the Autonomous VM cluster. |
| Description? | string | The user-provided description of the Autonomous VM cluster. |
| IsMtlsEnabledVmCluster? | boolean | Indicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster. |
| LicenseModel? | enum | The Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE. |
| MaintenanceWindow? | object | The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. |
| MemoryPerOracleComputeUnitInGBs? | number | The amount of memory allocated per Oracle Compute Unit, in GB. |
| ScanListenerPortNonTls? | number | The SCAN listener port for non-TLS (TCP) protocol. The default is 1521. |
| ScanListenerPortTls? | number | The SCAN listener port for TLS (TCP) protocol. The default is 2484. |
| Tags? | array | The tags associated with the Autonomous VM cluster. |
| TimeZone? | string | The time zone of the Autonomous VM cluster. |
| TotalContainerDatabases? | number | The total number of Autonomous Container Databases that can be created with the allocated local storage. |
| IamRoles? | array | The AWS Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster. |
fn create()
Create a ODB CloudAutonomousVmCluster
fn get(identifier: string)
Get a ODB CloudAutonomousVmCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudAutonomousVmCluster |
fn update()
Update a ODB CloudAutonomousVmCluster
fn delete(identifier: string)
Delete a ODB CloudAutonomousVmCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudAutonomousVmCluster |
fn sync()
Sync ODB CloudAutonomousVmCluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ODB CloudAutonomousVmCluster 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)— ODB CloudAutonomousVmCluster resource state
@swamp/aws/odb/cloud-exadata-infrastructurev2026.10.23.1cloud_exadata_infrastructure.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. |
| AvailabilityZone? | string | The name of the Availability Zone (AZ) where the Exadata infrastructure is located. |
| AvailabilityZoneId? | string | The AZ ID of the AZ where the Exadata infrastructure is located. |
| MaintenanceWindow? | object | The scheduling details for the maintenance window. Patching and system updates take place during the maintenance window. |
| ComputeCount? | number | The number of database servers for the Exadata infrastructure. |
| CustomerContactsToSendToOCI? | array | The email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure. |
| DatabaseServerType? | string | The database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. |
| DisplayName? | string | The user-friendly name for the Exadata infrastructure. |
| Shape? | string | The model name of the Exadata infrastructure. |
| StorageCount? | number | The number of storage servers that are activated for the Exadata infrastructure. |
| StorageServerType? | string | The storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation. |
| Tags? | array | Tags to assign to the Exadata Infrastructure. |
fn create()
Create a ODB CloudExadataInfrastructure
fn get(identifier: string)
Get a ODB CloudExadataInfrastructure
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudExadataInfrastructure |
fn update()
Update a ODB CloudExadataInfrastructure
fn delete(identifier: string)
Delete a ODB CloudExadataInfrastructure
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudExadataInfrastructure |
fn sync()
Sync ODB CloudExadataInfrastructure state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ODB CloudExadataInfrastructure 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)— ODB CloudExadataInfrastructure resource state
@swamp/aws/odb/cloud-vm-clusterv2026.10.25.1cloud_vm_cluster.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. |
| CloudExadataInfrastructureId? | string | The unique identifier of the Exadata infrastructure that this VM cluster belongs to. |
| ClusterName? | string | The name of the Grid Infrastructure (GI) cluster. |
| CpuCoreCount? | number | The number of CPU cores enabled on the VM cluster. |
| DataCollectionOptions? | object | The set of diagnostic collection options enabled for the VM cluster. |
| DataStorageSizeInTBs? | number | The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster. |
| DbNodeStorageSizeInGBs? | number | The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster. |
| DisplayName? | string | The user-friendly name for the VM cluster. |
| GiVersion? | string | The software version of the Oracle Grid Infrastructure (GI) for the VM cluster. |
| Hostname? | string | The host name for the VM cluster. |
| IsLocalBackupEnabled? | boolean | Indicates whether database backups to local Exadata storage is enabled for the VM cluster. |
| IsSparseDiskgroupEnabled? | boolean | Indicates whether the VM cluster is configured with a sparse disk group. |
| LicenseModel? | enum | The Oracle license model applied to the VM cluster. |
| MemorySizeInGBs? | number | The amount of memory, in gigabytes (GB), that's allocated for the VM cluster. |
| OdbNetworkId? | string | The unique identifier of the ODB network for the VM cluster. |
| ScanListenerPortTcp? | number | Property description not available. |
| SshPublicKeys? | array | The public key portion of one or more key pairs used for SSH access to the VM cluster. |
| SystemVersion? | string | The operating system version of the image chosen for the VM cluster. |
| Tags? | array | Tags to assign to the Vm Cluster. |
| TimeZone? | string | The time zone of the VM cluster. |
| DbServers? | array | The list of database servers for the VM cluster. |
| DbNodes? | array | The DB nodes that are implicitly created and managed as part of this VM Cluster. |
| IamRoles? | array | The AWS Identity and Access Management (IAM) service roles associated with the VM cluster. |
fn create()
Create a ODB CloudVmCluster
fn get(identifier: string)
Get a ODB CloudVmCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudVmCluster |
fn update()
Update a ODB CloudVmCluster
fn delete(identifier: string)
Delete a ODB CloudVmCluster
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB CloudVmCluster |
fn sync()
Sync ODB CloudVmCluster state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ODB CloudVmCluster 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)— ODB CloudVmCluster resource state
@swamp/aws/odb/odb-networkv2026.10.23.1odb_network.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. |
| AvailabilityZone? | string | The AWS Availability Zone (AZ) where the ODB network is located. |
| AvailabilityZoneId? | string | The AZ ID of the AZ where the ODB network is located. |
| BackupSubnetCidr? | string | The CIDR range of the backup subnet in the ODB network. |
| ClientSubnetCidr? | string | The CIDR range of the client subnet in the ODB network. |
| CustomDomainName? | string | The domain name to use for the resources in the ODB network. |
| DefaultDnsPrefix? | string | The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com. |
| DeleteAssociatedResources? | boolean | Specifies whether to delete associated OCI networking resources along with the ODB network. |
| DisplayName? | string | The user-friendly name of the ODB network. |
| S3Access? | enum | Specifies the configuration for Amazon S3 access from the ODB network. |
| S3PolicyDocument? | string | Specifies the endpoint policy for Amazon S3 access from the ODB network. |
| KmsAccess? | enum | The AWS Key Management Service (KMS) access configuration for the ODB network. |
| KmsPolicyDocument? | string | The AWS Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network. |
| StsAccess? | enum | The AWS Security Token Service (STS) access configuration for the ODB network. |
| StsPolicyDocument? | string | The AWS Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network. |
| CrossRegionS3RestoreSources? | array | The cross-Region Amazon S3 restore sources for the ODB network. |
| Tags? | array | Tags to assign to the Odb Network. |
| ManagedServices? | object | The managed services configuration for the ODB network. |
| ZeroEtlAccess? | enum | Specifies the configuration for Zero-ETL access from the ODB network. |
fn create()
Create a ODB OdbNetwork
fn get(identifier: string)
Get a ODB OdbNetwork
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB OdbNetwork |
fn update()
Update a ODB OdbNetwork
fn delete(identifier: string)
Delete a ODB OdbNetwork
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB OdbNetwork |
fn sync()
Sync ODB OdbNetwork state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ODB OdbNetwork 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)— ODB OdbNetwork resource state
@swamp/aws/odb/odb-peering-connectionv2026.10.23.1odb_peering_connection.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. |
| AdditionalPeerNetworkCidrs? | array | The additional CIDR blocks for the ODB peering connection. |
| DisplayName? | string | The name of the ODB peering connection. |
| OdbNetworkId? | string | The unique identifier of the ODB network. |
| PeerNetworkId? | string | The unique identifier of the peer network. |
| PeerNetworkRouteTableIds? | array | The unique identifier of the VPC route table for which a route to the ODB network is automatically created during peering connection establishment. |
| Tags? | array | Tags to assign to the Odb peering connection. |
fn create()
Create a ODB OdbPeeringConnection
fn get(identifier: string)
Get a ODB OdbPeeringConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB OdbPeeringConnection |
fn update()
Update a ODB OdbPeeringConnection
fn delete(identifier: string)
Delete a ODB OdbPeeringConnection
| Argument | Type | Description |
|---|---|---|
| identifier | string | The primary identifier of the ODB OdbPeeringConnection |
fn sync()
Sync ODB OdbPeeringConnection state from AWS
fn list(maxPages?: number, resourceModel?: string)
List ODB OdbPeeringConnection 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)— ODB OdbPeeringConnection resource state
04Previous Versions
2026.10.24.1AGPL-3.0-or-later
2026.10.23.1AGPL-3.0-or-later(was none)
- Updated: cloud_autonomous_vm_cluster, cloud_exadata_infrastructure, cloud_vm_cluster, odb_network, odb_peering_connection
2026.10.13.1
- Updated: cloud_autonomous_vm_cluster, cloud_exadata_infrastructure, cloud_vm_cluster, odb_network, odb_peering_connection
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
05Stats
A
100 / 100
Downloads
117
Archive size
1.0 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