Oracle Cloud Infrastructure v1.11.0, Sep 27 23

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

oci.GoldenGate.Deployment

Explore with Pulumi AI

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

Create Deployment Resource

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               compartment_id: Optional[str] = None,
               cpu_core_count: Optional[int] = None,
               defined_tags: Optional[Mapping[str, Any]] = None,
               deployment_backup_id: Optional[str] = None,
               deployment_type: Optional[str] = None,
               description: Optional[str] = None,
               display_name: Optional[str] = None,
               fqdn: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, Any]] = None,
               is_auto_scaling_enabled: Optional[bool] = None,
               is_public: Optional[bool] = None,
               license_model: Optional[str] = None,
               maintenance_configuration: Optional[_goldengate.DeploymentMaintenanceConfigurationArgs] = None,
               maintenance_window: Optional[_goldengate.DeploymentMaintenanceWindowArgs] = None,
               nsg_ids: Optional[Sequence[str]] = None,
               ogg_data: Optional[_goldengate.DeploymentOggDataArgs] = None,
               state: Optional[str] = None,
               subnet_id: Optional[str] = None)
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)

func NewDeployment(ctx *Context, name string, args DeploymentArgs, opts ...ResourceOption) (*Deployment, error)

public Deployment(string name, DeploymentArgs args, CustomResourceOptions? opts = null)

public Deployment(String name, DeploymentArgs args)
public Deployment(String name, DeploymentArgs args, CustomResourceOptions options)

type: oci:GoldenGate:Deployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeploymentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DeploymentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DeploymentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DeploymentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DeploymentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Deployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Deployment resource accepts the following input properties:

CompartmentId string: (Updatable) The OCID of the compartment being referenced.
CpuCoreCount int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DeploymentType 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'.
DisplayName string: (Updatable) An object's Display Name.
IsAutoScalingEnabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
SubnetId string: (Updatable) The OCID of the subnet being referenced.
DefinedTags Dictionary<string, object>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
Description string: (Updatable) Metadata about this specific object.
Fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags Dictionary<string, object>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsPublic bool: (Updatable) True if this object is publicly available.
MaintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
MaintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
NsgIds List<string>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
State string: Possible lifecycle states.

CompartmentId string: (Updatable) The OCID of the compartment being referenced.
CpuCoreCount int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DeploymentType 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'.
DisplayName string: (Updatable) An object's Display Name.
IsAutoScalingEnabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
SubnetId string: (Updatable) The OCID of the subnet being referenced.
DefinedTags map[string]interface{}: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
Description string: (Updatable) Metadata about this specific object.
Fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[string]interface{}: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsPublic bool: (Updatable) True if this object is publicly available.
MaintenanceConfiguration DeploymentMaintenanceConfigurationArgs: (Updatable) Defines the maintenance configuration for create operation.
MaintenanceWindow DeploymentMaintenanceWindowArgs: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
NsgIds []string: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggData DeploymentOggDataArgs: (Updatable) Deployment Data for creating an OggDeployment
State string: Possible lifecycle states.

compartmentId String: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount Integer: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType 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'.
displayName String: (Updatable) An object's Display Name.
isAutoScalingEnabled Boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel String: (Updatable) The Oracle license model that applies to a Deployment.
subnetId String: (Updatable) The OCID of the subnet being referenced.
definedTags Map<String,Object>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
description String: (Updatable) Metadata about this specific object.
fqdn String: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String,Object>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isPublic Boolean: (Updatable) True if this object is publicly available.
maintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nsgIds List<String>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
state String: Possible lifecycle states.

compartmentId string: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount number: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType 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'.
displayName string: (Updatable) An object's Display Name.
isAutoScalingEnabled boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
subnetId string: (Updatable) The OCID of the subnet being referenced.
definedTags {[key: string]: any}: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId string: The OCID of the backup being referenced.
description string: (Updatable) Metadata about this specific object.
fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: string]: any}: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isPublic boolean: (Updatable) True if this object is publicly available.
maintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nsgIds string[]: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
state string: Possible lifecycle states.

