oracle.oci.oci_golden_gate_deployment – Manage a Deployment resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_golden_gate_deployment
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a Deployment resource in Oracle Cloud Infrastructure
For state=present, creates a new Deployment.
This resource has the following action operations in the oracle.oci.oci_golden_gate_deployment_actions module: add_deployment_lock, change_compartment, collect_deployment_diagnostic, deployment_wallet_exists, export_deployment_wallet, generate_library_url, import_deployment_wallet, remove_deployment_lock, start, stop, upgrade.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
api_user
string
|
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See
config_file_location ). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
api_user_fingerprint
string
|
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See
config_file_location ). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm. |
||
api_user_key_file
string
|
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See
config_file_location ). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided. |
||
api_user_key_pass_phrase
string
|
Passphrase used by the key referenced in
api_user_key_file , if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location ). |
||
auth_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
|
auth_type
string
|
|
The type of authentication to use for making API requests. By default
auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance. |
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
||
compartment_id
string
|
The OCID of the compartment being referenced.
Required for create using state=present.
Required for update when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
||
config_file_location
string
|
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
|
||
config_profile_name
string
|
The profile to load from the config file referenced by
config_file_location . If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location . |
||
cpu_core_count
integer
|
The Minimum number of OCPUs to be made available for this Deployment.
Required for create using state=present.
This parameter is updatable.
|
||
defined_tags
dictionary
|
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
|
||
deployment_backup_id
string
|
The OCID of the backup being referenced.
|
||
deployment_id
string
|
A unique Deployment identifier.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||
deployment_type
string
|
|
The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
Required for create using state=present.
|
|
description
string
|
Metadata about this specific object.
This parameter is updatable.
|
||
display_name
string
|
An object's Display Name.
Required for create using state=present.
Required for update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
||
force_create
boolean
|
|
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
|
|
fqdn
string
|
A three-label Fully Qualified Domain Name (FQDN) for a resource.
This parameter is updatable.
|
||
freeform_tags
dictionary
|
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
This parameter is updatable.
|
||
is_auto_scaling_enabled
boolean
|
|
Indicates if auto scaling is enabled for the Deployment's CPU core count.
Required for create using state=present.
This parameter is updatable.
|
|
is_lock_override
boolean
|
|
Whether to override locks (if any exist).
This parameter is updatable.
|
|
is_public
boolean
|
|
True if this object is publicly available.
This parameter is updatable.
|
|
key_by
list
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
||
license_model
string
|
|
The Oracle license model that applies to a Deployment.
Required for create using state=present.
This parameter is updatable.
|
|
load_balancer_subnet_id
string
|
The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
This parameter is updatable.
|
||
locks
list
/ elements=dictionary
|
Locks associated with this resource.
|
||
message
string
|
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
|
||
type
string
/ required
|
|
Type of the lock.
|
|
maintenance_configuration
dictionary
|
This parameter is updatable.
|
||
bundle_release_upgrade_period_in_days
integer
|
Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
This parameter is updatable.
|
||
interim_release_upgrade_period_in_days
integer
|
Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
This parameter is updatable.
|
||
is_interim_release_auto_upgrade_enabled
boolean
|
|
By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
This parameter is updatable.
|
|
major_release_upgrade_period_in_days
integer
|
Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.
This parameter is updatable.
|
||
security_patch_upgrade_period_in_days
integer
|
Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.
This parameter is updatable.
|
||
maintenance_window
dictionary
|
This parameter is updatable.
|
||
day
string
/ required
|
|
Days of the week.
This parameter is updatable.
|
|
start_hour
integer
/ required
|
Start hour for maintenance period. Hour is in UTC.
This parameter is updatable.
|
||
nsg_ids
list
/ elements=string
|
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
This parameter is updatable.
|
||
ogg_data
dictionary
|
This parameter is updatable.
|
||
admin_password
string
|
The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as '$', '^', or '?' are not allowed. This field will be deprecated and replaced by "passwordSecretId".
This parameter is updatable.
|
||
admin_username
string
|
The GoldenGate deployment console username.
This parameter is updatable.
|
||
certificate
string
|
The base64 encoded content of the PEM file containing the SSL certificate.
This parameter is updatable.
|
||
credential_store
string
|
|
The type of credential store for OGG.
This parameter is updatable.
|
|
deployment_name
string
|
The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
|
||
identity_domain_id
string
|
The OCID of the Identity Domain when IAM credential store is used.
This parameter is updatable.
|
||
key
string
|
The base64 encoded content of the PEM file containing the private key.
This parameter is updatable.
|
||
ogg_version
string
|
Version of OGG
|
||
password_secret_id
string
|
The OCID of the Secret where the deployment password is stored.
This parameter is updatable.
|
||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|
region
string
|
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See
config_file_location ). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions. |
||
state
string
|
|
The state of the Deployment.
Use state=present to create or update a Deployment.
Use state=absent to delete a Deployment.
|
|
subnet_id
string
|
The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
Required for create using state=present.
This parameter is updatable.
|
||
tenancy
string
|
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See
config_file_location ). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm |
||
wait
boolean
|
|
Whether to wait for create or delete operation to complete.
|
|
wait_timeout
integer
|
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create deployment
oci_golden_gate_deployment:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
deployment_type: OGG
display_name: display_name_example
license_model: LICENSE_INCLUDED
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
cpu_core_count: 56
is_auto_scaling_enabled: true
# optional
locks:
- # required
type: FULL
# optional
message: message_example
deployment_backup_id: "ocid1.deploymentbackup.oc1..xxxxxxEXAMPLExxxxxx"
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
load_balancer_subnet_id: "ocid1.loadbalancersubnet.oc1..xxxxxxEXAMPLExxxxxx"
is_public: true
fqdn: fqdn_example
ogg_data:
# optional
deployment_name: deployment_name_example
ogg_version: ogg_version_example
credential_store: GOLDENGATE
identity_domain_id: "ocid1.identitydomain.oc1..xxxxxxEXAMPLExxxxxx"
password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
key: key_example
maintenance_window:
# required
day: MONDAY
start_hour: 56
maintenance_configuration:
# optional
is_interim_release_auto_upgrade_enabled: true
interim_release_upgrade_period_in_days: 56
bundle_release_upgrade_period_in_days: 56
major_release_upgrade_period_in_days: 56
security_patch_upgrade_period_in_days: 56
- name: Update deployment
oci_golden_gate_deployment:
# required
deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
license_model: LICENSE_INCLUDED
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
load_balancer_subnet_id: "ocid1.loadbalancersubnet.oc1..xxxxxxEXAMPLExxxxxx"
is_public: true
fqdn: fqdn_example
cpu_core_count: 56
is_auto_scaling_enabled: true
ogg_data:
# optional
deployment_name: deployment_name_example
ogg_version: ogg_version_example
credential_store: GOLDENGATE
identity_domain_id: "ocid1.identitydomain.oc1..xxxxxxEXAMPLExxxxxx"
password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
key: key_example
maintenance_window:
# required
day: MONDAY
start_hour: 56
maintenance_configuration:
# optional
is_interim_release_auto_upgrade_enabled: true
interim_release_upgrade_period_in_days: 56
bundle_release_upgrade_period_in_days: 56
major_release_upgrade_period_in_days: 56
security_patch_upgrade_period_in_days: 56
is_lock_override: true
- name: Update deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_golden_gate_deployment:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
# optional
license_model: LICENSE_INCLUDED
description: description_example
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
nsg_ids: [ "nsg_ids_example" ]
subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
load_balancer_subnet_id: "ocid1.loadbalancersubnet.oc1..xxxxxxEXAMPLExxxxxx"
is_public: true
fqdn: fqdn_example
cpu_core_count: 56
is_auto_scaling_enabled: true
ogg_data:
# optional
deployment_name: deployment_name_example
ogg_version: ogg_version_example
credential_store: GOLDENGATE
identity_domain_id: "ocid1.identitydomain.oc1..xxxxxxEXAMPLExxxxxx"
password_secret_id: "ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx"
admin_username: admin_username_example
admin_password: example-password
certificate: "-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----"
key: key_example
maintenance_window:
# required
day: MONDAY
start_hour: 56
maintenance_configuration:
# optional
is_interim_release_auto_upgrade_enabled: true
interim_release_upgrade_period_in_days: 56
bundle_release_upgrade_period_in_days: 56
major_release_upgrade_period_in_days: 56
security_patch_upgrade_period_in_days: 56
is_lock_override: true
- name: Delete deployment
oci_golden_gate_deployment:
# required
deployment_id: "ocid1.deployment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
# optional
is_lock_override: true
- name: Delete deployment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_golden_gate_deployment:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
display_name: display_name_example
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
deployment
complex
|
on success |
Details of the Deployment resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cpu_core_count': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'deployment_backup_id': 'ocid1.deploymentbackup.oc1..xxxxxxEXAMPLExxxxxx', 'deployment_diagnostic_data': {'bucket_name': 'bucket_name_example', 'diagnostic_state': 'IN_PROGRESS', 'namespace_name': 'namespace_name_example', 'object_name': 'object_name_example', 'time_diagnostic_end': '2013-10-20T19:20:30+01:00', 'time_diagnostic_start': '2013-10-20T19:20:30+01:00'}, 'deployment_type': 'OGG', 'deployment_url': 'deployment_url_example', 'description': 'description_example', 'display_name': 'display_name_example', 'fqdn': 'fqdn_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ingress_ips': [{'ingress_ip': 'ingress_ip_example'}], 'is_auto_scaling_enabled': True, 'is_healthy': True, 'is_latest_version': True, 'is_public': True, 'is_storage_utilization_limit_exceeded': True, 'license_model': 'LICENSE_INCLUDED', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'lifecycle_sub_state': 'RECOVERING', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'load_balancer_subnet_id': 'ocid1.loadbalancersubnet.oc1..xxxxxxEXAMPLExxxxxx', 'locks': [{'message': 'message_example', 'related_resource_id': 'ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'FULL'}], 'maintenance_configuration': {'bundle_release_upgrade_period_in_days': 56, 'interim_release_upgrade_period_in_days': 56, 'is_interim_release_auto_upgrade_enabled': True, 'major_release_upgrade_period_in_days': 56, 'security_patch_upgrade_period_in_days': 56}, 'maintenance_window': {'day': 'MONDAY', 'start_hour': 56}, 'next_maintenance_action_type': 'UPGRADE', 'next_maintenance_description': 'next_maintenance_description_example', 'nsg_ids': [], 'ogg_data': {'admin_username': 'admin_username_example', 'certificate': '-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----', 'credential_store': 'GOLDENGATE', 'deployment_name': 'deployment_name_example', 'identity_domain_id': 'ocid1.identitydomain.oc1..xxxxxxEXAMPLExxxxxx', 'ogg_version': 'ogg_version_example', 'password_secret_id': 'ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx'}, 'private_ip_address': 'private_ip_address_example', 'public_ip_address': 'public_ip_address_example', 'storage_utilization_in_bytes': 56, 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_of_next_maintenance': '2013-10-20T19:20:30+01:00', 'time_ogg_version_supported_until': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'time_upgrade_required': '2013-10-20T19:20:30+01:00'}
|
||
compartment_id
string
|
on success |
The OCID of the compartment being referenced.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
||
cpu_core_count
integer
|
on success |
The Minimum number of OCPUs to be made available for this Deployment.
Sample:
56
|
||
defined_tags
dictionary
|
on success |
Tags defined for this resource. Each key is predefined and scoped to a namespace.
Example: `{"foo-namespace": {"bar-key": "value"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
||
deployment_backup_id
string
|
on success |
The OCID of the backup being referenced.
Sample:
ocid1.deploymentbackup.oc1..xxxxxxEXAMPLExxxxxx
|
||
deployment_diagnostic_data
complex
|
on success |
|
||
bucket_name
string
|
on success |
Name of the bucket where the object is to be uploaded in the object storage
Sample:
bucket_name_example
|
||
diagnostic_state
string
|
on success |
The state of the deployment diagnostic collection.
Sample:
IN_PROGRESS
|
||
namespace_name
string
|
on success |
Name of namespace that serves as a container for all of your buckets
Sample:
namespace_name_example
|
||
object_name
string
|
on success |
Name of the diagnostic collected and uploaded to object storage
Sample:
object_name_example
|
||
time_diagnostic_end
string
|
on success |
The time until which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_diagnostic_start
string
|
on success |
The time from which the diagnostic collection should collect the logs. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
deployment_type
string
|
on success |
The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
Sample:
OGG
|
||
deployment_url
string
|
on success |
The URL of a resource.
Sample:
deployment_url_example
|
||
description
string
|
on success |
Metadata about this specific object.
Sample:
description_example
|
||
display_name
string
|
on success |
An object's Display Name.
Sample:
display_name_example
|
||
fqdn
string
|
on success |
A three-label Fully Qualified Domain Name (FQDN) for a resource.
Sample:
fqdn_example
|
||
freeform_tags
dictionary
|
on success |
A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.
Example: `{"bar-key": "value"}`
Sample:
{'Department': 'Finance'}
|
||
id
string
|
on success |
The OCID of the deployment being referenced.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
||
ingress_ips
complex
|
on success |
List of ingress IP addresses from where the GoldenGate deployment connects to this connection's privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.
|
||
ingress_ip
string
|
on success |
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
Sample:
ingress_ip_example
|
||
is_auto_scaling_enabled
boolean
|
on success |
Indicates if auto scaling is enabled for the Deployment's CPU core count.
Sample:
True
|
||
is_healthy
boolean
|
on success |
True if all of the aggregate resources are working correctly.
Sample:
True
|
||
is_latest_version
boolean
|
on success |
Indicates if the resource is the the latest available version.
Sample:
True
|
||
is_public
boolean
|
on success |
True if this object is publicly available.
Sample:
True
|
||
is_storage_utilization_limit_exceeded
boolean
|
on success |
Indicator will be true if the amount of storage being utilized exceeds the allowable storage utilization limit. Exceeding the limit may be an indication of a misconfiguration of the deployment's GoldenGate service.
Sample:
True
|
||
license_model
string
|
on success |
The Oracle license model that applies to a Deployment.
Sample:
LICENSE_INCLUDED
|
||
lifecycle_details
string
|
on success |
Describes the object's current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.
Sample:
lifecycle_details_example
|
||
lifecycle_state
string
|
on success |
Possible lifecycle states.
Sample:
CREATING
|
||
lifecycle_sub_state
string
|
on success |
Possible GGS lifecycle sub-states.
Sample:
RECOVERING
|
||
load_balancer_id
string
|
on success |
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
|
||
load_balancer_subnet_id
string
|
on success |
The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
Sample:
ocid1.loadbalancersubnet.oc1..xxxxxxEXAMPLExxxxxx
|
||
locks
complex
|
on success |
Locks associated with this resource.
|
||
message
string
|
on success |
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
Sample:
message_example
|
||
related_resource_id
string
|
on success |
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
Sample:
ocid1.relatedresource.oc1..xxxxxxEXAMPLExxxxxx
|
||
time_created
string
|
on success |
When the lock was created.
Sample:
2013-10-20T19:20:30+01:00
|
||
type
string
|
on success |
Type of the lock.
Sample:
FULL
|
||
maintenance_configuration
complex
|
on success |
|
||
bundle_release_upgrade_period_in_days
integer
|
on success |
Defines auto upgrade period for bundle releases. Manually configured period cannot be longer than service defined period for bundle releases. This period must be shorter or equal to major release upgrade period. Not passing this field during create will equate to using the service default.
Sample:
56
|
||
interim_release_upgrade_period_in_days
integer
|
on success |
Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
Sample:
56
|
||
is_interim_release_auto_upgrade_enabled
boolean
|
on success |
By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
Sample:
True
|
||
major_release_upgrade_period_in_days
integer
|
on success |
Defines auto upgrade period for major releases. Manually configured period cannot be longer than service defined period for major releases. Not passing this field during create will equate to using the service default.
Sample:
56
|
||
security_patch_upgrade_period_in_days
integer
|
on success |
Defines auto upgrade period for releases with security fix. Manually configured period cannot be longer than service defined period for security releases. Not passing this field during create will equate to using the service default.
Sample:
56
|
||
maintenance_window
complex
|
on success |
|
||
day
string
|
on success |
Days of the week.
Sample:
MONDAY
|
||
start_hour
integer
|
on success |
Start hour for maintenance period. Hour is in UTC.
Sample:
56
|
||
next_maintenance_action_type
string
|
on success |
Type of the next maintenance.
Sample:
UPGRADE
|
||
next_maintenance_description
string
|
on success |
Description of the next maintenance.
Sample:
next_maintenance_description_example
|
||
nsg_ids
list
/ elements=string
|
on success |
An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
|
||
ogg_data
complex
|
on success |
|
||
admin_username
string
|
on success |
The GoldenGate deployment console username.
Sample:
admin_username_example
|
||
certificate
string
|
on success |
The base64 encoded content of the PEM file containing the SSL certificate.
Sample:
-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----
|
||
credential_store
string
|
on success |
The type of credential store for OGG.
Sample:
GOLDENGATE
|
||
deployment_name
string
|
on success |
The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
Sample:
deployment_name_example
|
||
identity_domain_id
string
|
on success |
The OCID of the Identity Domain when IAM credential store is used.
Sample:
ocid1.identitydomain.oc1..xxxxxxEXAMPLExxxxxx
|
||
ogg_version
string
|
on success |
Version of OGG
Sample:
ogg_version_example
|
||
password_secret_id
string
|
on success |
The OCID of the Secret where the deployment password is stored.
Sample:
ocid1.passwordsecret.oc1..xxxxxxEXAMPLExxxxxx
|
||
private_ip_address
string
|
on success |
The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
Sample:
private_ip_address_example
|
||
public_ip_address
string
|
on success |
The public IP address representing the access point for the Deployment.
Sample:
public_ip_address_example
|
||
storage_utilization_in_bytes
integer
|
on success |
The amount of storage being utilized (in bytes)
Sample:
56
|
||
subnet_id
string
|
on success |
The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
|
||
system_tags
dictionary
|
on success |
The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.
Example: `{orcl-cloud: {free-tier-retain: true}}`
|
||
time_created
string
|
on success |
The time the resource was created. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_of_next_maintenance
string
|
on success |
The time of next maintenance schedule. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_ogg_version_supported_until
string
|
on success |
The time until OGG version is supported. After this date has passed OGG version will not be available anymore. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_updated
string
|
on success |
The time the resource was last updated. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
||
time_upgrade_required
string
|
on success |
Note: Deprecated: Use timeOfNextMaintenance instead, or related upgrade records to check, when deployment will be forced to upgrade to a newer version. Old description: The date the existing version in use will no longer be considered as usable and an upgrade will be required. This date is typically 6 months after the version was released for use by GGS. The format is defined by RFC3339, such as `2016-08-25T21:10:29.600Z`.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)