1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GoldenGate
  5. Deployment
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.GoldenGate.Deployment

Explore with Pulumi AI

This resource provides the Deployment resource in Oracle Cloud Infrastructure Golden Gate service.

Creates a new Deployment.

Create Deployment Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
               args: DeploymentArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Deployment(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               display_name: Optional[str] = None,
               compartment_id: Optional[str] = None,
               cpu_core_count: Optional[int] = None,
               subnet_id: Optional[str] = None,
               license_model: Optional[str] = None,
               deployment_type: Optional[str] = None,
               is_auto_scaling_enabled: Optional[bool] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               deployment_backup_id: Optional[str] = None,
               fqdn: Optional[str] = None,
               backup_schedule: Optional[_goldengate.DeploymentBackupScheduleArgs] = None,
               description: Optional[str] = None,
               is_lock_override: Optional[bool] = None,
               is_public: Optional[bool] = None,
               environment_type: Optional[str] = None,
               load_balancer_subnet_id: Optional[str] = None,
               locks: Optional[Sequence[_goldengate.DeploymentLockArgs]] = 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,
               defined_tags: Optional[Mapping[str, str]] = 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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. DeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var exampledeploymentResourceResourceFromGoldenGatedeployment = new Oci.GoldenGate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", new()
{
    DisplayName = "string",
    CompartmentId = "string",
    CpuCoreCount = 0,
    SubnetId = "string",
    LicenseModel = "string",
    DeploymentType = "string",
    IsAutoScalingEnabled = false,
    FreeformTags = 
    {
        { "string", "string" },
    },
    DeploymentBackupId = "string",
    Fqdn = "string",
    BackupSchedule = new Oci.GoldenGate.Inputs.DeploymentBackupScheduleArgs
    {
        Bucket = "string",
        CompartmentId = "string",
        FrequencyBackupScheduled = "string",
        IsMetadataOnly = false,
        Namespace = "string",
        TimeBackupScheduled = "string",
    },
    Description = "string",
    IsLockOverride = false,
    IsPublic = false,
    EnvironmentType = "string",
    LoadBalancerSubnetId = "string",
    Locks = new[]
    {
        new Oci.GoldenGate.Inputs.DeploymentLockArgs
        {
            Type = "string",
            Message = "string",
            RelatedResourceId = "string",
            TimeCreated = "string",
        },
    },
    MaintenanceConfiguration = new Oci.GoldenGate.Inputs.DeploymentMaintenanceConfigurationArgs
    {
        BundleReleaseUpgradePeriodInDays = 0,
        InterimReleaseUpgradePeriodInDays = 0,
        IsInterimReleaseAutoUpgradeEnabled = false,
        MajorReleaseUpgradePeriodInDays = 0,
        SecurityPatchUpgradePeriodInDays = 0,
    },
    MaintenanceWindow = new Oci.GoldenGate.Inputs.DeploymentMaintenanceWindowArgs
    {
        Day = "string",
        StartHour = 0,
    },
    NsgIds = new[]
    {
        "string",
    },
    OggData = new Oci.GoldenGate.Inputs.DeploymentOggDataArgs
    {
        DeploymentName = "string",
        AdminPassword = "string",
        AdminUsername = "string",
        Certificate = "string",
        CredentialStore = "string",
        GroupToRolesMapping = new Oci.GoldenGate.Inputs.DeploymentOggDataGroupToRolesMappingArgs
        {
            SecurityGroupId = "string",
            AdministratorGroupId = "string",
            OperatorGroupId = "string",
            UserGroupId = "string",
        },
        IdentityDomainId = "string",
        Key = "string",
        OggVersion = "string",
        PasswordSecretId = "string",
    },
    State = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := GoldenGate.NewDeployment(ctx, "exampledeploymentResourceResourceFromGoldenGatedeployment", &GoldenGate.DeploymentArgs{
	DisplayName:          pulumi.String("string"),
	CompartmentId:        pulumi.String("string"),
	CpuCoreCount:         pulumi.Int(0),
	SubnetId:             pulumi.String("string"),
	LicenseModel:         pulumi.String("string"),
	DeploymentType:       pulumi.String("string"),
	IsAutoScalingEnabled: pulumi.Bool(false),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DeploymentBackupId: pulumi.String("string"),
	Fqdn:               pulumi.String("string"),
	BackupSchedule: &goldengate.DeploymentBackupScheduleArgs{
		Bucket:                   pulumi.String("string"),
		CompartmentId:            pulumi.String("string"),
		FrequencyBackupScheduled: pulumi.String("string"),
		IsMetadataOnly:           pulumi.Bool(false),
		Namespace:                pulumi.String("string"),
		TimeBackupScheduled:      pulumi.String("string"),
	},
	Description:          pulumi.String("string"),
	IsLockOverride:       pulumi.Bool(false),
	IsPublic:             pulumi.Bool(false),
	EnvironmentType:      pulumi.String("string"),
	LoadBalancerSubnetId: pulumi.String("string"),
	Locks: goldengate.DeploymentLockArray{
		&goldengate.DeploymentLockArgs{
			Type:              pulumi.String("string"),
			Message:           pulumi.String("string"),
			RelatedResourceId: pulumi.String("string"),
			TimeCreated:       pulumi.String("string"),
		},
	},
	MaintenanceConfiguration: &goldengate.DeploymentMaintenanceConfigurationArgs{
		BundleReleaseUpgradePeriodInDays:   pulumi.Int(0),
		InterimReleaseUpgradePeriodInDays:  pulumi.Int(0),
		IsInterimReleaseAutoUpgradeEnabled: pulumi.Bool(false),
		MajorReleaseUpgradePeriodInDays:    pulumi.Int(0),
		SecurityPatchUpgradePeriodInDays:   pulumi.Int(0),
	},
	MaintenanceWindow: &goldengate.DeploymentMaintenanceWindowArgs{
		Day:       pulumi.String("string"),
		StartHour: pulumi.Int(0),
	},
	NsgIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	OggData: &goldengate.DeploymentOggDataArgs{
		DeploymentName:  pulumi.String("string"),
		AdminPassword:   pulumi.String("string"),
		AdminUsername:   pulumi.String("string"),
		Certificate:     pulumi.String("string"),
		CredentialStore: pulumi.String("string"),
		GroupToRolesMapping: &goldengate.DeploymentOggDataGroupToRolesMappingArgs{
			SecurityGroupId:      pulumi.String("string"),
			AdministratorGroupId: pulumi.String("string"),
			OperatorGroupId:      pulumi.String("string"),
			UserGroupId:          pulumi.String("string"),
		},
		IdentityDomainId: pulumi.String("string"),
		Key:              pulumi.String("string"),
		OggVersion:       pulumi.String("string"),
		PasswordSecretId: pulumi.String("string"),
	},
	State: pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var exampledeploymentResourceResourceFromGoldenGatedeployment = new Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", DeploymentArgs.builder()
    .displayName("string")
    .compartmentId("string")
    .cpuCoreCount(0)
    .subnetId("string")
    .licenseModel("string")
    .deploymentType("string")
    .isAutoScalingEnabled(false)
    .freeformTags(Map.of("string", "string"))
    .deploymentBackupId("string")
    .fqdn("string")
    .backupSchedule(DeploymentBackupScheduleArgs.builder()
        .bucket("string")
        .compartmentId("string")
        .frequencyBackupScheduled("string")
        .isMetadataOnly(false)
        .namespace("string")
        .timeBackupScheduled("string")
        .build())
    .description("string")
    .isLockOverride(false)
    .isPublic(false)
    .environmentType("string")
    .loadBalancerSubnetId("string")
    .locks(DeploymentLockArgs.builder()
        .type("string")
        .message("string")
        .relatedResourceId("string")
        .timeCreated("string")
        .build())
    .maintenanceConfiguration(DeploymentMaintenanceConfigurationArgs.builder()
        .bundleReleaseUpgradePeriodInDays(0)
        .interimReleaseUpgradePeriodInDays(0)
        .isInterimReleaseAutoUpgradeEnabled(false)
        .majorReleaseUpgradePeriodInDays(0)
        .securityPatchUpgradePeriodInDays(0)
        .build())
    .maintenanceWindow(DeploymentMaintenanceWindowArgs.builder()
        .day("string")
        .startHour(0)
        .build())
    .nsgIds("string")
    .oggData(DeploymentOggDataArgs.builder()
        .deploymentName("string")
        .adminPassword("string")
        .adminUsername("string")
        .certificate("string")
        .credentialStore("string")
        .groupToRolesMapping(DeploymentOggDataGroupToRolesMappingArgs.builder()
            .securityGroupId("string")
            .administratorGroupId("string")
            .operatorGroupId("string")
            .userGroupId("string")
            .build())
        .identityDomainId("string")
        .key("string")
        .oggVersion("string")
        .passwordSecretId("string")
        .build())
    .state("string")
    .definedTags(Map.of("string", "string"))
    .build());
Copy
exampledeployment_resource_resource_from_golden_gatedeployment = oci.golden_gate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment",
    display_name="string",
    compartment_id="string",
    cpu_core_count=0,
    subnet_id="string",
    license_model="string",
    deployment_type="string",
    is_auto_scaling_enabled=False,
    freeform_tags={
        "string": "string",
    },
    deployment_backup_id="string",
    fqdn="string",
    backup_schedule={
        "bucket": "string",
        "compartment_id": "string",
        "frequency_backup_scheduled": "string",
        "is_metadata_only": False,
        "namespace": "string",
        "time_backup_scheduled": "string",
    },
    description="string",
    is_lock_override=False,
    is_public=False,
    environment_type="string",
    load_balancer_subnet_id="string",
    locks=[{
        "type": "string",
        "message": "string",
        "related_resource_id": "string",
        "time_created": "string",
    }],
    maintenance_configuration={
        "bundle_release_upgrade_period_in_days": 0,
        "interim_release_upgrade_period_in_days": 0,
        "is_interim_release_auto_upgrade_enabled": False,
        "major_release_upgrade_period_in_days": 0,
        "security_patch_upgrade_period_in_days": 0,
    },
    maintenance_window={
        "day": "string",
        "start_hour": 0,
    },
    nsg_ids=["string"],
    ogg_data={
        "deployment_name": "string",
        "admin_password": "string",
        "admin_username": "string",
        "certificate": "string",
        "credential_store": "string",
        "group_to_roles_mapping": {
            "security_group_id": "string",
            "administrator_group_id": "string",
            "operator_group_id": "string",
            "user_group_id": "string",
        },
        "identity_domain_id": "string",
        "key": "string",
        "ogg_version": "string",
        "password_secret_id": "string",
    },
    state="string",
    defined_tags={
        "string": "string",
    })
Copy
const exampledeploymentResourceResourceFromGoldenGatedeployment = new oci.goldengate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", {
    displayName: "string",
    compartmentId: "string",
    cpuCoreCount: 0,
    subnetId: "string",
    licenseModel: "string",
    deploymentType: "string",
    isAutoScalingEnabled: false,
    freeformTags: {
        string: "string",
    },
    deploymentBackupId: "string",
    fqdn: "string",
    backupSchedule: {
        bucket: "string",
        compartmentId: "string",
        frequencyBackupScheduled: "string",
        isMetadataOnly: false,
        namespace: "string",
        timeBackupScheduled: "string",
    },
    description: "string",
    isLockOverride: false,
    isPublic: false,
    environmentType: "string",
    loadBalancerSubnetId: "string",
    locks: [{
        type: "string",
        message: "string",
        relatedResourceId: "string",
        timeCreated: "string",
    }],
    maintenanceConfiguration: {
        bundleReleaseUpgradePeriodInDays: 0,
        interimReleaseUpgradePeriodInDays: 0,
        isInterimReleaseAutoUpgradeEnabled: false,
        majorReleaseUpgradePeriodInDays: 0,
        securityPatchUpgradePeriodInDays: 0,
    },
    maintenanceWindow: {
        day: "string",
        startHour: 0,
    },
    nsgIds: ["string"],
    oggData: {
        deploymentName: "string",
        adminPassword: "string",
        adminUsername: "string",
        certificate: "string",
        credentialStore: "string",
        groupToRolesMapping: {
            securityGroupId: "string",
            administratorGroupId: "string",
            operatorGroupId: "string",
            userGroupId: "string",
        },
        identityDomainId: "string",
        key: "string",
        oggVersion: "string",
        passwordSecretId: "string",
    },
    state: "string",
    definedTags: {
        string: "string",
    },
});
Copy
type: oci:GoldenGate:Deployment
properties:
    backupSchedule:
        bucket: string
        compartmentId: string
        frequencyBackupScheduled: string
        isMetadataOnly: false
        namespace: string
        timeBackupScheduled: string
    compartmentId: string
    cpuCoreCount: 0
    definedTags:
        string: string
    deploymentBackupId: string
    deploymentType: string
    description: string
    displayName: string
    environmentType: string
    fqdn: string
    freeformTags:
        string: string
    isAutoScalingEnabled: false
    isLockOverride: false
    isPublic: false
    licenseModel: string
    loadBalancerSubnetId: string
    locks:
        - message: string
          relatedResourceId: string
          timeCreated: string
          type: string
    maintenanceConfiguration:
        bundleReleaseUpgradePeriodInDays: 0
        interimReleaseUpgradePeriodInDays: 0
        isInterimReleaseAutoUpgradeEnabled: false
        majorReleaseUpgradePeriodInDays: 0
        securityPatchUpgradePeriodInDays: 0
    maintenanceWindow:
        day: string
        startHour: 0
    nsgIds:
        - string
    oggData:
        adminPassword: string
        adminUsername: string
        certificate: string
        credentialStore: string
        deploymentName: string
        groupToRolesMapping:
            administratorGroupId: string
            operatorGroupId: string
            securityGroupId: string
            userGroupId: string
        identityDomainId: string
        key: string
        oggVersion: string
        passwordSecretId: string
    state: string
    subnetId: string
