import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Deployment resource in Oracle Cloud Infrastructure Golden Gate service. * * Retrieves a deployment. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testDeployment = oci.goldengate.getDeployment({ * deploymentId: testDeploymentOciGoldenGateDeployment.id, * }); * ``` */ export declare function getDeployment(args: GetDeploymentArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getDeployment. */ export interface GetDeploymentArgs { /** * A unique Deployment identifier. */ deploymentId: string; } /** * A collection of values returned by getDeployment. */ export interface GetDeploymentResult { /** * The availability domain of a placement. */ readonly availabilityDomain: string; /** * Defines the schedule of the deployment backup. */ readonly backupSchedules: outputs.GoldenGate.GetDeploymentBackupSchedule[]; /** * 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. */ readonly byolCpuCoreCountLimit: number; /** * 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'. */ readonly category: string; /** * The OCID(https://docs.cloud.oracle.com/iaas/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. */ readonly clusterPlacementGroupId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment being referenced. */ readonly compartmentId: string; /** * The Minimum number of OCPUs to be made available for this Deployment. */ readonly cpuCoreCount: number; /** * Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` */ readonly definedTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the backup being referenced. */ readonly deploymentBackupId: string; /** * Information regarding the deployment diagnostic collection */ readonly deploymentDiagnosticDatas: outputs.GoldenGate.GetDeploymentDeploymentDiagnosticData[]; readonly deploymentId: string; /** * The type of the deployment role. */ readonly deploymentRole: 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'. */ readonly deploymentType: string; /** * The URL of a resource. */ readonly deploymentUrl: string; /** * Metadata about this specific object. */ readonly description: string; /** * 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. */ readonly disasterRecoveryStatus: string; /** * An object's Display Name. */ readonly displayName: string; /** * Specifies whether the deployment is used in a production or development/testing environment. */ readonly environmentType: string; /** * The fault domain of a placement. */ readonly faultDomain: string; /** * A three-label Fully Qualified Domain Name (FQDN) for a resource. */ readonly fqdn: string; /** * A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` */ readonly freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced. */ readonly id: string; /** * 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. */ readonly ingressIps: outputs.GoldenGate.GetDeploymentIngressIp[]; /** * Indicates if auto scaling is enabled for the Deployment's CPU core count. */ readonly isAutoScalingEnabled: boolean; /** * 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. */ readonly isByolCpuCoreCountLimitEnabled: boolean; /** * True if all of the aggregate resources are working correctly. */ readonly isHealthy: boolean; /** * Indicates if the resource is the the latest available version. */ readonly isLatestVersion: boolean; readonly isLockOverride: boolean; /** * True if this object is publicly available. */ readonly isPublic: boolean; /** * 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. * * @deprecated The 'is_storage_utilization_limit_exceeded' field has been deprecated. It is no longer supported. */ readonly isStorageUtilizationLimitExceeded: boolean; /** * The Oracle license model that applies to a Deployment. */ readonly licenseModel: 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. */ readonly lifecycleDetails: string; /** * Possible GGS lifecycle sub-states. */ readonly lifecycleSubState: string; /** * The [OCID](https://docs.cloud.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. */ readonly loadBalancerId: string; /** * The [OCID](https://docs.cloud.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. */ readonly loadBalancerSubnetId: string; /** * Locks associated with this resource. */ readonly locks: outputs.GoldenGate.GetDeploymentLock[]; /** * Attributes for configuring automatic deployment maintenance. */ readonly maintenanceConfigurations: outputs.GoldenGate.GetDeploymentMaintenanceConfiguration[]; /** * Defines the maintenance window, when automatic actions can be performed. */ readonly maintenanceWindows: outputs.GoldenGate.GetDeploymentMaintenanceWindow[]; /** * Type of the next maintenance. */ readonly nextMaintenanceActionType: string; /** * Description of the next maintenance. */ readonly nextMaintenanceDescription: string; /** * An array of Network Security Group OCIDs used to define network access for either Deployments or Connections. */ readonly nsgIds: string[]; /** * Deployment Data for an OggDeployment */ readonly oggDatas: outputs.GoldenGate.GetDeploymentOggData[]; /** * An array of local peers of deployment */ readonly placements: outputs.GoldenGate.GetDeploymentPlacement[]; /** * The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN. */ readonly privateIpAddress: string; /** * The public IP address representing the access point for the Deployment. */ readonly publicIpAddress: string; /** * Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` */ readonly securityAttributes: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the deployment being referenced. */ readonly sourceDeploymentId: string; /** * Possible lifecycle states for a Deployment. */ readonly state: string; /** * The amount of storage being utilized (in bytes) */ readonly storageUtilizationInBytes: string; /** * The [OCID](https://docs.cloud.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. */ readonly subnetId: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the subscription with which resource needs to be associated with. */ readonly subscriptionId: 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.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` */ readonly systemTags: { [key: string]: string; }; /** * The time the resource was created. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ readonly timeCreated: string; /** * The timestamp of last deployment backup scheduled. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-25T18:19:29.600Z`. */ readonly timeLastBackupScheduled: string; /** * The timestamp of next deployment backup scheduled. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2024-10-26T20:19:29.600Z`. */ readonly timeNextBackupScheduled: string; /** * The time of next maintenance schedule. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ readonly timeOfNextMaintenance: 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](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ readonly timeOggVersionSupportedUntil: string; /** * The time of the last role change. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ readonly timeRoleChanged: string; /** * The time the resource was last updated. The format is defined by [RFC3339](https://tools.ietf.org/html/rfc3339), such as `2016-08-25T21:10:29.600Z`. */ readonly timeUpdated: string; } /** * This data source provides details about a specific Deployment resource in Oracle Cloud Infrastructure Golden Gate service. * * Retrieves a deployment. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testDeployment = oci.goldengate.getDeployment({ * deploymentId: testDeploymentOciGoldenGateDeployment.id, * }); * ``` */ export declare function getDeploymentOutput(args: GetDeploymentOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getDeployment. */ export interface GetDeploymentOutputArgs { /** * A unique Deployment identifier. */ deploymentId: pulumi.Input; } //# sourceMappingURL=getDeployment.d.ts.map