compartment_id str: (Updatable) The OCID of the compartment being referenced.
cpu_core_count int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deployment_type str: 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'.
display_name str: (Updatable) An object's Display Name.
is_auto_scaling_enabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
license_model str: (Updatable) The Oracle license model that applies to a Deployment.
subnet_id str: (Updatable) The OCID of the subnet being referenced.
defined_tags Mapping[str, Any]: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id str: The OCID of the backup being referenced.
description str: (Updatable) Metadata about this specific object.
fqdn str: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, Any]: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
is_public bool: (Updatable) True if this object is publicly available.
maintenance_configuration DeploymentMaintenanceConfigurationArgs: (Updatable) Defines the maintenance configuration for create operation.
maintenance_window DeploymentMaintenanceWindowArgs: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nsg_ids Sequence[str]: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
ogg_data DeploymentOggDataArgs: (Updatable) Deployment Data for creating an OggDeployment
state str: Possible lifecycle states.

compartmentId String: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount Number: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType 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'.
displayName String: (Updatable) An object's Display Name.
isAutoScalingEnabled Boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel String: (Updatable) The Oracle license model that applies to a Deployment.
subnetId String: (Updatable) The OCID of the subnet being referenced.
definedTags Map<Any>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
description String: (Updatable) Metadata about this specific object.
fqdn String: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<Any>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isPublic Boolean: (Updatable) True if this object is publicly available.
maintenanceConfiguration Property Map: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow Property Map: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nsgIds List<String>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData Property Map: (Updatable) Deployment Data for creating an OggDeployment
state String: Possible lifecycle states.

Outputs

All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:

DeploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
DeploymentUrl string: The URL of a resource.
Id string: The provider-assigned unique ID for this managed resource.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsStorageUtilizationLimitExceeded bool: 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.
LifecycleDetails string: 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
PrivateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
PublicIpAddress string: The public IP address representing the access point for the Deployment.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SystemTags Dictionary<string, object>: 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}}
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

DeploymentDiagnosticDatas []DeploymentDeploymentDiagnosticData: Information regarding the deployment diagnostic collection
DeploymentUrl string: The URL of a resource.
Id string: The provider-assigned unique ID for this managed resource.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsStorageUtilizationLimitExceeded bool: 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.
LifecycleDetails string: 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
PrivateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
PublicIpAddress string: The public IP address representing the access point for the Deployment.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SystemTags map[string]interface{}: 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}}
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

deploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
deploymentUrl String: The URL of a resource.
id String: The provider-assigned unique ID for this managed resource.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isStorageUtilizationLimitExceeded Boolean: 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.
lifecycleDetails String: 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
privateIpAddress String: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress String: The public IP address representing the access point for the Deployment.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
systemTags Map<String,Object>: 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}}
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

deploymentDiagnosticDatas DeploymentDeploymentDiagnosticData[]: Information regarding the deployment diagnostic collection
deploymentUrl string: The URL of a resource.
id string: The provider-assigned unique ID for this managed resource.
isHealthy boolean: True if all of the aggregate resources are working correctly.
isLatestVersion boolean: Indicates if the resource is the the latest available version.
isStorageUtilizationLimitExceeded boolean: 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.
lifecycleDetails string: 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.
lifecycleSubState string: Possible GGS lifecycle sub-states.
nextMaintenanceActionType string: Type of the next maintenance.
nextMaintenanceDescription string: Description of the next maintenance.
privateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress string: The public IP address representing the access point for the Deployment.
storageUtilizationInBytes string: The amount of storage being utilized (in bytes)
systemTags {[key: string]: any}: 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}}
timeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil string: 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.
timeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired string: 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.

