2025/11/21 - odb - 2 new8 updated api methods
Changes Adds AssociateIamRoleToResource and DisassociateIamRoleFromResource APIs for managing IAM roles. Enhances CreateOdbNetwork and UpdateOdbNetwork APIs with KMS, STS, and cross-region S3 parameters. Adds OCI identity domain support to InitializeService API.
Associates an Amazon Web Services Identity and Access Management (IAM) service role with a specified resource to enable Amazon Web Services service integration.
See also: AWS API Documentation
Request Syntax
client.associate_iam_role_to_resource(
iamRoleArn='string',
awsIntegration='KmsTde',
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM service role to associate with the resource.
string
[REQUIRED]
The Amazon Web Services integration configuration settings for the IAM service role association.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the target resource to associate with the IAM service role.
dict
Response Syntax
{}
Response Structure
(dict) --
Disassociates an Amazon Web Services Identity and Access Management (IAM) service role from a specified resource to disable Amazon Web Services service integration.
See also: AWS API Documentation
Request Syntax
client.disassociate_iam_role_from_resource(
iamRoleArn='string',
awsIntegration='KmsTde',
resourceArn='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the IAM service role to disassociate from the resource.
string
[REQUIRED]
The Amazon Web Services integration configuration settings for the IAM service role disassociation.
string
[REQUIRED]
The Amazon Resource Name (ARN) of the target resource to disassociate from the IAM service role.
dict
Response Syntax
{}
Response Structure
(dict) --
{'crossRegionS3RestoreSourcesToEnable': ['string'],
'kmsAccess': 'ENABLED | DISABLED',
'kmsPolicyDocument': 'string',
'stsAccess': 'ENABLED | DISABLED',
'stsPolicyDocument': 'string'}
Creates an ODB network.
See also: AWS API Documentation
Request Syntax
client.create_odb_network(
displayName='string',
availabilityZone='string',
availabilityZoneId='string',
clientSubnetCidr='string',
backupSubnetCidr='string',
customDomainName='string',
defaultDnsPrefix='string',
clientToken='string',
s3Access='ENABLED'|'DISABLED',
zeroEtlAccess='ENABLED'|'DISABLED',
stsAccess='ENABLED'|'DISABLED',
kmsAccess='ENABLED'|'DISABLED',
s3PolicyDocument='string',
stsPolicyDocument='string',
kmsPolicyDocument='string',
crossRegionS3RestoreSourcesToEnable=[
'string',
],
tags={
'string': 'string'
}
)
string
[REQUIRED]
A user-friendly name for the ODB network.
string
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
string
The AZ ID of the AZ where the ODB network is located.
This operation requires that you specify a value for either availabilityZone or availabilityZoneId.
string
[REQUIRED]
The CIDR range of the client subnet for the ODB network.
Constraints:
Must not overlap with the CIDR range of the backup subnet.
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
Must not use the following CIDR ranges that are reserved by OCI:
100.106.0.0/16 and 100.107.0.0/16
169.254.0.0/16
224.0.0.0 - 239.255.255.255
240.0.0.0 - 255.255.255.255
string
The CIDR range of the backup subnet for the ODB network.
Constraints:
Must not overlap with the CIDR range of the client subnet.
Must not overlap with the CIDR ranges of the VPCs that are connected to the ODB network.
Must not use the following CIDR ranges that are reserved by OCI:
100.106.0.0/16 and 100.107.0.0/16
169.254.0.0/16
224.0.0.0 - 239.255.255.255
240.0.0.0 - 255.255.255.255
string
The domain name to use for the resources in the ODB network.
string
The DNS prefix to the default DNS domain name. The default DNS domain name is oraclevcn.com.
string
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The client token is valid for up to 24 hours after it's first used.
This field is autopopulated if not provided.
string
Specifies the configuration for Amazon S3 access from the ODB network.
string
Specifies the configuration for Zero-ETL access from the ODB network.
string
The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
string
The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
string
Specifies the endpoint policy for Amazon S3 access from the ODB network.
string
The STS policy document that defines permissions for token service usage within the ODB network.
string
The KMS policy document that defines permissions for key usage within the ODB network.
list
The cross-Region Amazon S3 restore sources to enable for the ODB network.
(string) --
dict
The list of resource tags to apply to the ODB network.
(string) --
(string) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the status of the ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
{'cloudVmCluster': {'iamRoles': [{'awsIntegration': 'KmsTde',
'iamRoleArn': 'string',
'status': 'ASSOCIATING | DISASSOCIATING | '
'FAILED | CONNECTED | DISCONNECTED '
'| PARTIALLY_CONNECTED | UNKNOWN',
'statusReason': 'string'}]}}
Returns information about the specified VM cluster.
See also: AWS API Documentation
Request Syntax
client.get_cloud_vm_cluster(
cloudVmClusterId='string'
)
string
[REQUIRED]
The unique identifier of the VM cluster.
dict
Response Syntax
{
'cloudVmCluster': {
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
}
}
Response Structure
(dict) --
cloudVmCluster (dict) --
The VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
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 (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
The set of diagnostic collection options enabled for the VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The ExadataIormConfig cache details for the VM cluster.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
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.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role.
status (string) --
The current status of the IAM service role.
statusReason (string) --
Additional information about the current status of the IAM service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the IAM service role.
{'ociIdentityDomain': {'accountSetupCloudFormationUrl': 'string',
'ociIdentityDomainId': 'string',
'ociIdentityDomainResourceUrl': 'string',
'ociIdentityDomainUrl': 'string',
'status': 'AVAILABLE | FAILED | PROVISIONING | '
'TERMINATED | TERMINATING | UPDATING | '
'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string'}}
Returns the tenancy activation link and onboarding status for your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.get_oci_onboarding_status()
dict
Response Syntax
{
'status': 'NOT_STARTED'|'PENDING_LINK_GENERATION'|'PENDING_CUSTOMER_ACTION'|'PENDING_INITIALIZATION'|'ACTIVATING'|'ACTIVE_IN_HOME_REGION'|'ACTIVE'|'ACTIVE_LIMITED'|'FAILED'|'PUBLIC_OFFER_UNSUPPORTED'|'SUSPENDED'|'CANCELED',
'existingTenancyActivationLink': 'string',
'newTenancyActivationLink': 'string',
'ociIdentityDomain': {
'ociIdentityDomainId': 'string',
'ociIdentityDomainResourceUrl': 'string',
'ociIdentityDomainUrl': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'accountSetupCloudFormationUrl': 'string'
}
}
Response Structure
(dict) --
status (string) --
existingTenancyActivationLink (string) --
The existing OCI tenancy activation link for your Amazon Web Services account.
newTenancyActivationLink (string) --
A new OCI tenancy activation link for your Amazon Web Services account.
ociIdentityDomain (dict) --
The Oracle Cloud Infrastructure (OCI) identity domain information in the onboarding status response.
ociIdentityDomainId (string) --
The unique identifier of the OCI identity domain.
ociIdentityDomainResourceUrl (string) --
The resource URL for accessing the OCI identity domain.
ociIdentityDomainUrl (string) --
The URL of the OCI identity domain.
status (string) --
The current status of the OCI identity domain.
statusReason (string) --
Additional information about the current status of the OCI identity domain, if applicable.
accountSetupCloudFormationUrl (string) --
The Amazon Web Services CloudFormation URL for setting up the account integration with the OCI identity domain.
{'odbNetwork': {'managedServices': {'crossRegionS3RestoreSourcesAccess': [{'ipv4Addresses': ['string'],
'region': 'string',
'status': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING'}],
'kmsAccess': {'domainName': 'string',
'ipv4Addresses': ['string'],
'kmsPolicyDocument': 'string',
'status': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING'},
'stsAccess': {'domainName': 'string',
'ipv4Addresses': ['string'],
'status': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING',
'stsPolicyDocument': 'string'}}}}
Returns information about the specified ODB network.
See also: AWS API Documentation
Request Syntax
client.get_odb_network(
odbNetworkId='string'
)
string
[REQUIRED]
The unique identifier of the ODB network.
dict
Response Syntax
{
'odbNetwork': {
'odbNetworkId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkArn': 'string',
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'clientSubnetCidr': 'string',
'backupSubnetCidr': 'string',
'customDomainName': 'string',
'defaultDnsPrefix': 'string',
'peeredCidrs': [
'string',
],
'ociNetworkAnchorId': 'string',
'ociNetworkAnchorUrl': 'string',
'ociResourceAnchorName': 'string',
'ociVcnId': 'string',
'ociVcnUrl': 'string',
'ociDnsForwardingConfigs': [
{
'domainName': 'string',
'ociDnsListenerIp': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...,
'managedServices': {
'serviceNetworkArn': 'string',
'resourceGatewayArn': 'string',
'managedServicesIpv4Cidrs': [
'string',
],
'serviceNetworkEndpoint': {
'vpcEndpointId': 'string',
'vpcEndpointType': 'SERVICENETWORK'
},
'managedS3BackupAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
]
},
'zeroEtlAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'cidr': 'string'
},
's3Access': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
's3PolicyDocument': 'string'
},
'stsAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
'stsPolicyDocument': 'string'
},
'kmsAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
'kmsPolicyDocument': 'string'
},
'crossRegionS3RestoreSourcesAccess': [
{
'region': 'string',
'ipv4Addresses': [
'string',
],
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
},
]
}
}
}
Response Structure
(dict) --
odbNetwork (dict) --
The ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the current status of the ODB network.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network.
availabilityZone (string) --
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the ODB network is located.
clientSubnetCidr (string) --
The CIDR range of the client subnet in the ODB network.
backupSubnetCidr (string) --
The CIDR range of the backup subnet in the ODB network.
customDomainName (string) --
The domain name 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.
peeredCidrs (list) --
The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.
(string) --
ociNetworkAnchorId (string) --
The unique identifier of the OCI network anchor for the ODB network.
ociNetworkAnchorUrl (string) --
The URL of the OCI network anchor for the ODB network.
ociResourceAnchorName (string) --
The name of the OCI resource anchor that's associated with the ODB network.
ociVcnId (string) --
The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) that's associated with the ODB network.
ociVcnUrl (string) --
The URL for the VCN that's associated with the ODB network.
ociDnsForwardingConfigs (list) --
The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.
(dict) --
DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.
domainName (string) --
Domain name to which DNS resolver forwards to.
ociDnsListenerIp (string) --
OCI DNS listener IP for custom DNS setup.
createdAt (datetime) --
The date and time when the ODB network was created.
percentProgress (float) --
The amount of progress made on the current operation on the ODB network, expressed as a percentage.
managedServices (dict) --
The managed services configuration for the ODB network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
resourceGatewayArn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
managedServicesIpv4Cidrs (list) --
The IPv4 CIDR blocks for the managed services.
(string) --
serviceNetworkEndpoint (dict) --
The service network endpoint configuration.
vpcEndpointId (string) --
The identifier of the VPC endpoint.
vpcEndpointType (string) --
The type of the VPC endpoint.
managedS3BackupAccess (dict) --
The managed Amazon S3 backup access configuration.
status (string) --
The status of the managed Amazon S3 backup access.
ipv4Addresses (list) --
The IPv4 addresses for the managed Amazon S3 backup access.
(string) --
zeroEtlAccess (dict) --
The Zero-ETL access configuration.
status (string) --
The status of the Zero-ETL access.
cidr (string) --
The CIDR block for the Zero-ETL access.
s3Access (dict) --
The Amazon S3 access configuration.
status (string) --
The status of the Amazon S3 access.
ipv4Addresses (list) --
The IPv4 addresses for the Amazon S3 access.
(string) --
domainName (string) --
The domain name for the Amazon S3 access.
s3PolicyDocument (string) --
The endpoint policy for the Amazon S3 access.
stsAccess (dict) --
The Amazon Web Services Security Token Service (STS) access configuration for managed services.
status (string) --
The current status of the STS access configuration.
ipv4Addresses (list) --
The IPv4 addresses allowed for STS access.
(string) --
domainName (string) --
The domain name for STS access configuration.
stsPolicyDocument (string) --
The STS policy document that defines permissions for token service usage.
kmsAccess (dict) --
The Amazon Web Services Key Management Service (KMS) access configuration for managed services.
status (string) --
The current status of the KMS access configuration.
ipv4Addresses (list) --
The IPv4 addresses allowed for KMS access.
(string) --
domainName (string) --
The domain name for KMS access configuration.
kmsPolicyDocument (string) --
The KMS policy document that defines permissions for key usage.
crossRegionS3RestoreSourcesAccess (list) --
The access configuration for the cross-Region Amazon S3 database restore source.
(dict) --
The configuration access for the cross-Region Amazon S3 database restore source for the ODB network.
region (string) --
The Amazon Web Services Region for cross-Region S3 restore access.
ipv4Addresses (list) --
The IPv4 addresses allowed for cross-Region S3 restore access.
(string) --
status (string) --
The current status of the cross-Region S3 restore access configuration.
{'ociIdentityDomain': 'boolean'}
Initializes the ODB service for the first time in an account.
See also: AWS API Documentation
Request Syntax
client.initialize_service(
ociIdentityDomain=True|False
)
boolean
The Oracle Cloud Infrastructure (OCI) identity domain configuration for service initialization.
dict
Response Syntax
{}
Response Structure
(dict) --
{'cloudVmClusters': {'iamRoles': [{'awsIntegration': 'KmsTde',
'iamRoleArn': 'string',
'status': 'ASSOCIATING | DISASSOCIATING | '
'FAILED | CONNECTED | '
'DISCONNECTED | '
'PARTIALLY_CONNECTED | UNKNOWN',
'statusReason': 'string'}]}}
Returns information about the VM clusters owned by your Amazon Web Services account or only the ones on the specified Exadata infrastructure.
See also: AWS API Documentation
Request Syntax
client.list_cloud_vm_clusters(
maxResults=123,
nextToken='string',
cloudExadataInfrastructureId='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
string
The unique identifier of the Oracle Exadata infrastructure.
dict
Response Syntax
{
'nextToken': 'string',
'cloudVmClusters': [
{
'cloudVmClusterId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'cloudVmClusterArn': 'string',
'cloudExadataInfrastructureId': 'string',
'clusterName': 'string',
'cpuCoreCount': 123,
'dataCollectionOptions': {
'isDiagnosticsEventsEnabled': True|False,
'isHealthMonitoringEnabled': True|False,
'isIncidentLogsEnabled': True|False
},
'dataStorageSizeInTBs': 123.0,
'dbNodeStorageSizeInGBs': 123,
'dbServers': [
'string',
],
'diskRedundancy': 'HIGH'|'NORMAL',
'giVersion': 'string',
'hostname': 'string',
'iormConfigCache': {
'dbPlans': [
{
'dbName': 'string',
'flashCacheLimit': 'string',
'share': 123
},
],
'lifecycleDetails': 'string',
'lifecycleState': 'BOOTSTRAPPING'|'DISABLED'|'ENABLED'|'FAILED'|'UPDATING',
'objective': 'AUTO'|'BALANCED'|'BASIC'|'HIGH_THROUGHPUT'|'LOW_LATENCY'
},
'isLocalBackupEnabled': True|False,
'isSparseDiskgroupEnabled': True|False,
'lastUpdateHistoryEntryId': 'string',
'licenseModel': 'BRING_YOUR_OWN_LICENSE'|'LICENSE_INCLUDED',
'listenerPort': 123,
'memorySizeInGBs': 123,
'nodeCount': 123,
'ocid': 'string',
'ociResourceAnchorName': 'string',
'ociUrl': 'string',
'domain': 'string',
'scanDnsName': 'string',
'scanDnsRecordId': 'string',
'scanIpIds': [
'string',
],
'shape': 'string',
'sshPublicKeys': [
'string',
],
'storageSizeInGBs': 123,
'systemVersion': 'string',
'createdAt': datetime(2015, 1, 1),
'timeZone': 'string',
'vipIds': [
'string',
],
'odbNetworkId': 'string',
'percentProgress': ...,
'computeModel': 'ECPU'|'OCPU',
'iamRoles': [
{
'iamRoleArn': 'string',
'status': 'ASSOCIATING'|'DISASSOCIATING'|'FAILED'|'CONNECTED'|'DISCONNECTED'|'PARTIALLY_CONNECTED'|'UNKNOWN',
'statusReason': 'string',
'awsIntegration': 'KmsTde'
},
]
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
cloudVmClusters (list) --
The list of VM clusters along with their properties.
(dict) --
Information about a VM cluster.
cloudVmClusterId (string) --
The unique identifier of the VM cluster.
displayName (string) --
The user-friendly name for the VM cluster.
status (string) --
The current status of the VM cluster.
statusReason (string) --
Additional information about the status of the VM cluster.
cloudVmClusterArn (string) --
The Amazon Resource Name (ARN) of the VM cluster.
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 (integer) --
The number of CPU cores enabled on the VM cluster.
dataCollectionOptions (dict) --
Information about the data collection options enabled for a VM cluster.
isDiagnosticsEventsEnabled (boolean) --
Indicates whether diagnostic collection is enabled for the VM cluster.
isHealthMonitoringEnabled (boolean) --
Indicates whether health monitoring is enabled for the VM cluster.
isIncidentLogsEnabled (boolean) --
Indicates whether incident logs are enabled for the cloud VM cluster.
dataStorageSizeInTBs (float) --
The size of the data disk group, in terabytes (TB), that's allocated for the VM cluster.
dbNodeStorageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated for the VM cluster.
dbServers (list) --
The list of database servers for the VM cluster.
(string) --
diskRedundancy (string) --
The type of redundancy configured for the VM cluster. NORMAL is 2-way redundancy. HIGH is 3-way redundancy.
giVersion (string) --
The software version of the Oracle Grid Infrastructure (GI) for the VM cluster.
hostname (string) --
The host name for the VM cluster.
iormConfigCache (dict) --
The IORM settings of the Exadata DB system.
dbPlans (list) --
An array of IORM settings for all the database in the Exadata DB system.
(dict) --
The IORM configuration settings for the database.
dbName (string) --
The database name. For the default DbPlan, the dbName is default.
flashCacheLimit (string) --
The flash cache limit for this database. This value is internally configured based on the share value assigned to the database.
share (integer) --
The relative priority of this database.
lifecycleDetails (string) --
Additional information about the current lifecycleState.
lifecycleState (string) --
The current state of IORM configuration for the Exadata DB system.
objective (string) --
The current value for the IORM objective. The default is AUTO.
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.
lastUpdateHistoryEntryId (string) --
The Oracle Cloud ID (OCID) of the last maintenance update history entry.
licenseModel (string) --
The Oracle license model applied to the VM cluster.
listenerPort (integer) --
The port number configured for the listener on the VM cluster.
memorySizeInGBs (integer) --
The amount of memory, in gigabytes (GB), that's allocated for the VM cluster.
nodeCount (integer) --
The number of nodes in the VM cluster.
ocid (string) --
The OCID of the VM cluster.
ociResourceAnchorName (string) --
The name of the OCI resource anchor for the VM cluster.
ociUrl (string) --
The HTTPS link to the VM cluster in OCI.
domain (string) --
The domain of the VM cluster.
scanDnsName (string) --
The FQDN of the DNS record for the Single Client Access Name (SCAN) IP addresses that are associated with the VM cluster.
scanDnsRecordId (string) --
The OCID of the DNS record for the SCAN IP addresses that are associated with the VM cluster.
scanIpIds (list) --
The OCID of the SCAN IP addresses that are associated with the VM cluster.
(string) --
shape (string) --
The hardware model name of the Exadata infrastructure that's running the VM cluster.
sshPublicKeys (list) --
The public key portion of one or more key pairs used for SSH access to the VM cluster.
(string) --
storageSizeInGBs (integer) --
The amount of local node storage, in gigabytes (GB), that's allocated to the VM cluster.
systemVersion (string) --
The operating system version of the image chosen for the VM cluster.
createdAt (datetime) --
The date and time when the VM cluster was created.
timeZone (string) --
The time zone of the VM cluster.
vipIds (list) --
The virtual IP (VIP) addresses that are associated with the VM cluster. Oracle's Cluster Ready Services (CRS) creates and maintains one VIP address for each node in the VM cluster to enable failover. If one node fails, the VIP is reassigned to another active node in the cluster.
(string) --
odbNetworkId (string) --
The unique identifier of the ODB network for the VM cluster.
percentProgress (float) --
The amount of progress made on the current operation on the VM cluster, expressed as a percentage.
computeModel (string) --
The OCI model compute model used when you create or clone an instance: ECPU or OCPU. An ECPU is an abstracted measure of compute resources. ECPUs are based on the number of cores elastically allocated from a pool of compute and storage servers. An OCPU is a legacy physical measure of compute resources. OCPUs are based on the physical core of a processor with hyper-threading enabled.
iamRoles (list) --
The Amazon Web Services Identity and Access Management (IAM) service roles associated with the VM cluster in the summary information.
(dict) --
Information about an Amazon Web Services Identity and Access Management (IAM) service role associated with a resource.
iamRoleArn (string) --
The Amazon Resource Name (ARN) of the IAM service role.
status (string) --
The current status of the IAM service role.
statusReason (string) --
Additional information about the current status of the IAM service role, if applicable.
awsIntegration (string) --
The Amazon Web Services integration configuration settings for the IAM service role.
{'odbNetworks': {'managedServices': {'crossRegionS3RestoreSourcesAccess': [{'ipv4Addresses': ['string'],
'region': 'string',
'status': 'ENABLED '
'| '
'ENABLING '
'| '
'DISABLED '
'| '
'DISABLING'}],
'kmsAccess': {'domainName': 'string',
'ipv4Addresses': ['string'],
'kmsPolicyDocument': 'string',
'status': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING'},
'stsAccess': {'domainName': 'string',
'ipv4Addresses': ['string'],
'status': 'ENABLED | '
'ENABLING | '
'DISABLED | '
'DISABLING',
'stsPolicyDocument': 'string'}}}}
Returns information about the ODB networks owned by your Amazon Web Services account.
See also: AWS API Documentation
Request Syntax
client.list_odb_networks(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.
Default: 10
string
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
dict
Response Syntax
{
'nextToken': 'string',
'odbNetworks': [
{
'odbNetworkId': 'string',
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkArn': 'string',
'availabilityZone': 'string',
'availabilityZoneId': 'string',
'clientSubnetCidr': 'string',
'backupSubnetCidr': 'string',
'customDomainName': 'string',
'defaultDnsPrefix': 'string',
'peeredCidrs': [
'string',
],
'ociNetworkAnchorId': 'string',
'ociNetworkAnchorUrl': 'string',
'ociResourceAnchorName': 'string',
'ociVcnId': 'string',
'ociVcnUrl': 'string',
'ociDnsForwardingConfigs': [
{
'domainName': 'string',
'ociDnsListenerIp': 'string'
},
],
'createdAt': datetime(2015, 1, 1),
'percentProgress': ...,
'managedServices': {
'serviceNetworkArn': 'string',
'resourceGatewayArn': 'string',
'managedServicesIpv4Cidrs': [
'string',
],
'serviceNetworkEndpoint': {
'vpcEndpointId': 'string',
'vpcEndpointType': 'SERVICENETWORK'
},
'managedS3BackupAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
]
},
'zeroEtlAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'cidr': 'string'
},
's3Access': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
's3PolicyDocument': 'string'
},
'stsAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
'stsPolicyDocument': 'string'
},
'kmsAccess': {
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING',
'ipv4Addresses': [
'string',
],
'domainName': 'string',
'kmsPolicyDocument': 'string'
},
'crossRegionS3RestoreSourcesAccess': [
{
'region': 'string',
'ipv4Addresses': [
'string',
],
'status': 'ENABLED'|'ENABLING'|'DISABLED'|'DISABLING'
},
]
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
The token to include in another request to get the next page of items. This value is null when there are no more items to return.
odbNetworks (list) --
The list of ODB networks.
(dict) --
Information about an ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the current status of the ODB network.
odbNetworkArn (string) --
The Amazon Resource Name (ARN) of the ODB network.
availabilityZone (string) --
The Amazon Web Services Availability Zone (AZ) where the ODB network is located.
availabilityZoneId (string) --
The AZ ID of the AZ where the ODB network is located.
clientSubnetCidr (string) --
The CIDR range of the client subnet in the ODB network.
backupSubnetCidr (string) --
The CIDR range of the backup subnet in the ODB network.
customDomainName (string) --
The domain name 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.
peeredCidrs (list) --
The list of CIDR ranges from the peered VPC that are allowed access to the ODB network.
(string) --
ociNetworkAnchorId (string) --
The unique identifier of the OCI network anchor for the ODB network.
ociNetworkAnchorUrl (string) --
The URL of the OCI network anchor for the ODB network.
ociResourceAnchorName (string) --
The name of the OCI resource anchor associated with the ODB network.
ociVcnId (string) --
The Oracle Cloud ID (OCID) for the Virtual Cloud Network (VCN) associated with the ODB network.
ociVcnUrl (string) --
The URL for the VCN that's associated with the ODB network.
ociDnsForwardingConfigs (list) --
The DNS resolver endpoint in OCI for forwarding DNS queries for the ociPrivateZone domain.
(dict) --
DNS configuration to forward DNS resolver endpoints to your OCI Private Zone.
domainName (string) --
Domain name to which DNS resolver forwards to.
ociDnsListenerIp (string) --
OCI DNS listener IP for custom DNS setup.
createdAt (datetime) --
The date and time when the ODB network was created.
percentProgress (float) --
The amount of progress made on the current operation on the ODB network, expressed as a percentage.
managedServices (dict) --
The managed services configuration for the ODB network.
serviceNetworkArn (string) --
The Amazon Resource Name (ARN) of the service network.
resourceGatewayArn (string) --
The Amazon Resource Name (ARN) of the resource gateway.
managedServicesIpv4Cidrs (list) --
The IPv4 CIDR blocks for the managed services.
(string) --
serviceNetworkEndpoint (dict) --
The service network endpoint configuration.
vpcEndpointId (string) --
The identifier of the VPC endpoint.
vpcEndpointType (string) --
The type of the VPC endpoint.
managedS3BackupAccess (dict) --
The managed Amazon S3 backup access configuration.
status (string) --
The status of the managed Amazon S3 backup access.
ipv4Addresses (list) --
The IPv4 addresses for the managed Amazon S3 backup access.
(string) --
zeroEtlAccess (dict) --
The Zero-ETL access configuration.
status (string) --
The status of the Zero-ETL access.
cidr (string) --
The CIDR block for the Zero-ETL access.
s3Access (dict) --
The Amazon S3 access configuration.
status (string) --
The status of the Amazon S3 access.
ipv4Addresses (list) --
The IPv4 addresses for the Amazon S3 access.
(string) --
domainName (string) --
The domain name for the Amazon S3 access.
s3PolicyDocument (string) --
The endpoint policy for the Amazon S3 access.
stsAccess (dict) --
The Amazon Web Services Security Token Service (STS) access configuration for managed services.
status (string) --
The current status of the STS access configuration.
ipv4Addresses (list) --
The IPv4 addresses allowed for STS access.
(string) --
domainName (string) --
The domain name for STS access configuration.
stsPolicyDocument (string) --
The STS policy document that defines permissions for token service usage.
kmsAccess (dict) --
The Amazon Web Services Key Management Service (KMS) access configuration for managed services.
status (string) --
The current status of the KMS access configuration.
ipv4Addresses (list) --
The IPv4 addresses allowed for KMS access.
(string) --
domainName (string) --
The domain name for KMS access configuration.
kmsPolicyDocument (string) --
The KMS policy document that defines permissions for key usage.
crossRegionS3RestoreSourcesAccess (list) --
The access configuration for the cross-Region Amazon S3 database restore source.
(dict) --
The configuration access for the cross-Region Amazon S3 database restore source for the ODB network.
region (string) --
The Amazon Web Services Region for cross-Region S3 restore access.
ipv4Addresses (list) --
The IPv4 addresses allowed for cross-Region S3 restore access.
(string) --
status (string) --
The current status of the cross-Region S3 restore access configuration.
{'crossRegionS3RestoreSourcesToDisable': ['string'],
'crossRegionS3RestoreSourcesToEnable': ['string'],
'kmsAccess': 'ENABLED | DISABLED',
'kmsPolicyDocument': 'string',
'stsAccess': 'ENABLED | DISABLED',
'stsPolicyDocument': 'string'}
Updates properties of a specified ODB network.
See also: AWS API Documentation
Request Syntax
client.update_odb_network(
odbNetworkId='string',
displayName='string',
peeredCidrsToBeAdded=[
'string',
],
peeredCidrsToBeRemoved=[
'string',
],
s3Access='ENABLED'|'DISABLED',
zeroEtlAccess='ENABLED'|'DISABLED',
stsAccess='ENABLED'|'DISABLED',
kmsAccess='ENABLED'|'DISABLED',
s3PolicyDocument='string',
stsPolicyDocument='string',
kmsPolicyDocument='string',
crossRegionS3RestoreSourcesToEnable=[
'string',
],
crossRegionS3RestoreSourcesToDisable=[
'string',
]
)
string
[REQUIRED]
The unique identifier of the ODB network to update.
string
The new user-friendly name of the ODB network.
list
The list of CIDR ranges from the peered VPC that allow access to the ODB network.
(string) --
list
The list of CIDR ranges from the peered VPC to remove from the ODB network.
(string) --
string
Specifies the updated configuration for Amazon S3 access from the ODB network.
string
Specifies the updated configuration for Zero-ETL access from the ODB network.
string
The Amazon Web Services Security Token Service (STS) access configuration for the ODB network.
string
The Amazon Web Services Key Management Service (KMS) access configuration for the ODB network.
string
Specifies the updated endpoint policy for Amazon S3 access from the ODB network.
string
The STS policy document that defines permissions for token service usage within the ODB network.
string
The KMS policy document that defines permissions for key usage within the ODB network.
list
The cross-Region Amazon S3 restore sources to enable for the ODB network.
(string) --
list
The cross-Region Amazon S3 restore sources to disable for the ODB network.
(string) --
dict
Response Syntax
{
'displayName': 'string',
'status': 'AVAILABLE'|'FAILED'|'PROVISIONING'|'TERMINATED'|'TERMINATING'|'UPDATING'|'MAINTENANCE_IN_PROGRESS',
'statusReason': 'string',
'odbNetworkId': 'string'
}
Response Structure
(dict) --
displayName (string) --
The user-friendly name of the ODB network.
status (string) --
The current status of the ODB network.
statusReason (string) --
Additional information about the status of the ODB network.
odbNetworkId (string) --
The unique identifier of the ODB network.