Skip to main content

@swamp/aws/odb

v2026.04.23.3

AWS ODB infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsodbcloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/odb

@swamp/aws/odb/cloud-autonomous-vm-clusterv2026.04.23.2cloud_autonomous_vm_cluster.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
OdbNetworkId?stringThe unique identifier of the ODB network associated with this Autonomous VM cluster.
DisplayName?stringThe display name of the Autonomous VM cluster.
CloudExadataInfrastructureId?stringThe unique identifier of the Cloud Exadata Infrastructure containing this Autonomous VM cluster.
AutonomousDataStorageSizeInTBs?numberThe data storage size allocated for Autonomous Databases in the Autonomous VM cluster, in TB.
CpuCoreCountPerNode?numberThe number of CPU cores enabled per node in the Autonomous VM cluster.
DbServers?arrayThe list of database servers associated with the Autonomous VM cluster.
Description?stringThe user-provided description of the Autonomous VM cluster.
IsMtlsEnabledVmCluster?booleanIndicates whether mutual TLS (mTLS) authentication is enabled for the Autonomous VM cluster.
LicenseModel?enumThe Oracle license model that applies to the Autonomous VM cluster. Valid values are LICENSE_INCLUDED or BRING_YOUR_OWN_LICENSE.
MaintenanceWindow?objectThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
MemoryPerOracleComputeUnitInGBs?numberThe amount of memory allocated per Oracle Compute Unit, in GB.
ScanListenerPortNonTls?numberThe SCAN listener port for non-TLS (TCP) protocol. The default is 1521.
ScanListenerPortTls?numberThe SCAN listener port for TLS (TCP) protocol. The default is 2484.
Tags?arrayThe tags associated with the Autonomous VM cluster.
TimeZone?stringThe time zone of the Autonomous VM cluster.
TotalContainerDatabases?numberThe total number of Autonomous Container Databases that can be created with the allocated local storage.
IamRoles?arrayThe AWS Identity and Access Management (IAM) service roles associated with the Autonomous VM cluster.
createCreate a ODB CloudAutonomousVmCluster
getGet a ODB CloudAutonomousVmCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudAutonomousVmCluster
updateUpdate a ODB CloudAutonomousVmCluster
deleteDelete a ODB CloudAutonomousVmCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudAutonomousVmCluster
syncSync ODB CloudAutonomousVmCluster state from AWS

Resources

state(infinite)— ODB CloudAutonomousVmCluster resource state
@swamp/aws/odb/cloud-exadata-infrastructurev2026.04.23.2cloud_exadata_infrastructure.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AvailabilityZone?stringThe name of the Availability Zone (AZ) where the Exadata infrastructure is located.
AvailabilityZoneId?stringThe AZ ID of the AZ where the Exadata infrastructure is located.
MaintenanceWindow?objectThe scheduling details for the maintenance window. Patching and system updates take place during the maintenance window.
ComputeCount?numberThe number of database servers for the Exadata infrastructure.
CustomerContactsToSendToOCI?arrayThe email addresses of contacts to receive notification from Oracle about maintenance updates for the Exadata infrastructure.
DatabaseServerType?stringThe database server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
DisplayName?stringThe user-friendly name for the Exadata infrastructure.
Shape?stringThe model name of the Exadata infrastructure.
StorageCount?numberThe number of storage servers that are activated for the Exadata infrastructure.
StorageServerType?stringThe storage server model type of the Exadata infrastructure. For the list of valid model names, use the ListDbSystemShapes operation.
Tags?arrayTags to assign to the Exadata Infrastructure.
createCreate a ODB CloudExadataInfrastructure
getGet a ODB CloudExadataInfrastructure
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudExadataInfrastructure
updateUpdate a ODB CloudExadataInfrastructure
deleteDelete a ODB CloudExadataInfrastructure
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudExadataInfrastructure
syncSync ODB CloudExadataInfrastructure state from AWS

Resources