deployment_diagnostic_datas DeploymentDeploymentDiagnosticData]: Information regarding the deployment diagnostic collection
deployment_url str: The URL of a resource.
id str: The provider-assigned unique ID for this managed resource.
is_healthy bool: True if all of the aggregate resources are working correctly.
is_latest_version bool: Indicates if the resource is the the latest available version.
is_storage_utilization_limit_exceeded bool: 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.
lifecycle_details str: 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.
lifecycle_sub_state str: Possible GGS lifecycle sub-states.
next_maintenance_action_type str: Type of the next maintenance.
next_maintenance_description str: Description of the next maintenance.
private_ip_address str: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
public_ip_address str: The public IP address representing the access point for the Deployment.
storage_utilization_in_bytes str: The amount of storage being utilized (in bytes)
system_tags Mapping[str, Any]: 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 str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_of_next_maintenance str: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_ogg_version_supported_until str: 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.
time_updated str: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_upgrade_required str: 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.

deploymentDiagnosticDatas List<Property Map>: Information regarding the deployment diagnostic collection
deploymentUrl String: The URL of a resource.
id String: The provider-assigned unique ID for this managed resource.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isStorageUtilizationLimitExceeded Boolean: 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.
lifecycleDetails String: 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
privateIpAddress String: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress String: The public IP address representing the access point for the Deployment.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
systemTags Map<Any>: 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}}
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

Look up Existing Deployment Resource

Get an existing Deployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DeploymentState, opts?: CustomResourceOptions): Deployment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        cpu_core_count: Optional[int] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        deployment_backup_id: Optional[str] = None,
        deployment_diagnostic_datas: Optional[Sequence[_goldengate.DeploymentDeploymentDiagnosticDataArgs]] = None,
        deployment_type: Optional[str] = None,
        deployment_url: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        is_auto_scaling_enabled: Optional[bool] = None,
        is_healthy: Optional[bool] = None,
        is_latest_version: Optional[bool] = None,
        is_public: Optional[bool] = None,
        is_storage_utilization_limit_exceeded: Optional[bool] = None,
        license_model: Optional[str] = None,
        lifecycle_details: Optional[str] = None,
        lifecycle_sub_state: Optional[str] = None,
        maintenance_configuration: Optional[_goldengate.DeploymentMaintenanceConfigurationArgs] = None,
        maintenance_window: Optional[_goldengate.DeploymentMaintenanceWindowArgs] = None,
        next_maintenance_action_type: Optional[str] = None,
        next_maintenance_description: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        ogg_data: Optional[_goldengate.DeploymentOggDataArgs] = None,
        private_ip_address: Optional[str] = None,
        public_ip_address: Optional[str] = None,
        state: Optional[str] = None,
        storage_utilization_in_bytes: Optional[str] = None,
        subnet_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_of_next_maintenance: Optional[str] = None,
        time_ogg_version_supported_until: Optional[str] = None,
        time_updated: Optional[str] = None,
        time_upgrade_required: Optional[str] = None) -> Deployment

func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)

public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)

public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CompartmentId string: (Updatable) The OCID of the compartment being referenced.
CpuCoreCount int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags Dictionary<string, object>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
DeploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
DeploymentType 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'.
DeploymentUrl string: The URL of a resource.
Description string: (Updatable) Metadata about this specific object.
DisplayName string: (Updatable) An object's Display Name.
Fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags Dictionary<string, object>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoScalingEnabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsPublic bool: (Updatable) True if this object is publicly available.
IsStorageUtilizationLimitExceeded bool: 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.
LicenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
LifecycleDetails string: 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
MaintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
MaintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
NsgIds List<string>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
PrivateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
PublicIpAddress string: The public IP address representing the access point for the Deployment.
State string: Possible lifecycle states.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SubnetId string: (Updatable) The OCID of the subnet being referenced.
SystemTags Dictionary<string, object>: 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}}
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