Copy

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

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Deployment resource accepts the following input properties:

CompartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
CpuCoreCount This property is required. int
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DeploymentType
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
(Updatable) An object's Display Name.
IsAutoScalingEnabled This property is required. bool
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel This property is required. string
(Updatable) The Oracle license model that applies to a Deployment.
SubnetId This property is required. string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
BackupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
DefinedTags Dictionary<string, string>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
Description string
(Updatable) Metadata about this specific object.
EnvironmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags Dictionary<string, string>
(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"}
IsLockOverride bool
IsPublic bool
(Updatable) True if this object is publicly available.
LoadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
Locks Changes to this property will trigger replacement. List<DeploymentLock>
Locks associated with this resource.
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
CompartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
CpuCoreCount This property is required. int
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
DeploymentType
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
(Updatable) An object's Display Name.
IsAutoScalingEnabled This property is required. bool
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
LicenseModel This property is required. string
(Updatable) The Oracle license model that applies to a Deployment.
SubnetId This property is required. string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
BackupSchedule DeploymentBackupScheduleArgs
(Updatable) Defines the backup schedule details for create operation.
DefinedTags map[string]string
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
Description string
(Updatable) Metadata about this specific object.
EnvironmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[string]string
(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"}
IsLockOverride bool
IsPublic bool
(Updatable) True if this object is publicly available.
LoadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
Locks Changes to this property will trigger replacement. []DeploymentLockArgs
Locks associated with this resource.
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
compartmentId This property is required. String
(Updatable) The OCID of the compartment being referenced.
cpuCoreCount This property is required. Integer
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String
(Updatable) An object's Display Name.
isAutoScalingEnabled This property is required. Boolean
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel This property is required. String
(Updatable) The Oracle license model that applies to a Deployment.
subnetId This property is required. String
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
backupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
definedTags Map<String,String>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. String
The OCID of the backup being referenced.
description String
(Updatable) Metadata about this specific object.
environmentType String
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String,String>
(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"}
isLockOverride Boolean
isPublic Boolean
(Updatable) True if this object is publicly available.
loadBalancerSubnetId String
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. List<DeploymentLock>
Locks associated with this resource.
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
compartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
cpuCoreCount This property is required. number
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType
This property is required.
Changes to this property will trigger replacement.
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 This property is required. string
(Updatable) An object's Display Name.
isAutoScalingEnabled This property is required. boolean
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel This property is required. string
(Updatable) The Oracle license model that applies to a Deployment.
subnetId This property is required. string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
backupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
definedTags {[key: string]: string}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
description string
(Updatable) Metadata about this specific object.
environmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: string]: string}
(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"}
isLockOverride boolean
isPublic boolean
(Updatable) True if this object is publicly available.
loadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. DeploymentLock[]
Locks associated with this resource.
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
compartment_id This property is required. str
(Updatable) The OCID of the compartment being referenced.
cpu_core_count This property is required. int
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deployment_type
This property is required.
Changes to this property will trigger replacement.
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 This property is required. str
(Updatable) An object's Display Name.
is_auto_scaling_enabled This property is required. bool
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
license_model This property is required. str
(Updatable) The Oracle license model that applies to a Deployment.
subnet_id This property is required. str
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
backup_schedule goldengate.DeploymentBackupScheduleArgs
(Updatable) Defines the backup schedule details for create operation.
defined_tags Mapping[str, str]
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id Changes to this property will trigger replacement. str
The OCID of the backup being referenced.
description str
(Updatable) Metadata about this specific object.
environment_type str
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn str
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, str]
(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_lock_override bool
is_public bool
(Updatable) True if this object is publicly available.
load_balancer_subnet_id str
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. Sequence[goldengate.DeploymentLockArgs]
Locks associated with this resource.
maintenance_configuration goldengate.DeploymentMaintenanceConfigurationArgs
(Updatable) Defines the maintenance configuration for create operation.
maintenance_window goldengate.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 goldengate.DeploymentOggDataArgs
(Updatable) Deployment Data for creating an OggDeployment
state str
compartmentId This property is required. String
(Updatable) The OCID of the compartment being referenced.
cpuCoreCount This property is required. Number
(Updatable) The Minimum number of OCPUs to be made available for this Deployment.
deploymentType
This property is required.
Changes to this property will trigger replacement.
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 This property is required. String
(Updatable) An object's Display Name.
isAutoScalingEnabled This property is required. Boolean
(Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
licenseModel This property is required. String
(Updatable) The Oracle license model that applies to a Deployment.
subnetId This property is required. String
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
backupSchedule Property Map
(Updatable) Defines the backup schedule details for create operation.
definedTags Map<String>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. String
The OCID of the backup being referenced.
description String
(Updatable) Metadata about this specific object.
environmentType String
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String>
(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"}
isLockOverride Boolean
isPublic Boolean
(Updatable) True if this object is publicly available.
loadBalancerSubnetId String
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
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

Outputs

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

Category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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.
IngressIps List<DeploymentIngressIp>
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.
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
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.
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.
LoadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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, 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. 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.
TimeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
Category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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.
IngressIps []DeploymentIngressIp
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.
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
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.
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.
LoadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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]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. 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.
TimeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
category String
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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.
ingressIps List<DeploymentIngressIp>
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.
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
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.
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.
loadBalancerId String
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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,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. 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.
timeLastBackupScheduled String
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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.
ingressIps DeploymentIngressIp[]
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.
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
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.
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.
loadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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]: 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. 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.
timeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
category str
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
deployment_diagnostic_datas Sequence[goldengate.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.
ingress_ips Sequence[goldengate.DeploymentIngressIp]
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.
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
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.
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.
load_balancer_id str
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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, str]
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_last_backup_scheduled str
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
time_next_backup_scheduled str
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
category String
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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.
ingressIps List<Property Map>
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.
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
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.
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.
loadBalancerId String
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
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>
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.
timeLastBackupScheduled String
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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,
        backup_schedule: Optional[_goldengate.DeploymentBackupScheduleArgs] = None,
        category: Optional[str] = None,
        compartment_id: Optional[str] = None,
        cpu_core_count: Optional[int] = None,
        defined_tags: Optional[Mapping[str, str]] = 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,
        environment_type: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        ingress_ips: Optional[Sequence[_goldengate.DeploymentIngressIpArgs]] = None,
        is_auto_scaling_enabled: Optional[bool] = None,
        is_healthy: Optional[bool] = None,
        is_latest_version: Optional[bool] = None,
        is_lock_override: 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,
        load_balancer_id: Optional[str] = None,
        load_balancer_subnet_id: Optional[str] = None,
        locks: Optional[Sequence[_goldengate.DeploymentLockArgs]] = 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, str]] = None,
        time_created: Optional[str] = None,
        time_last_backup_scheduled: Optional[str] = None,
        time_next_backup_scheduled: 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)
