/**
 * GoldenGate API
 * Use the Oracle Cloud Infrastructure GoldenGate APIs to perform data replication operations.

 * OpenAPI spec version: 20200407
 *
 *
 * NOTE: This class is auto generated by OracleSDKGenerator.
 * Do not edit the class manually.
 *
 * Copyright (c) 2020, 2026, Oracle and/or its affiliates.  All rights reserved.
 * This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
 */
import * as model from "../model";
/**
 * A container for your OCI GoldenGate resources, such as the OCI GoldenGate deployment console.
 *
 */
export interface Deployment {
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
     *
     */
    "id": string;
    /**
     * An object's Display Name.
     *
     */
    "displayName"?: string;
    /**
     * Metadata about this specific object.
     *
     */
    "description"?: string;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced.
     *
     */
    "compartmentId": string;
    /**
     * The availability domain of a placement.
     */
    "availabilityDomain"?: string;
    /**
     * The fault domain of a placement.
     */
    "faultDomain"?: string;
    /**
     * The type of the deployment role.
     *
     */
    "deploymentRole"?: model.DeploymentRole;
    /**
     * The time of the last role change. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}.
     *
     */
    "timeRoleChanged"?: Date;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced.
     *
     */
    "sourceDeploymentId"?: string;
    /**
     * An array of local peers of deployment
     *
     */
    "placements"?: Array<model.DeploymentPlacementInfo>;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced.
     *
     */
    "deploymentBackupId"?: string;
    /**
     * The time the resource was created. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}.
     *
     */
    "timeCreated"?: Date;
    /**
     * The time the resource was last updated. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}.
     *
     */
    "timeUpdated"?: Date;
    /**
     * Possible lifecycle states for a Deployment.
     *
     */
    "lifecycleState"?: Deployment.LifecycleState;
    /**
     * Possible GGS lifecycle sub-states.
     *
     */
    "lifecycleSubState"?: model.LifecycleSubState;
    /**
     * 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.
     *
     */
    "lifecycleDetails"?: string;
    /**
      * A simple key-value pair that is applied without any predefined name, type, or scope. Exists
  * for cross-compatibility only.
  * <p>
  Example: {@code {\"bar-key\": \"value\"}}
  *
      */
    "freeformTags"?: {
        [key: string]: string;
    };
    /**
      * Tags defined for this resource. Each key is predefined and scoped to a namespace.
  * <p>
  Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}
  *
      */
    "definedTags"?: {
        [key: string]: {
            [key: string]: any;
        };
    };
    /**
     * Locks associated with this resource.
     */
    "locks"?: Array<model.ResourceLock>;
    /**
     * True if all of the aggregate resources are working correctly.
     *
     */
    "isHealthy"?: boolean;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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.
     *
     */
    "subnetId": string;
    /**
      * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a public subnet in the customer tenancy used to host the public load balancer of the deployment.
  * <p>
  Rules:
  * - Create: Mandatory when isPublic is true. Must be a public, regional subnet in the same VCN as subnetId.
  * - Update:
  *   - For public deployments, this property must be present and is immutable once set (cannot be changed to a different subnet).
  *   - Legacy exception: a public deployment created without this property may continue to be updated without providing it; once set, it becomes immutable.
  * <p>
  Validation:
  * - Must reference a public subnet.
  * - Must be a regional subnet.
  * - Must be in the same VCN as subnetId.
  *
      */
    "loadBalancerSubnetId"?: string;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the loadbalancer in the customer's subnet.
     * The loadbalancer of the public deployment created in the customer subnet.
     *
     */
    "loadBalancerId"?: string;
    /**
     * A three-label Fully Qualified Domain Name (FQDN) for a resource.
     *
     */
    "fqdn"?: string;
    /**
     * The Oracle license model that applies to a Deployment.
     *
     */
    "licenseModel": model.LicenseModel;
    /**
     * Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit.
     * If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.
     *
     */
    "isByolCpuCoreCountLimitEnabled"?: boolean;
    /**
     * The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type.
     * Any CPU usage above this limit is considered as License Included and billed.
     *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
     */
    "byolCpuCoreCountLimit"?: number;
    /**
     * Specifies whether the deployment is used in a production or development/testing environment.
     *
     */
    "environmentType"?: model.EnvironmentType;
    /**
     * The deployment category defines the broad separation of the deployment type into four categories.
     * Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS', 'DATA_TRANSFORMS' and 'DATA_VERIFICATION'.
     *
     */
    "category": model.DeploymentCategory;
    /**
     * The Minimum number of OCPUs to be made available for this Deployment.
     *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
     */
    "cpuCoreCount": number;
    /**
     * Indicates if auto scaling is enabled for the Deployment's CPU core count.
     *
     */
    "isAutoScalingEnabled": boolean;
    /**
     * An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.
     *
     */
    "nsgIds"?: Array<string>;
    /**
     * True if this object is publicly available.
     *
     */
    "isPublic"?: boolean;
    /**
     * The public IP address representing the access point for the Deployment.
     *
     */
    "publicIpAddress"?: string;
    /**
     * The private IP address in the customer's VCN representing the access point for the
     * associated endpoint service in the GoldenGate service VCN.
     *
     */
    "privateIpAddress"?: string;
    /**
     * The URL of a resource.
     *
     */
    "deploymentUrl"?: string;
    /**
      * 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](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
  * <p>
  Example: {@code {orcl-cloud: {free-tier-retain: true}}}
  *
      */
    "systemTags"?: {
        [key: string]: {
            [key: string]: any;
        };
    };
    /**
     * Indicates if the resource is the the latest available version.
     *
     */
    "isLatestVersion"?: boolean;
    /**
     * The amount of storage being utilized (in bytes)
     *  Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.
     */
    "storageUtilizationInBytes"?: number;
    /**
     * Deprecated: This field is not updated and will be removed in future versions. If storage utilization exceeds the limit, the respective warning message will appear in deployment messages, which can be accessed through /messages?deploymentId=.
     * 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.
     *
     */
    "isStorageUtilizationLimitExceeded"?: boolean;
    /**
     * 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'.
     *
     */
    "deploymentType": model.DeploymentType;
    "oggData"?: model.OggDeployment;
    "deploymentDiagnosticData"?: model.DeploymentDiagnosticData;
    "maintenanceWindow"?: model.MaintenanceWindow;
    /**
     * The time of next maintenance schedule. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}.
     *
     */
    "timeOfNextMaintenance"?: Date;
    /**
     * Type of the next maintenance.
     *
     */
    "nextMaintenanceActionType"?: model.MaintenanceActionType;
    /**
     * Description of the next maintenance.
     *
     */
    "nextMaintenanceDescription"?: string;
    "maintenanceConfiguration"?: model.MaintenanceConfiguration;
    /**
     * 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](https://tools.ietf.org/html/rfc3339), such as {@code 2016-08-25T21:10:29.600Z}.
     *
     */
    "timeOggVersionSupportedUntil"?: Date;
    "backupSchedule"?: model.BackupSchedule;
    /**
     * The timestamp of last deployment backup scheduled. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2024-10-25T18:19:29.600Z}.
     *
     */
    "timeLastBackupScheduled"?: Date;
    /**
     * The timestamp of next deployment backup scheduled. The format is defined by
     * [RFC3339](https://tools.ietf.org/html/rfc3339), such as {@code 2024-10-26T20:19:29.600Z}.
     *
     */
    "timeNextBackupScheduled"?: Date;
    /**
     * 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.
     *
     */
    "ingressIps"?: Array<model.IngressIpDetails>;
    /**
     * The [OCID](https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with.
     */
    "subscriptionId"?: string;
    /**
     * The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource.
     * Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud
     * subscription id is provided. Otherwise the cluster placement group must not be provided.
     *
     */
    "clusterPlacementGroupId"?: string;
    /**
      * Security attributes for this resource. Each key is predefined and scoped to a namespace.
  * For more information, see [Resource Tags](https://docs.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
  * <p>
  Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}
  *
      */
    "securityAttributes"?: {
        [key: string]: {
            [key: string]: any;
        };
    };
    /**
     * Indicates if disaster recovery is enabled for a deployment.
     * If not specified, disaster recovery is ENABLED when no clusterPlacementGroupId is provided, and DISABLED when a clusterPlacementGroupId is provided.
     *
     */
    "disasterRecoveryStatus"?: model.DisasterRecoveryStatus;
}
export declare namespace Deployment {
    enum LifecycleState {
        Creating = "CREATING",
        Updating = "UPDATING",
        Active = "ACTIVE",
        Inactive = "INACTIVE",
        Deleting = "DELETING",
        Deleted = "DELETED",
        Failed = "FAILED",
        NeedsAttention = "NEEDS_ATTENTION",
        /**
         * This value is used if a service returns a value for this enum that is not recognized by this
         * version of the SDK.
         */
        UnknownValue = "UNKNOWN_VALUE"
    }
    function getJsonObj(obj: Deployment): object;
    function getDeserializedJsonObj(obj: Deployment): object;
}