CompartmentId string: (Updatable) The OCID of the compartment being referenced.
CpuCoreCount int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DefinedTags map[string]interface{}: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId string: The OCID of the backup being referenced.
DeploymentDiagnosticDatas []DeploymentDeploymentDiagnosticDataArgs: Information regarding the deployment diagnostic collection
DeploymentType 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'.
DeploymentUrl string: The URL of a resource.
Description string: (Updatable) Metadata about this specific object.
DisplayName string: (Updatable) An object's Display Name.
Fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[string]interface{}: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
IsAutoScalingEnabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
IsHealthy bool: True if all of the aggregate resources are working correctly.
IsLatestVersion bool: Indicates if the resource is the the latest available version.
IsPublic bool: (Updatable) True if this object is publicly available.
IsStorageUtilizationLimitExceeded bool: 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.
LicenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
LifecycleDetails string: 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.
LifecycleSubState string: Possible GGS lifecycle sub-states.
MaintenanceConfiguration DeploymentMaintenanceConfigurationArgs: (Updatable) Defines the maintenance configuration for create operation.
MaintenanceWindow DeploymentMaintenanceWindowArgs: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
NextMaintenanceActionType string: Type of the next maintenance.
NextMaintenanceDescription string: Description of the next maintenance.
NsgIds []string: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
OggData DeploymentOggDataArgs: (Updatable) Deployment Data for creating an OggDeployment
PrivateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
PublicIpAddress string: The public IP address representing the access point for the Deployment.
State string: Possible lifecycle states.
StorageUtilizationInBytes string: The amount of storage being utilized (in bytes)
SubnetId string: (Updatable) The OCID of the subnet being referenced.
SystemTags map[string]interface{}: 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}}
TimeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeOggVersionSupportedUntil string: 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.
TimeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
TimeUpgradeRequired string: 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.

compartmentId String: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount Integer: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<String,Object>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
deploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>: Information regarding the deployment diagnostic collection
deploymentType 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'.
deploymentUrl String: The URL of a resource.
description String: (Updatable) Metadata about this specific object.
displayName String: (Updatable) An object's Display Name.
fqdn String: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String,Object>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoScalingEnabled Boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isPublic Boolean: (Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded Boolean: 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.
licenseModel String: (Updatable) The Oracle license model that applies to a Deployment.
lifecycleDetails String: 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
maintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
nsgIds List<String>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
privateIpAddress String: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress String: The public IP address representing the access point for the Deployment.
state String: Possible lifecycle states.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
subnetId String: (Updatable) The OCID of the subnet being referenced.
systemTags Map<String,Object>: 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}}
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

compartmentId string: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount number: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
definedTags {[key: string]: any}: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId string: The OCID of the backup being referenced.
deploymentDiagnosticDatas DeploymentDeploymentDiagnosticData[]: Information regarding the deployment diagnostic collection
deploymentType 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'.
deploymentUrl string: The URL of a resource.
description string: (Updatable) Metadata about this specific object.
displayName string: (Updatable) An object's Display Name.
fqdn string: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: string]: any}: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoScalingEnabled boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy boolean: True if all of the aggregate resources are working correctly.
isLatestVersion boolean: Indicates if the resource is the the latest available version.
isPublic boolean: (Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded boolean: 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.
licenseModel string: (Updatable) The Oracle license model that applies to a Deployment.
lifecycleDetails string: 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.
lifecycleSubState string: Possible GGS lifecycle sub-states.
maintenanceConfiguration DeploymentMaintenanceConfiguration: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow DeploymentMaintenanceWindow: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nextMaintenanceActionType string: Type of the next maintenance.
nextMaintenanceDescription string: Description of the next maintenance.
nsgIds string[]: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData DeploymentOggData: (Updatable) Deployment Data for creating an OggDeployment
privateIpAddress string: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress string: The public IP address representing the access point for the Deployment.
state string: Possible lifecycle states.
storageUtilizationInBytes string: The amount of storage being utilized (in bytes)
subnetId string: (Updatable) The OCID of the subnet being referenced.
systemTags {[key: string]: any}: 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}}
timeCreated string: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance string: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil string: 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.
timeUpdated string: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired string: 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.