resources:  _:    type: oci:GoldenGate:Deployment    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
BackupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
Category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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, string>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
DeploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>
Information regarding the deployment diagnostic collection
DeploymentType Changes to this property will trigger replacement. 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.
EnvironmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags Dictionary<string, string>
(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"}
IngressIps List<DeploymentIngressIp>
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.
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.
IsLockOverride bool
IsPublic bool
(Updatable) True if this object is publicly available.
IsStorageUtilizationLimitExceeded bool
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.
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.
LoadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
Locks Changes to this property will trigger replacement. List<DeploymentLock>
Locks associated with this resource.
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
StorageUtilizationInBytes string
The amount of storage being utilized (in bytes)
SubnetId string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
SystemTags Dictionary<string, 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. 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.
TimeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
BackupSchedule DeploymentBackupScheduleArgs
(Updatable) Defines the backup schedule details for create operation.
Category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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]string
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DeploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
DeploymentDiagnosticDatas []DeploymentDeploymentDiagnosticDataArgs
Information regarding the deployment diagnostic collection
DeploymentType Changes to this property will trigger replacement. 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.
EnvironmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
FreeformTags map[string]string
(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"}
IngressIps []DeploymentIngressIpArgs
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.
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.
IsLockOverride bool
IsPublic bool
(Updatable) True if this object is publicly available.
IsStorageUtilizationLimitExceeded bool
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.
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.
LoadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
LoadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
Locks Changes to this property will trigger replacement. []DeploymentLockArgs
Locks associated with this resource.
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
StorageUtilizationInBytes string
The amount of storage being utilized (in bytes)
SubnetId string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
SystemTags map[string]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. 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.
TimeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
TimeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
backupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
category String
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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,String>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. String
The OCID of the backup being referenced.
deploymentDiagnosticDatas List<DeploymentDeploymentDiagnosticData>
Information regarding the deployment diagnostic collection
deploymentType Changes to this property will trigger replacement. 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.
environmentType String
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String,String>
(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"}
ingressIps List<DeploymentIngressIp>
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.
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.
isLockOverride Boolean
isPublic Boolean
(Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded 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.
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.
loadBalancerId String
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId String
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. List<DeploymentLock>
Locks associated with this resource.
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
storageUtilizationInBytes String
The amount of storage being utilized (in bytes)
subnetId String
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
systemTags Map<String,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. 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.
timeLastBackupScheduled String
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
backupSchedule DeploymentBackupSchedule
(Updatable) Defines the backup schedule details for create operation.
category string
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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]: string}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. string
The OCID of the backup being referenced.
deploymentDiagnosticDatas DeploymentDeploymentDiagnosticData[]
Information regarding the deployment diagnostic collection
deploymentType Changes to this property will trigger replacement. 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.
environmentType string
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags {[key: string]: string}
(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"}
ingressIps DeploymentIngressIp[]
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.
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.
isLockOverride boolean
isPublic boolean
(Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded 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.
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.
loadBalancerId string
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId string
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. DeploymentLock[]
Locks associated with this resource.
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
storageUtilizationInBytes string
The amount of storage being utilized (in bytes)
subnetId string
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
systemTags {[key: string]: 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. 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.
timeLastBackupScheduled string
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled string
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
backup_schedule goldengate.DeploymentBackupScheduleArgs
(Updatable) Defines the backup schedule details for create operation.
category str
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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, str]
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deployment_backup_id Changes to this property will trigger replacement. str
The OCID of the backup being referenced.
deployment_diagnostic_datas Sequence[goldengate.DeploymentDeploymentDiagnosticDataArgs]
Information regarding the deployment diagnostic collection
deployment_type Changes to this property will trigger replacement. 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.
environment_type str
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn str
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeform_tags Mapping[str, str]
(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"}
ingress_ips Sequence[goldengate.DeploymentIngressIpArgs]
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.
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_lock_override bool
is_public bool
(Updatable) True if this object is publicly available.
is_storage_utilization_limit_exceeded bool
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.
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.
load_balancer_id str
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
load_balancer_subnet_id str
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. Sequence[goldengate.DeploymentLockArgs]
Locks associated with this resource.
maintenance_configuration goldengate.DeploymentMaintenanceConfigurationArgs
(Updatable) Defines the maintenance configuration for create operation.
maintenance_window goldengate.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 goldengate.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
storage_utilization_in_bytes str
The amount of storage being utilized (in bytes)
subnet_id str
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
system_tags Mapping[str, str]
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_last_backup_scheduled str
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
time_next_backup_scheduled str
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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.
backupSchedule Property Map
(Updatable) Defines the backup schedule details for create operation.
category String
The deployment category defines the broad separation of the deployment type into three categories. Currently the separation is 'DATA_REPLICATION', 'STREAM_ANALYTICS' and 'DATA_TRANSFORMS'.
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<String>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
deploymentBackupId Changes to this property will trigger replacement. String
The OCID of the backup being referenced.
deploymentDiagnosticDatas List<Property Map>
Information regarding the deployment diagnostic collection
deploymentType Changes to this property will trigger replacement. 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.
environmentType String
(Updatable) Specifies whether the deployment is used in a production or development/testing environment.
fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
freeformTags Map<String>
(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"}
ingressIps List<Property Map>
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.
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.
isLockOverride Boolean
isPublic Boolean
(Updatable) True if this object is publicly available.
isStorageUtilizationLimitExceeded 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.
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.
loadBalancerId String
The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
loadBalancerSubnetId String
(Updatable) The OCID of a public subnet in the customer tenancy. Can be provided only for public deployments. If provided, the loadbalancer will be created in this subnet instead of the service tenancy. For backward compatibility, this is an optional property. It will become mandatory for public deployments after October 1, 2024.
locks Changes to this property will trigger replacement. List<Property Map>
Locks associated with this resource.
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
storageUtilizationInBytes String
The amount of storage being utilized (in bytes)
subnetId String
(Updatable) The OCID of the subnet of the deployment's private endpoint. The subnet must be a private subnet. For backward compatibility, public subnets are allowed until May 31 2025, after which the private subnet will be enforced.
systemTags Map<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. 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.
timeLastBackupScheduled String
The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
timeNextBackupScheduled String
The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19: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

DeploymentBackupSchedule
, DeploymentBackupScheduleArgs

Bucket This property is required. string
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
CompartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
FrequencyBackupScheduled This property is required. string
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
IsMetadataOnly This property is required. bool
(Updatable) Parameter to allow users to create backup without trails
Namespace This property is required. string
(Updatable) Name of namespace that serves as a container for all of your buckets
TimeBackupScheduled This property is required. string
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
Bucket This property is required. string
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
CompartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
FrequencyBackupScheduled This property is required. string
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
IsMetadataOnly This property is required. bool
(Updatable) Parameter to allow users to create backup without trails
Namespace This property is required. string
(Updatable) Name of namespace that serves as a container for all of your buckets
TimeBackupScheduled This property is required. string
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
bucket This property is required. String
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. String
(Updatable) The OCID of the compartment being referenced.
frequencyBackupScheduled This property is required. String
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly This property is required. Boolean
(Updatable) Parameter to allow users to create backup without trails
namespace This property is required. String
(Updatable) Name of namespace that serves as a container for all of your buckets
timeBackupScheduled This property is required. String
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
bucket This property is required. string
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. string
(Updatable) The OCID of the compartment being referenced.
frequencyBackupScheduled This property is required. string
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly This property is required. boolean
(Updatable) Parameter to allow users to create backup without trails
namespace This property is required. string
(Updatable) Name of namespace that serves as a container for all of your buckets
timeBackupScheduled This property is required. string
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
bucket This property is required. str
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
compartment_id This property is required. str
(Updatable) The OCID of the compartment being referenced.
frequency_backup_scheduled This property is required. str
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
is_metadata_only This property is required. bool
(Updatable) Parameter to allow users to create backup without trails
namespace This property is required. str
(Updatable) Name of namespace that serves as a container for all of your buckets
time_backup_scheduled This property is required. str
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
bucket This property is required. String
(Updatable) Name of the bucket where the object is to be uploaded in the object storage
compartmentId This property is required. String
(Updatable) The OCID of the compartment being referenced.
frequencyBackupScheduled This property is required. String
(Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
isMetadataOnly This property is required. Boolean
(Updatable) Parameter to allow users to create backup without trails
namespace This property is required. String
(Updatable) Name of namespace that serves as a container for all of your buckets
timeBackupScheduled This property is required. String
(Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.

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.

DeploymentIngressIp
, DeploymentIngressIpArgs

IngressIp string
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
IngressIp string
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
ingressIp String
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
ingressIp string
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
ingress_ip str
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.
ingressIp String
A Private Endpoint IPv4 or IPv6 Address created in the customer's subnet.

DeploymentLock
, DeploymentLockArgs

Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
Type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
Message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type
This property is required.
Changes to this property will trigger replacement.
string
Type of the lock.
message Changes to this property will trigger replacement. string
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type
This property is required.
Changes to this property will trigger replacement.
str
Type of the lock.
message Changes to this property will trigger replacement. str
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str
The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
type
This property is required.
Changes to this property will trigger replacement.
String
Type of the lock.
message Changes to this property will trigger replacement. String
A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String
The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String
The time the resource was created. 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 This property is required. string
(Updatable) Days of the week.
StartHour This property is required. int
(Updatable) Start hour for maintenance period. Hour is in UTC.
Day This property is required. string
(Updatable) Days of the week.
StartHour This property is required. int
(Updatable) Start hour for maintenance period. Hour is in UTC.
day This property is required. String
(Updatable) Days of the week.
startHour This property is required. Integer
(Updatable) Start hour for maintenance period. Hour is in UTC.
day This property is required. string
(Updatable) Days of the week.
startHour This property is required. number
(Updatable) Start hour for maintenance period. Hour is in UTC.
day This property is required. str
(Updatable) Days of the week.
start_hour This property is required. int
(Updatable) Start hour for maintenance period. Hour is in UTC.
day This property is required. String
(Updatable) Days of the week.
startHour This property is required. Number
(Updatable) Start hour for maintenance period. Hour is in UTC.

DeploymentOggData
, DeploymentOggDataArgs

DeploymentName
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
CredentialStore string
(Updatable) The type of credential store for OGG.
GroupToRolesMapping DeploymentOggDataGroupToRolesMapping
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
IdentityDomainId string
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
Key string
(Updatable) The base64 encoded content of the PEM file containing the private key.
OggVersion string
Version of OGG
PasswordSecretId string
(Updatable) The OCID of the Secret where the deployment password is stored.
DeploymentName
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
CredentialStore string
(Updatable) The type of credential store for OGG.
GroupToRolesMapping DeploymentOggDataGroupToRolesMapping
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
IdentityDomainId string
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
Key string
(Updatable) The base64 encoded content of the PEM file containing the private key.
OggVersion string
Version of OGG
PasswordSecretId string
(Updatable) The OCID of the Secret where the deployment password is stored.
deploymentName
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore String
(Updatable) The type of credential store for OGG.
groupToRolesMapping DeploymentOggDataGroupToRolesMapping
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId String
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
key String
(Updatable) The base64 encoded content of the PEM file containing the private key.
oggVersion String
Version of OGG
passwordSecretId String
(Updatable) The OCID of the Secret where the deployment password is stored.
deploymentName
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore string
(Updatable) The type of credential store for OGG.
groupToRolesMapping DeploymentOggDataGroupToRolesMapping
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId string
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
key string
(Updatable) The base64 encoded content of the PEM file containing the private key.
oggVersion string
Version of OGG
passwordSecretId string
(Updatable) The OCID of the Secret where the deployment password is stored.
deployment_name
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
credential_store str
(Updatable) The type of credential store for OGG.
group_to_roles_mapping goldengate.DeploymentOggDataGroupToRolesMapping
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identity_domain_id str
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
key str
(Updatable) The base64 encoded content of the PEM file containing the private key.
ogg_version str
Version of OGG
password_secret_id str
(Updatable) The OCID of the Secret where the deployment password is stored.
deploymentName
This property is required.
Changes to this property will trigger replacement.
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) The base64 encoded content of the PEM file containing the SSL certificate.
credentialStore String
(Updatable) The type of credential store for OGG.
groupToRolesMapping Property Map
(Updatable) Defines the IDP Groups to GoldenGate roles mapping. This field is used only for IAM deployment and does not have any impact on non-IAM deployments. For IAM deployment, when user does not specify this mapping, then it has null value and default mapping is used. User belonging to each group can only perform the actions according to the role the respective group is mapped to.
identityDomainId String
(Updatable) The OCID of the Identity Domain when IAM credential store is used.
key String
(Updatable) The base64 encoded content of the PEM file containing the private key.
oggVersion String
Version of OGG
passwordSecretId String
(Updatable) The OCID of the Secret where the deployment password is stored.

DeploymentOggDataGroupToRolesMapping
, DeploymentOggDataGroupToRolesMappingArgs

SecurityGroupId This property is required. string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
AdministratorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
OperatorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
UserGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information
SecurityGroupId This property is required. string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
AdministratorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
OperatorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
UserGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information
securityGroupId This property is required. String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
administratorGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
userGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information
securityGroupId This property is required. string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
administratorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
userGroupId string
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information
security_group_id This property is required. str
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
administrator_group_id str
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operator_group_id str
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
user_group_id str
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information
securityGroupId This property is required. String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role securityGroup. It grants administration of security related objects and invoke security related service requests. This role has full privileges.
administratorGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role administratorGroup. It grants full access to the user, including the ability to alter general, non-security related operational parameters and profiles of the server.
operatorGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role operatorGroup. It allows users to perform only operational actions, like starting and stopping resources. Operators cannot alter the operational parameters or profiles of the MA server.
userGroupId String
(Updatable) The OCID of the IDP group which will be mapped to goldengate role userGroup. It allows information-only service requests, which do not alter or affect the operation of either the MA. Examples of query and read-only information include performance metric information and resource status and monitoring information

Import

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

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

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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