state(infinite)— ODB CloudExadataInfrastructure resource state
@swamp/aws/odb/cloud-vm-clusterv2026.04.23.2cloud_vm_cluster.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
CloudExadataInfrastructureId?stringThe unique identifier of the Exadata infrastructure that this VM cluster belongs to.
ClusterName?stringThe name of the Grid Infrastructure (GI) cluster.
DataCollectionOptions?objectThe set of diagnostic collection options enabled for the VM cluster.
DataStorageSizeInTBs?numberThe size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
DisplayName?stringThe user-friendly name for the VM cluster.
GiVersion?stringThe software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
IsLocalBackupEnabled?booleanIndicates whether database backups to local Exadata storage is enabled for the VM cluster.
IsSparseDiskgroupEnabled?booleanIndicates whether the VM cluster is configured with a sparse disk group.
LicenseModel?enumThe Oracle license model applied to the VM cluster.
OdbNetworkId?stringThe unique identifier of the ODB network for the VM cluster.
ScanListenerPortTcp?numberProperty description not available.
SshPublicKeys?arrayThe public key portion of one or more key pairs used for SSH access to the VM cluster.
SystemVersion?stringThe operating system version of the image chosen for the VM cluster.
Tags?arrayTags to assign to the Vm Cluster.
TimeZone?stringThe time zone of the VM cluster.
DbServers?arrayThe list of database servers for the VM cluster.
DbNodes?arrayThe DB nodes that are implicitly created and managed as part of this VM Cluster.
IamRoles?arrayThe AWS Identity and Access Management (IAM) service roles associated with the VM cluster.
createCreate a ODB CloudVmCluster
getGet a ODB CloudVmCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudVmCluster
updateUpdate a ODB CloudVmCluster
deleteDelete a ODB CloudVmCluster
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB CloudVmCluster
syncSync ODB CloudVmCluster state from AWS

Resources

state(infinite)— ODB CloudVmCluster resource state
@swamp/aws/odb/odb-networkv2026.04.23.2odb_network.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AvailabilityZone?stringThe AWS Availability Zone (AZ) where the ODB network is located.
AvailabilityZoneId?stringThe AZ ID of the AZ where the ODB network is located.
BackupSubnetCidr?stringThe CIDR range of the backup subnet in the ODB network.
ClientSubnetCidr?stringThe CIDR range of the client subnet in the ODB network.
CustomDomainName?stringThe domain name to use for the resources in the ODB network.
DefaultDnsPrefix?stringThe DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
DeleteAssociatedResources?booleanSpecifies whether to delete associated OCI networking resources along with the ODB network.
DisplayName?stringThe user-friendly name of the ODB network.
S3Access?enumSpecifies the configuration for Amazon S3 access from the ODB network.
S3PolicyDocument?stringSpecifies the endpoint policy for Amazon S3 access from the ODB network.
KmsAccess?enumThe AWS Key Management Service (KMS) access configuration for the ODB network.
KmsPolicyDocument?stringThe AWS Key Management Service (KMS) policy document that defines permissions for key usage within the ODB network.
StsAccess?enumThe AWS Security Token Service (STS) access configuration for the ODB network.
StsPolicyDocument?stringThe AWS Security Token Service (STS) policy document that defines permissions for token service usage within the ODB network.
CrossRegionS3RestoreSources?arrayThe cross-Region Amazon S3 restore sources for the ODB network.
Tags?arrayTags to assign to the Odb Network.
ManagedServices?objectThe managed services configuration for the ODB network.
ZeroEtlAccess?enumSpecifies the configuration for Zero-ETL access from the ODB network.
createCreate a ODB OdbNetwork
getGet a ODB OdbNetwork
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB OdbNetwork
updateUpdate a ODB OdbNetwork
deleteDelete a ODB OdbNetwork
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB OdbNetwork
syncSync ODB OdbNetwork state from AWS

Resources

state(infinite)— ODB OdbNetwork resource state
@swamp/aws/odb/odb-peering-connectionv2026.04.23.2odb_peering_connection.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
AdditionalPeerNetworkCidrs?arrayThe additional CIDR blocks for the ODB peering connection.
DisplayName?stringThe name of the ODB peering connection.
OdbNetworkId?stringThe unique identifier of the ODB network.
PeerNetworkId?stringThe unique identifier of the peer network.
PeerNetworkRouteTableIds?arrayThe unique identifier of the VPC route table for which a route to the ODB network is automatically created during peering connection establishment.
Tags?arrayTags to assign to the Odb peering connection.
createCreate a ODB OdbPeeringConnection
getGet a ODB OdbPeeringConnection
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB OdbPeeringConnection
updateUpdate a ODB OdbPeeringConnection
deleteDelete a ODB OdbPeeringConnection
ArgumentTypeDescription
identifierstringThe primary identifier of the ODB OdbPeeringConnection
syncSync ODB OdbPeeringConnection state from AWS

Resources

state(infinite)— ODB OdbPeeringConnection resource state