compartment_id str: (Updatable) The OCID of the compartment being referenced.
cpu_core_count int: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
defined_tags Mapping[str, Any]: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id str: The OCID of the backup being referenced.
deployment_diagnostic_datas DeploymentDeploymentDiagnosticDataArgs]: Information regarding the deployment diagnostic collection
deployment_type str: 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'.
deployment_url str: The URL of a resource.
description str: (Updatable) Metadata about this specific object.
display_name str: (Updatable) An object's Display Name.
fqdn str: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, Any]: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
is_auto_scaling_enabled bool: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
is_healthy bool: True if all of the aggregate resources are working correctly.
is_latest_version bool: Indicates if the resource is the the latest available version.
is_public bool: (Updatable) True if this object is publicly available.
is_storage_utilization_limit_exceeded bool: 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.
license_model str: (Updatable) The Oracle license model that applies to a Deployment.
lifecycle_details str: 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.
lifecycle_sub_state str: Possible GGS lifecycle sub-states.
maintenance_configuration DeploymentMaintenanceConfigurationArgs: (Updatable) Defines the maintenance configuration for create operation.
maintenance_window DeploymentMaintenanceWindowArgs: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
next_maintenance_action_type str: Type of the next maintenance.
next_maintenance_description str: Description of the next maintenance.
nsg_ids Sequence[str]: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
ogg_data DeploymentOggDataArgs: (Updatable) Deployment Data for creating an OggDeployment
private_ip_address str: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
public_ip_address str: The public IP address representing the access point for the Deployment.
state str: Possible lifecycle states.
storage_utilization_in_bytes str: The amount of storage being utilized (in bytes)
subnet_id str: (Updatable) The OCID of the subnet being referenced.
system_tags Mapping[str, Any]: 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 str: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_of_next_maintenance str: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_ogg_version_supported_until str: 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.
time_updated str: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
time_upgrade_required str: 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.

compartmentId String: (Updatable) The OCID of the compartment being referenced.
cpuCoreCount Number: (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
definedTags Map<Any>: (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId String: The OCID of the backup being referenced.
deploymentDiagnosticDatas List<Property Map>: Information regarding the deployment diagnostic collection
deploymentType 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'.
deploymentUrl String: The URL of a resource.
description String: (Updatable) Metadata about this specific object.
displayName String: (Updatable) An object's Display Name.
fqdn String: (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<Any>: (Updatable) A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
isAutoScalingEnabled Boolean: (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
isHealthy Boolean: True if all of the aggregate resources are working correctly.
isLatestVersion Boolean: Indicates if the resource is the the latest available version.
isPublic Boolean: (Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded Boolean: 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.
licenseModel String: (Updatable) The Oracle license model that applies to a Deployment.
lifecycleDetails String: 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.
lifecycleSubState String: Possible GGS lifecycle sub-states.
maintenanceConfiguration Property Map: (Updatable) Defines the maintenance configuration for create operation.
maintenanceWindow Property Map: (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
nextMaintenanceActionType String: Type of the next maintenance.
nextMaintenanceDescription String: Description of the next maintenance.
nsgIds List<String>: (Updatable) An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
oggData Property Map: (Updatable) Deployment Data for creating an OggDeployment
privateIpAddress String: The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
publicIpAddress String: The public IP address representing the access point for the Deployment.
state String: Possible lifecycle states.
storageUtilizationInBytes String: The amount of storage being utilized (in bytes)
subnetId String: (Updatable) The OCID of the subnet being referenced.
systemTags Map<Any>: 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}}
timeCreated String: The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOfNextMaintenance String: The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeOggVersionSupportedUntil String: 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.
timeUpdated String: The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
timeUpgradeRequired String: 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.

Supporting Types

DeploymentDeploymentDiagnosticData, DeploymentDeploymentDiagnosticDataArgs

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the deployment diagnostic collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeDiagnosticEnd string: 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.
TimeDiagnosticStart string: 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.

Bucket string: Name of the bucket where the object is to be uploaded in the object storage
DiagnosticState string: The state of the deployment diagnostic collection.
Namespace string: Name of namespace that serves as a container for all of your buckets
Object string: Name of the diagnostic collected and uploaded to object storage
TimeDiagnosticEnd string: 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.
TimeDiagnosticStart string: 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.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the deployment diagnostic collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd String: 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.
timeDiagnosticStart String: 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.

bucket string: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState string: The state of the deployment diagnostic collection.
namespace string: Name of namespace that serves as a container for all of your buckets
object string: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd string: 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.
timeDiagnosticStart string: 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.

bucket str: Name of the bucket where the object is to be uploaded in the object storage
diagnostic_state str: The state of the deployment diagnostic collection.
namespace str: Name of namespace that serves as a container for all of your buckets
object str: Name of the diagnostic collected and uploaded to object storage
time_diagnostic_end str: 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.
time_diagnostic_start str: 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.

bucket String: Name of the bucket where the object is to be uploaded in the object storage
diagnosticState String: The state of the deployment diagnostic collection.
namespace String: Name of namespace that serves as a container for all of your buckets
object String: Name of the diagnostic collected and uploaded to object storage
timeDiagnosticEnd String: 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.
timeDiagnosticStart String: 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.

DeploymentMaintenanceConfiguration, DeploymentMaintenanceConfigurationArgs

BundleReleaseUpgradePeriodInDays int: (Updatable) 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.
InterimReleaseUpgradePeriodInDays int: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
IsInterimReleaseAutoUpgradeEnabled bool: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
MajorReleaseUpgradePeriodInDays int: (Updatable) 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.
SecurityPatchUpgradePeriodInDays int: (Updatable) 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.

BundleReleaseUpgradePeriodInDays int: (Updatable) 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.
InterimReleaseUpgradePeriodInDays int: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
IsInterimReleaseAutoUpgradeEnabled bool: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
MajorReleaseUpgradePeriodInDays int: (Updatable) 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.
SecurityPatchUpgradePeriodInDays int: (Updatable) 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.

bundleReleaseUpgradePeriodInDays Integer: (Updatable) 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.
interimReleaseUpgradePeriodInDays Integer: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled Boolean: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays Integer: (Updatable) 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.
securityPatchUpgradePeriodInDays Integer: (Updatable) 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.

bundleReleaseUpgradePeriodInDays number: (Updatable) 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.
interimReleaseUpgradePeriodInDays number: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled boolean: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays number: (Updatable) 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.
securityPatchUpgradePeriodInDays number: (Updatable) 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.

bundle_release_upgrade_period_in_days int: (Updatable) 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.
interim_release_upgrade_period_in_days int: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
is_interim_release_auto_upgrade_enabled bool: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
major_release_upgrade_period_in_days int: (Updatable) 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.
security_patch_upgrade_period_in_days int: (Updatable) 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.

bundleReleaseUpgradePeriodInDays Number: (Updatable) 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.
interimReleaseUpgradePeriodInDays Number: (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
isInterimReleaseAutoUpgradeEnabled Boolean: (Updatable) By default auto upgrade for interim releases are not enabled. If auto-upgrade is enabled for interim release, you have to specify interimReleaseUpgradePeriodInDays too.
majorReleaseUpgradePeriodInDays Number: (Updatable) 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.
securityPatchUpgradePeriodInDays Number: (Updatable) 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.

DeploymentMaintenanceWindow, DeploymentMaintenanceWindowArgs

Day string: (Updatable) Days of the week.
StartHour int: (Updatable) Start hour for maintenance period. Hour is in UTC.

Day string: (Updatable) Days of the week.
StartHour int: (Updatable) Start hour for maintenance period. Hour is in UTC.

day String: (Updatable) Days of the week.
startHour Integer: (Updatable) Start hour for maintenance period. Hour is in UTC.

day string: (Updatable) Days of the week.
startHour number: (Updatable) Start hour for maintenance period. Hour is in UTC.

day str: (Updatable) Days of the week.
start_hour int: (Updatable) Start hour for maintenance period. Hour is in UTC.

day String: (Updatable) Days of the week.
startHour Number: (Updatable) Start hour for maintenance period. Hour is in UTC.

DeploymentOggData, DeploymentOggDataArgs

DeploymentName 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.
AdminPassword string: (Updatable) 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".
AdminUsername string: (Updatable) The GoldenGate deployment console username.
Certificate string: (Updatable) A PEM-encoded SSL certificate.
CredentialStore string: (Updatable) The type of credential store for OGG.
IdentityDomainId string: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
Key string: (Updatable) A PEM-encoded private key.
OggVersion string: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
PasswordSecretId string: (Updatable) The OCID of the Secret where the deployment password is stored.

DeploymentName 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.
AdminPassword string: (Updatable) 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".
AdminUsername string: (Updatable) The GoldenGate deployment console username.
Certificate string: (Updatable) A PEM-encoded SSL certificate.
CredentialStore string: (Updatable) The type of credential store for OGG.
IdentityDomainId string: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
Key string: (Updatable) A PEM-encoded private key.
OggVersion string: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
PasswordSecretId string: (Updatable) The OCID of the Secret where the deployment password is stored.

deploymentName 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.
adminPassword String: (Updatable) 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".
adminUsername String: (Updatable) The GoldenGate deployment console username.
certificate String: (Updatable) A PEM-encoded SSL certificate.
credentialStore String: (Updatable) The type of credential store for OGG.
identityDomainId String: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
key String: (Updatable) A PEM-encoded private key.
oggVersion String: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
passwordSecretId String: (Updatable) The OCID of the Secret where the deployment password is stored.

deploymentName 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.
adminPassword string: (Updatable) 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".
adminUsername string: (Updatable) The GoldenGate deployment console username.
certificate string: (Updatable) A PEM-encoded SSL certificate.
credentialStore string: (Updatable) The type of credential store for OGG.
identityDomainId string: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
key string: (Updatable) A PEM-encoded private key.
oggVersion string: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
passwordSecretId string: (Updatable) The OCID of the Secret where the deployment password is stored.

deployment_name str: 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.
admin_password str: (Updatable) 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".
admin_username str: (Updatable) The GoldenGate deployment console username.
certificate str: (Updatable) A PEM-encoded SSL certificate.
credential_store str: (Updatable) The type of credential store for OGG.
identity_domain_id str: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
key str: (Updatable) A PEM-encoded private key.
ogg_version str: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
password_secret_id str: (Updatable) The OCID of the Secret where the deployment password is stored.

deploymentName 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.
adminPassword String: (Updatable) 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".
adminUsername String: (Updatable) The GoldenGate deployment console username.
certificate String: (Updatable) A PEM-encoded SSL certificate.
credentialStore String: (Updatable) The type of credential store for OGG.
identityDomainId String: (Updatable) The OCID of the Identity Domain when IAM credential store is used.
key String: (Updatable) A PEM-encoded private key.
oggVersion String: (Updatable) Version of ogg to use by deployment. By updating version you can upgrade your deployment to a newer version. Downgrade to older version is not supported.
passwordSecretId String: (Updatable) The OCID of the Secret where the deployment password is stored.

Import

Deployments can be imported using the id, e.g.

 $ pulumi import oci:GoldenGate/deployment:Deployment test_deployment "id"

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v1.11.0 published on Wednesday, Sep 27, 2023 by Pulumi

pulumi/pulumi-oci

oci.GoldenGate.Deployment

On this page

On this page

Create Deployment Resource

Deployment Resource Properties

Inputs

Outputs

Look up Existing Deployment Resource

Supporting Types

DeploymentDeploymentDiagnosticData, DeploymentDeploymentDiagnosticDataArgs

DeploymentMaintenanceConfiguration, DeploymentMaintenanceConfigurationArgs

DeploymentMaintenanceWindow, DeploymentMaintenanceWindowArgs

DeploymentOggData, DeploymentOggDataArgs

Import

Package Details

On this page

On this page