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,
               subnet_id: Optional[str] = None,
               compartment_id: Optional[str] = None,
               freeform_tags: Optional[Mapping[str, str]] = None,
               is_lock_override: Optional[bool] = None,
               deployment_backup_id: Optional[str] = None,
               deployment_type: Optional[str] = None,
               description: Optional[str] = None,
               cpu_core_count: Optional[int] = None,
               environment_type: Optional[str] = None,
               fault_domain: Optional[str] = None,
               fqdn: Optional[str] = None,
               availability_domain: Optional[str] = None,
               is_auto_scaling_enabled: Optional[bool] = None,
               defined_tags: Optional[Mapping[str, str]] = None,
               is_public: Optional[bool] = None,
               license_model: Optional[str] = None,
               load_balancer_subnet_id: Optional[str] = None,
               locks: Optional[Sequence[DeploymentLockArgs]] = None,
               maintenance_configuration: Optional[DeploymentMaintenanceConfigurationArgs] = None,
               maintenance_window: Optional[DeploymentMaintenanceWindowArgs] = None,
               nsg_ids: Optional[Sequence[str]] = None,
               ogg_data: Optional[DeploymentOggDataArgs] = None,
               placements: Optional[Sequence[DeploymentPlacementArgs]] = None,
               source_deployment_id: Optional[str] = None,
               state: Optional[str] = None,
               backup_schedule: Optional[DeploymentBackupScheduleArgs] = 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 string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeploymentArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var exampledeploymentResourceResourceFromGoldenGatedeployment = new Oci.GoldenGate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", new()
{
    DisplayName = "string",
    SubnetId = "string",
    CompartmentId = "string",
    FreeformTags = 
    {
        { "string", "string" },
    },
    IsLockOverride = false,
    DeploymentBackupId = "string",
    DeploymentType = "string",
    Description = "string",
    CpuCoreCount = 0,
    EnvironmentType = "string",
    FaultDomain = "string",
    Fqdn = "string",
    AvailabilityDomain = "string",
    IsAutoScalingEnabled = false,
    DefinedTags = 
    {
        { "string", "string" },
    },
    IsPublic = false,
    LicenseModel = "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",
    },
    Placements = new[]
    {
        new Oci.GoldenGate.Inputs.DeploymentPlacementArgs
        {
            AvailabilityDomain = "string",
            FaultDomain = "string",
        },
    },
    SourceDeploymentId = "string",
    State = "string",
    BackupSchedule = new Oci.GoldenGate.Inputs.DeploymentBackupScheduleArgs
    {
        Bucket = "string",
        CompartmentId = "string",
        FrequencyBackupScheduled = "string",
        IsMetadataOnly = false,
        Namespace = "string",
        TimeBackupScheduled = "string",
    },
});
example, err := goldengate.NewDeployment(ctx, "exampledeploymentResourceResourceFromGoldenGatedeployment", &goldengate.DeploymentArgs{
	DisplayName:   pulumi.String("string"),
	SubnetId:      pulumi.String("string"),
	CompartmentId: pulumi.String("string"),
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsLockOverride:       pulumi.Bool(false),
	DeploymentBackupId:   pulumi.String("string"),
	DeploymentType:       pulumi.String("string"),
	Description:          pulumi.String("string"),
	CpuCoreCount:         pulumi.Int(0),
	EnvironmentType:      pulumi.String("string"),
	FaultDomain:          pulumi.String("string"),
	Fqdn:                 pulumi.String("string"),
	AvailabilityDomain:   pulumi.String("string"),
	IsAutoScalingEnabled: pulumi.Bool(false),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	IsPublic:             pulumi.Bool(false),
	LicenseModel:         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"),
	},
	Placements: goldengate.DeploymentPlacementArray{
		&goldengate.DeploymentPlacementArgs{
			AvailabilityDomain: pulumi.String("string"),
			FaultDomain:        pulumi.String("string"),
		},
	},
	SourceDeploymentId: pulumi.String("string"),
	State:              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"),
	},
})
var exampledeploymentResourceResourceFromGoldenGatedeployment = new com.pulumi.oci.GoldenGate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", com.pulumi.oci.GoldenGate.DeploymentArgs.builder()
    .displayName("string")
    .subnetId("string")
    .compartmentId("string")
    .freeformTags(Map.of("string", "string"))
    .isLockOverride(false)
    .deploymentBackupId("string")
    .deploymentType("string")
    .description("string")
    .cpuCoreCount(0)
    .environmentType("string")
    .faultDomain("string")
    .fqdn("string")
    .availabilityDomain("string")
    .isAutoScalingEnabled(false)
    .definedTags(Map.of("string", "string"))
    .isPublic(false)
    .licenseModel("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())
    .placements(DeploymentPlacementArgs.builder()
        .availabilityDomain("string")
        .faultDomain("string")
        .build())
    .sourceDeploymentId("string")
    .state("string")
    .backupSchedule(DeploymentBackupScheduleArgs.builder()
        .bucket("string")
        .compartmentId("string")
        .frequencyBackupScheduled("string")
        .isMetadataOnly(false)
        .namespace("string")
        .timeBackupScheduled("string")
        .build())
    .build());
exampledeployment_resource_resource_from_golden_gatedeployment = oci.golden_gate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment",
    display_name="string",
    subnet_id="string",
    compartment_id="string",
    freeform_tags={
        "string": "string",
    },
    is_lock_override=False,
    deployment_backup_id="string",
    deployment_type="string",
    description="string",
    cpu_core_count=0,
    environment_type="string",
    fault_domain="string",
    fqdn="string",
    availability_domain="string",
    is_auto_scaling_enabled=False,
    defined_tags={
        "string": "string",
    },
    is_public=False,
    license_model="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",
    },
    placements=[{
        "availability_domain": "string",
        "fault_domain": "string",
    }],
    source_deployment_id="string",
    state="string",
    backup_schedule={
        "bucket": "string",
        "compartment_id": "string",
        "frequency_backup_scheduled": "string",
        "is_metadata_only": False,
        "namespace": "string",
        "time_backup_scheduled": "string",
    })
const exampledeploymentResourceResourceFromGoldenGatedeployment = new oci.goldengate.Deployment("exampledeploymentResourceResourceFromGoldenGatedeployment", {
    displayName: "string",
    subnetId: "string",
    compartmentId: "string",
    freeformTags: {
        string: "string",
    },
    isLockOverride: false,
    deploymentBackupId: "string",
    deploymentType: "string",
    description: "string",
    cpuCoreCount: 0,
    environmentType: "string",
    faultDomain: "string",
    fqdn: "string",
    availabilityDomain: "string",
    isAutoScalingEnabled: false,
    definedTags: {
        string: "string",
    },
    isPublic: false,
    licenseModel: "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",
    },
    placements: [{
        availabilityDomain: "string",
        faultDomain: "string",
    }],
    sourceDeploymentId: "string",
    state: "string",
    backupSchedule: {
        bucket: "string",
        compartmentId: "string",
        frequencyBackupScheduled: "string",
        isMetadataOnly: false,
        namespace: "string",
        timeBackupScheduled: "string",
    },
});
type: oci:GoldenGate:Deployment
properties:
    availabilityDomain: string
    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
    faultDomain: 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
    placements:
        - availabilityDomain: string
          faultDomain: string
    sourceDeploymentId: string
    state: string
    subnetId: string
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 string
- (Updatable) The OCID of the compartment being referenced.
- DisplayName string
- (Updatable) An object's Display Name.
- 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.
- AvailabilityDomain string
- The availability domain of a placement.
- BackupSchedule DeploymentBackup Schedule 
- (Updatable) Defines the backup schedule details for create operation.
- CpuCore intCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeploymentBackup stringId 
- The OCID of the backup being referenced.
- DeploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- Description string
- (Updatable) Metadata about this specific object.
- EnvironmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- FaultDomain string
- The fault domain of a placement.
- Fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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"}
- IsAuto boolScaling Enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- IsLock boolOverride 
- IsPublic bool
- (Updatable) True if this object is publicly available.
- LicenseModel string
- (Updatable) The Oracle license model that applies to a Deployment.
- LoadBalancer stringSubnet Id 
- (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
List<DeploymentLock> 
- Locks associated with this resource.
- MaintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- MaintenanceWindow DeploymentMaintenance Window 
- (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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- Placements
List<DeploymentPlacement> 
- (Updatable) An array of local peers of deployment
- SourceDeployment stringId 
- The OCID of the deployment being referenced.
- State string
- CompartmentId string
- (Updatable) The OCID of the compartment being referenced.
- DisplayName string
- (Updatable) An object's Display Name.
- 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.
- AvailabilityDomain string
- The availability domain of a placement.
- BackupSchedule DeploymentBackup Schedule Args 
- (Updatable) Defines the backup schedule details for create operation.
- CpuCore intCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeploymentBackup stringId 
- The OCID of the backup being referenced.
- DeploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- Description string
- (Updatable) Metadata about this specific object.
- EnvironmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- FaultDomain string
- The fault domain of a placement.
- Fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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"}
- IsAuto boolScaling Enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- IsLock boolOverride 
- IsPublic bool
- (Updatable) True if this object is publicly available.
- LicenseModel string
- (Updatable) The Oracle license model that applies to a Deployment.
- LoadBalancer stringSubnet Id 
- (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
[]DeploymentLock Args 
- Locks associated with this resource.
- MaintenanceConfiguration DeploymentMaintenance Configuration Args 
- (Updatable) Defines the maintenance configuration for create operation.
- MaintenanceWindow DeploymentMaintenance Window Args 
- (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 DeploymentOgg Data Args 
- (Updatable) Deployment Data for creating an OggDeployment
- Placements
[]DeploymentPlacement Args 
- (Updatable) An array of local peers of deployment
- SourceDeployment stringId 
- The OCID of the deployment being referenced.
- State string
- compartmentId String
- (Updatable) The OCID of the compartment being referenced.
- displayName String
- (Updatable) An object's Display Name.
- 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.
- availabilityDomain String
- The availability domain of a placement.
- backupSchedule DeploymentBackup Schedule 
- (Updatable) Defines the backup schedule details for create operation.
- cpuCore IntegerCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup StringId 
- The OCID of the backup being referenced.
- deploymentType String
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- description String
- (Updatable) Metadata about this specific object.
- environmentType String
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain String
- The fault domain of a placement.
- fqdn String
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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"}
- isAuto BooleanScaling Enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- isLock BooleanOverride 
- isPublic Boolean
- (Updatable) True if this object is publicly available.
- licenseModel String
- (Updatable) The Oracle license model that applies to a Deployment.
- loadBalancer StringSubnet Id 
- (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
List<DeploymentLock> 
- Locks associated with this resource.
- maintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenanceWindow DeploymentMaintenance Window 
- (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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
List<DeploymentPlacement> 
- (Updatable) An array of local peers of deployment
- sourceDeployment StringId 
- The OCID of the deployment being referenced.
- state String
- compartmentId string
- (Updatable) The OCID of the compartment being referenced.
- displayName string
- (Updatable) An object's Display Name.
- 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.
- availabilityDomain string
- The availability domain of a placement.
- backupSchedule DeploymentBackup Schedule 
- (Updatable) Defines the backup schedule details for create operation.
- cpuCore numberCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup stringId 
- The OCID of the backup being referenced.
- deploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- description string
- (Updatable) Metadata about this specific object.
- environmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain string
- The fault domain of a placement.
- fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- {[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"}
- isAuto booleanScaling Enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- isLock booleanOverride 
- isPublic boolean
- (Updatable) True if this object is publicly available.
- licenseModel string
- (Updatable) The Oracle license model that applies to a Deployment.
- loadBalancer stringSubnet Id 
- (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
DeploymentLock[] 
- Locks associated with this resource.
- maintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenanceWindow DeploymentMaintenance Window 
- (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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
DeploymentPlacement[] 
- (Updatable) An array of local peers of deployment
- sourceDeployment stringId 
- The OCID of the deployment being referenced.
- state string
- compartment_id str
- (Updatable) The OCID of the compartment being referenced.
- display_name str
- (Updatable) An object's Display Name.
- 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.
- availability_domain str
- The availability domain of a placement.
- backup_schedule DeploymentBackup Schedule Args 
- (Updatable) Defines the backup schedule details for create operation.
- cpu_core_ intcount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- 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_ strid 
- The OCID of the backup being referenced.
- deployment_type str
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- 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.
- fault_domain str
- The fault domain of a placement.
- fqdn str
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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_auto_ boolscaling_ enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- is_lock_ booloverride 
- is_public bool
- (Updatable) True if this object is publicly available.
- license_model str
- (Updatable) The Oracle license model that applies to a Deployment.
- load_balancer_ strsubnet_ id 
- (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
Sequence[DeploymentLock Args] 
- Locks associated with this resource.
- maintenance_configuration DeploymentMaintenance Configuration Args 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenance_window DeploymentMaintenance Window Args 
- (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 DeploymentOgg Data Args 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
Sequence[DeploymentPlacement Args] 
- (Updatable) An array of local peers of deployment
- source_deployment_ strid 
- The OCID of the deployment being referenced.
- state str
- compartmentId String
- (Updatable) The OCID of the compartment being referenced.
- displayName String
- (Updatable) An object's Display Name.
- 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.
- availabilityDomain String
- The availability domain of a placement.
- backupSchedule Property Map
- (Updatable) Defines the backup schedule details for create operation.
- cpuCore NumberCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup StringId 
- The OCID of the backup being referenced.
- deploymentType String
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- description String
- (Updatable) Metadata about this specific object.
- environmentType String
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain String
- The fault domain of a placement.
- fqdn String
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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"}
- isAuto BooleanScaling Enabled 
- (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- isLock BooleanOverride 
- isPublic Boolean
- (Updatable) True if this object is publicly available.
- licenseModel String
- (Updatable) The Oracle license model that applies to a Deployment.
- loadBalancer StringSubnet Id 
- (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 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
- placements List<Property Map>
- (Updatable) An array of local peers of deployment
- sourceDeployment StringId 
- The OCID of the deployment being referenced.
- 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'.
- DeploymentDiagnostic List<DeploymentDatas Deployment Diagnostic Data> 
- Information regarding the deployment diagnostic collection
- DeploymentRole string
- The type of the deployment role.
- DeploymentUrl string
- The URL of a resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- IngressIps List<DeploymentIngress Ip> 
- 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.
- IsLatest boolVersion 
- Indicates if the resource is the the latest available version.
- IsStorage boolUtilization Limit Exceeded 
- 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.
- LifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- LoadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- NextMaintenance stringAction Type 
- Type of the next maintenance.
- NextMaintenance stringDescription 
- Description of the next maintenance.
- PrivateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- PublicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- StorageUtilization stringIn Bytes 
- The amount of storage being utilized (in bytes)
- 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.
- TimeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- TimeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- TimeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- TimeOgg stringVersion Supported Until 
- 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.
- TimeRole stringChanged 
- The time of the last role change. 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.
- TimeUpgrade stringRequired 
- 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'.
- DeploymentDiagnostic []DeploymentDatas Deployment Diagnostic Data 
- Information regarding the deployment diagnostic collection
- DeploymentRole string
- The type of the deployment role.
- DeploymentUrl string
- The URL of a resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- IngressIps []DeploymentIngress Ip 
- 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.
- IsLatest boolVersion 
- Indicates if the resource is the the latest available version.
- IsStorage boolUtilization Limit Exceeded 
- 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.
- LifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- LoadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- NextMaintenance stringAction Type 
- Type of the next maintenance.
- NextMaintenance stringDescription 
- Description of the next maintenance.
- PrivateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- PublicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- StorageUtilization stringIn Bytes 
- The amount of storage being utilized (in bytes)
- 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.
- TimeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- TimeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- TimeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- TimeOgg stringVersion Supported Until 
- 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.
- TimeRole stringChanged 
- The time of the last role change. 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.
- TimeUpgrade stringRequired 
- 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'.
- deploymentDiagnostic List<DeploymentDatas Deployment Diagnostic Data> 
- Information regarding the deployment diagnostic collection
- deploymentRole String
- The type of the deployment role.
- deploymentUrl String
- The URL of a resource.
- id String
- The provider-assigned unique ID for this managed resource.
- ingressIps List<DeploymentIngress Ip> 
- 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.
- isLatest BooleanVersion 
- Indicates if the resource is the the latest available version.
- isStorage BooleanUtilization Limit Exceeded 
- 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.
- lifecycleSub StringState 
- Possible GGS lifecycle sub-states.
- loadBalancer StringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- nextMaintenance StringAction Type 
- Type of the next maintenance.
- nextMaintenance StringDescription 
- Description of the next maintenance.
- privateIp StringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp StringAddress 
- The public IP address representing the access point for the Deployment.
- storageUtilization StringIn Bytes 
- The amount of storage being utilized (in bytes)
- 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.
- timeLast StringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext StringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf StringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg StringVersion Supported Until 
- 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.
- timeRole StringChanged 
- The time of the last role change. 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.
- timeUpgrade StringRequired 
- 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'.
- deploymentDiagnostic DeploymentDatas Deployment Diagnostic Data[] 
- Information regarding the deployment diagnostic collection
- deploymentRole string
- The type of the deployment role.
- deploymentUrl string
- The URL of a resource.
- id string
- The provider-assigned unique ID for this managed resource.
- ingressIps DeploymentIngress Ip[] 
- 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.
- isLatest booleanVersion 
- Indicates if the resource is the the latest available version.
- isStorage booleanUtilization Limit Exceeded 
- 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.
- lifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- loadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- nextMaintenance stringAction Type 
- Type of the next maintenance.
- nextMaintenance stringDescription 
- Description of the next maintenance.
- privateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- storageUtilization stringIn Bytes 
- The amount of storage being utilized (in bytes)
- {[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.
- timeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg stringVersion Supported Until 
- 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.
- timeRole stringChanged 
- The time of the last role change. 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.
- timeUpgrade stringRequired 
- 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_ Sequence[Deploymentdatas Deployment Diagnostic Data] 
- Information regarding the deployment diagnostic collection
- deployment_role str
- The type of the deployment role.
- deployment_url str
- The URL of a resource.
- id str
- The provider-assigned unique ID for this managed resource.
- ingress_ips Sequence[DeploymentIngress Ip] 
- 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_ boolversion 
- Indicates if the resource is the the latest available version.
- is_storage_ boolutilization_ limit_ exceeded 
- 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_ strstate 
- Possible GGS lifecycle sub-states.
- load_balancer_ strid 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- next_maintenance_ straction_ type 
- Type of the next maintenance.
- next_maintenance_ strdescription 
- Description of the next maintenance.
- private_ip_ straddress 
- 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_ straddress 
- The public IP address representing the access point for the Deployment.
- storage_utilization_ strin_ bytes 
- The amount of storage being utilized (in bytes)
- 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_ strbackup_ scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- time_next_ strbackup_ scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- time_of_ strnext_ maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- time_ogg_ strversion_ supported_ until 
- 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_role_ strchanged 
- The time of the last role change. 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_ strrequired 
- 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'.
- deploymentDiagnostic List<Property Map>Datas 
- Information regarding the deployment diagnostic collection
- deploymentRole String
- The type of the deployment role.
- 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.
- isLatest BooleanVersion 
- Indicates if the resource is the the latest available version.
- isStorage BooleanUtilization Limit Exceeded 
- 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.
- lifecycleSub StringState 
- Possible GGS lifecycle sub-states.
- loadBalancer StringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- nextMaintenance StringAction Type 
- Type of the next maintenance.
- nextMaintenance StringDescription 
- Description of the next maintenance.
- privateIp StringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp StringAddress 
- The public IP address representing the access point for the Deployment.
- storageUtilization StringIn Bytes 
- The amount of storage being utilized (in bytes)
- 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.
- timeLast StringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext StringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf StringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg StringVersion Supported Until 
- 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.
- timeRole StringChanged 
- The time of the last role change. 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.
- timeUpgrade StringRequired 
- 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,
        availability_domain: Optional[str] = None,
        backup_schedule: Optional[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[DeploymentDeploymentDiagnosticDataArgs]] = None,
        deployment_role: Optional[str] = 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,
        fault_domain: Optional[str] = None,
        fqdn: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        ingress_ips: Optional[Sequence[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[DeploymentLockArgs]] = None,
        maintenance_configuration: Optional[DeploymentMaintenanceConfigurationArgs] = None,
        maintenance_window: Optional[DeploymentMaintenanceWindowArgs] = None,
        next_maintenance_action_type: Optional[str] = None,
        next_maintenance_description: Optional[str] = None,
        nsg_ids: Optional[Sequence[str]] = None,
        ogg_data: Optional[DeploymentOggDataArgs] = None,
        placements: Optional[Sequence[DeploymentPlacementArgs]] = None,
        private_ip_address: Optional[str] = None,
        public_ip_address: Optional[str] = None,
        source_deployment_id: 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_role_changed: Optional[str] = None,
        time_updated: Optional[str] = None,
        time_upgrade_required: Optional[str] = None) -> Deploymentfunc 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
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- AvailabilityDomain string
- The availability domain of a placement.
- BackupSchedule DeploymentBackup Schedule 
- (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.
- CpuCore intCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Dictionary<string, string>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeploymentBackup stringId 
- The OCID of the backup being referenced.
- DeploymentDiagnostic List<DeploymentDatas Deployment Diagnostic Data> 
- Information regarding the deployment diagnostic collection
- DeploymentRole string
- The type of the deployment role.
- DeploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- DeploymentUrl string
- The URL of a resource.
- Description string
- (Updatable) Metadata about this specific object.
- DisplayName string
- (Updatable) An object's Display Name.
- EnvironmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- FaultDomain string
- The fault domain of a placement.
- Fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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<DeploymentIngress Ip> 
- 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.
- IsAuto boolScaling Enabled 
- (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.
- IsLatest boolVersion 
- Indicates if the resource is the the latest available version.
- IsLock boolOverride 
- IsPublic bool
- (Updatable) True if this object is publicly available.
- IsStorage boolUtilization Limit Exceeded 
- 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.
- LifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- LoadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- LoadBalancer stringSubnet Id 
- (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
List<DeploymentLock> 
- Locks associated with this resource.
- MaintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- MaintenanceWindow DeploymentMaintenance Window 
- (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
- NextMaintenance stringAction Type 
- Type of the next maintenance.
- NextMaintenance stringDescription 
- 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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- Placements
List<DeploymentPlacement> 
- (Updatable) An array of local peers of deployment
- PrivateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- PublicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- SourceDeployment stringId 
- The OCID of the deployment being referenced.
- State string
- StorageUtilization stringIn Bytes 
- 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.
- 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.
- TimeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- TimeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- TimeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- TimeOgg stringVersion Supported Until 
- 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.
- TimeRole stringChanged 
- The time of the last role change. 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.
- TimeUpgrade stringRequired 
- 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.
- AvailabilityDomain string
- The availability domain of a placement.
- BackupSchedule DeploymentBackup Schedule Args 
- (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.
- CpuCore intCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- map[string]string
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DeploymentBackup stringId 
- The OCID of the backup being referenced.
- DeploymentDiagnostic []DeploymentDatas Deployment Diagnostic Data Args 
- Information regarding the deployment diagnostic collection
- DeploymentRole string
- The type of the deployment role.
- DeploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- DeploymentUrl string
- The URL of a resource.
- Description string
- (Updatable) Metadata about this specific object.
- DisplayName string
- (Updatable) An object's Display Name.
- EnvironmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- FaultDomain string
- The fault domain of a placement.
- Fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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 []DeploymentIngress Ip Args 
- 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.
- IsAuto boolScaling Enabled 
- (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.
- IsLatest boolVersion 
- Indicates if the resource is the the latest available version.
- IsLock boolOverride 
- IsPublic bool
- (Updatable) True if this object is publicly available.
- IsStorage boolUtilization Limit Exceeded 
- 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.
- LifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- LoadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- LoadBalancer stringSubnet Id 
- (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
[]DeploymentLock Args 
- Locks associated with this resource.
- MaintenanceConfiguration DeploymentMaintenance Configuration Args 
- (Updatable) Defines the maintenance configuration for create operation.
- MaintenanceWindow DeploymentMaintenance Window Args 
- (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
- NextMaintenance stringAction Type 
- Type of the next maintenance.
- NextMaintenance stringDescription 
- 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 DeploymentOgg Data Args 
- (Updatable) Deployment Data for creating an OggDeployment
- Placements
[]DeploymentPlacement Args 
- (Updatable) An array of local peers of deployment
- PrivateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- PublicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- SourceDeployment stringId 
- The OCID of the deployment being referenced.
- State string
- StorageUtilization stringIn Bytes 
- 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.
- 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.
- TimeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- TimeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- TimeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- TimeOgg stringVersion Supported Until 
- 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.
- TimeRole stringChanged 
- The time of the last role change. 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.
- TimeUpgrade stringRequired 
- 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.
- availabilityDomain String
- The availability domain of a placement.
- backupSchedule DeploymentBackup Schedule 
- (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.
- cpuCore IntegerCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<String,String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup StringId 
- The OCID of the backup being referenced.
- deploymentDiagnostic List<DeploymentDatas Deployment Diagnostic Data> 
- Information regarding the deployment diagnostic collection
- deploymentRole String
- The type of the deployment role.
- deploymentType String
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- deploymentUrl String
- The URL of a resource.
- description String
- (Updatable) Metadata about this specific object.
- displayName String
- (Updatable) An object's Display Name.
- environmentType String
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain String
- The fault domain of a placement.
- fqdn String
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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<DeploymentIngress Ip> 
- 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.
- isAuto BooleanScaling Enabled 
- (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.
- isLatest BooleanVersion 
- Indicates if the resource is the the latest available version.
- isLock BooleanOverride 
- isPublic Boolean
- (Updatable) True if this object is publicly available.
- isStorage BooleanUtilization Limit Exceeded 
- 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.
- lifecycleSub StringState 
- Possible GGS lifecycle sub-states.
- loadBalancer StringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- loadBalancer StringSubnet Id 
- (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
List<DeploymentLock> 
- Locks associated with this resource.
- maintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenanceWindow DeploymentMaintenance Window 
- (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
- nextMaintenance StringAction Type 
- Type of the next maintenance.
- nextMaintenance StringDescription 
- 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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
List<DeploymentPlacement> 
- (Updatable) An array of local peers of deployment
- privateIp StringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp StringAddress 
- The public IP address representing the access point for the Deployment.
- sourceDeployment StringId 
- The OCID of the deployment being referenced.
- state String
- storageUtilization StringIn Bytes 
- 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.
- 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.
- timeLast StringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext StringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf StringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg StringVersion Supported Until 
- 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.
- timeRole StringChanged 
- The time of the last role change. 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.
- timeUpgrade StringRequired 
- 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.
- availabilityDomain string
- The availability domain of a placement.
- backupSchedule DeploymentBackup Schedule 
- (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.
- cpuCore numberCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- {[key: string]: string}
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup stringId 
- The OCID of the backup being referenced.
- deploymentDiagnostic DeploymentDatas Deployment Diagnostic Data[] 
- Information regarding the deployment diagnostic collection
- deploymentRole string
- The type of the deployment role.
- deploymentType string
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- deploymentUrl string
- The URL of a resource.
- description string
- (Updatable) Metadata about this specific object.
- displayName string
- (Updatable) An object's Display Name.
- environmentType string
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain string
- The fault domain of a placement.
- fqdn string
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- {[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 DeploymentIngress Ip[] 
- 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.
- isAuto booleanScaling Enabled 
- (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.
- isLatest booleanVersion 
- Indicates if the resource is the the latest available version.
- isLock booleanOverride 
- isPublic boolean
- (Updatable) True if this object is publicly available.
- isStorage booleanUtilization Limit Exceeded 
- 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.
- lifecycleSub stringState 
- Possible GGS lifecycle sub-states.
- loadBalancer stringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- loadBalancer stringSubnet Id 
- (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
DeploymentLock[] 
- Locks associated with this resource.
- maintenanceConfiguration DeploymentMaintenance Configuration 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenanceWindow DeploymentMaintenance Window 
- (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
- nextMaintenance stringAction Type 
- Type of the next maintenance.
- nextMaintenance stringDescription 
- 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 DeploymentOgg Data 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
DeploymentPlacement[] 
- (Updatable) An array of local peers of deployment
- privateIp stringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp stringAddress 
- The public IP address representing the access point for the Deployment.
- sourceDeployment stringId 
- The OCID of the deployment being referenced.
- state string
- storageUtilization stringIn Bytes 
- 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.
- {[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.
- timeLast stringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext stringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf stringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg stringVersion Supported Until 
- 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.
- timeRole stringChanged 
- The time of the last role change. 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.
- timeUpgrade stringRequired 
- 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.
- availability_domain str
- The availability domain of a placement.
- backup_schedule DeploymentBackup Schedule Args 
- (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_ intcount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- 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_ strid 
- The OCID of the backup being referenced.
- deployment_diagnostic_ Sequence[Deploymentdatas Deployment Diagnostic Data Args] 
- Information regarding the deployment diagnostic collection
- deployment_role str
- The type of the deployment role.
- deployment_type str
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- deployment_url str
- The URL of a resource.
- description str
- (Updatable) Metadata about this specific object.
- display_name str
- (Updatable) An object's Display Name.
- environment_type str
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- fault_domain str
- The fault domain of a placement.
- fqdn str
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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[DeploymentIngress Ip Args] 
- 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_ boolscaling_ enabled 
- (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_ boolversion 
- Indicates if the resource is the the latest available version.
- is_lock_ booloverride 
- is_public bool
- (Updatable) True if this object is publicly available.
- is_storage_ boolutilization_ limit_ exceeded 
- 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_ strstate 
- Possible GGS lifecycle sub-states.
- load_balancer_ strid 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- load_balancer_ strsubnet_ id 
- (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
Sequence[DeploymentLock Args] 
- Locks associated with this resource.
- maintenance_configuration DeploymentMaintenance Configuration Args 
- (Updatable) Defines the maintenance configuration for create operation.
- maintenance_window DeploymentMaintenance Window Args 
- (Updatable) Defines the maintenance window for create operation, when automatic actions can be performed.
- next_maintenance_ straction_ type 
- Type of the next maintenance.
- next_maintenance_ strdescription 
- 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 DeploymentOgg Data Args 
- (Updatable) Deployment Data for creating an OggDeployment
- placements
Sequence[DeploymentPlacement Args] 
- (Updatable) An array of local peers of deployment
- private_ip_ straddress 
- 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_ straddress 
- The public IP address representing the access point for the Deployment.
- source_deployment_ strid 
- The OCID of the deployment being referenced.
- state str
- storage_utilization_ strin_ bytes 
- 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.
- 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_ strbackup_ scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- time_next_ strbackup_ scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- time_of_ strnext_ maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- time_ogg_ strversion_ supported_ until 
- 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_role_ strchanged 
- The time of the last role change. 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_ strrequired 
- 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.
- availabilityDomain String
- The availability domain of a placement.
- 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.
- cpuCore NumberCount 
- (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<String>
- (Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- deploymentBackup StringId 
- The OCID of the backup being referenced.
- deploymentDiagnostic List<Property Map>Datas 
- Information regarding the deployment diagnostic collection
- deploymentRole String
- The type of the deployment role.
- deploymentType String
- The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value 'OGG' is maintained for backward compatibility purposes. Its use is discouraged in favor of 'DATABASE_ORACLE'.
- deploymentUrl String
- The URL of a resource.
- description String
- (Updatable) Metadata about this specific object.
- displayName String
- (Updatable) An object's Display Name.
- environmentType String
- (Updatable) Specifies whether the deployment is used in a production or development/testing environment.
- faultDomain String
- The fault domain of a placement.
- fqdn String
- (Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- 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.
- isAuto BooleanScaling Enabled 
- (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.
- isLatest BooleanVersion 
- Indicates if the resource is the the latest available version.
- isLock BooleanOverride 
- isPublic Boolean
- (Updatable) True if this object is publicly available.
- isStorage BooleanUtilization Limit Exceeded 
- 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.
- lifecycleSub StringState 
- Possible GGS lifecycle sub-states.
- loadBalancer StringId 
- The OCID of the loadbalancer in the customer's subnet. The loadbalancer of the public deployment created in the customer subnet.
- loadBalancer StringSubnet Id 
- (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 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.
- nextMaintenance StringAction Type 
- Type of the next maintenance.
- nextMaintenance StringDescription 
- 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
- placements List<Property Map>
- (Updatable) An array of local peers of deployment
- privateIp StringAddress 
- The private IP address in the customer's VCN representing the access point for the associated endpoint service in the GoldenGate service VCN.
- publicIp StringAddress 
- The public IP address representing the access point for the Deployment.
- sourceDeployment StringId 
- The OCID of the deployment being referenced.
- state String
- storageUtilization StringIn Bytes 
- 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.
- 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.
- timeLast StringBackup Scheduled 
- The timestamp of last deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- timeNext StringBackup Scheduled 
- The timestamp of next deployment backup scheduled. The format is defined by RFC3339, such as 2024-10-26T20:19:29.600Z.
- timeOf StringNext Maintenance 
- The time of next maintenance schedule. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.
- timeOgg StringVersion Supported Until 
- 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.
- timeRole StringChanged 
- The time of the last role change. 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.
- timeUpgrade StringRequired 
- 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 string
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- CompartmentId string
- (Updatable) The OCID of the compartment being referenced.
- FrequencyBackup stringScheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- IsMetadata boolOnly 
- (Updatable) Parameter to allow users to create backup without trails
- Namespace string
- (Updatable) Name of namespace that serves as a container for all of your buckets
- TimeBackup stringScheduled 
- (Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- Bucket string
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- CompartmentId string
- (Updatable) The OCID of the compartment being referenced.
- FrequencyBackup stringScheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- IsMetadata boolOnly 
- (Updatable) Parameter to allow users to create backup without trails
- Namespace string
- (Updatable) Name of namespace that serves as a container for all of your buckets
- TimeBackup stringScheduled 
- (Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- bucket String
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- compartmentId String
- (Updatable) The OCID of the compartment being referenced.
- frequencyBackup StringScheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- isMetadata BooleanOnly 
- (Updatable) Parameter to allow users to create backup without trails
- namespace String
- (Updatable) Name of namespace that serves as a container for all of your buckets
- timeBackup StringScheduled 
- (Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- bucket string
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- compartmentId string
- (Updatable) The OCID of the compartment being referenced.
- frequencyBackup stringScheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- isMetadata booleanOnly 
- (Updatable) Parameter to allow users to create backup without trails
- namespace string
- (Updatable) Name of namespace that serves as a container for all of your buckets
- timeBackup stringScheduled 
- (Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- bucket str
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- compartment_id str
- (Updatable) The OCID of the compartment being referenced.
- frequency_backup_ strscheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- is_metadata_ boolonly 
- (Updatable) Parameter to allow users to create backup without trails
- namespace str
- (Updatable) Name of namespace that serves as a container for all of your buckets
- time_backup_ strscheduled 
- (Updatable) The start timestamp for the deployment backup schedule. The format is defined by RFC3339, such as 2024-10-25T18:19:29.600Z.
- bucket String
- (Updatable) Name of the bucket where the object is to be uploaded in the object storage
- compartmentId String
- (Updatable) The OCID of the compartment being referenced.
- frequencyBackup StringScheduled 
- (Updatable) The frequency of the deployment backup schedule. Frequency can be DAILY, WEEKLY or MONTHLY.
- isMetadata BooleanOnly 
- (Updatable) Parameter to allow users to create backup without trails
- namespace String
- (Updatable) Name of namespace that serves as a container for all of your buckets
- timeBackup StringScheduled 
- (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
- TimeDiagnostic stringEnd 
- 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.
- TimeDiagnostic stringStart 
- 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
- TimeDiagnostic stringEnd 
- 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.
- TimeDiagnostic stringStart 
- 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
- timeDiagnostic StringEnd 
- 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.
- timeDiagnostic StringStart 
- 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
- timeDiagnostic stringEnd 
- 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.
- timeDiagnostic stringStart 
- 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_ strend 
- 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_ strstart 
- 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
- timeDiagnostic StringEnd 
- 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.
- timeDiagnostic StringStart 
- 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 string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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 string
- Type of the lock.
- Message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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 String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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 string
- Type of the lock.
- message string
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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 str
- Type of the lock.
- message str
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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 String
- Type of the lock.
- message String
- A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
- 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      
- BundleRelease intUpgrade Period In Days 
- (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.
- InterimRelease intUpgrade Period In Days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- IsInterim boolRelease Auto Upgrade Enabled 
- (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.
- MajorRelease intUpgrade Period In Days 
- (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.
- SecurityPatch intUpgrade Period In Days 
- (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.
- BundleRelease intUpgrade Period In Days 
- (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.
- InterimRelease intUpgrade Period In Days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- IsInterim boolRelease Auto Upgrade Enabled 
- (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.
- MajorRelease intUpgrade Period In Days 
- (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.
- SecurityPatch intUpgrade Period In Days 
- (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.
- bundleRelease IntegerUpgrade Period In Days 
- (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.
- interimRelease IntegerUpgrade Period In Days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- isInterim BooleanRelease Auto Upgrade Enabled 
- (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.
- majorRelease IntegerUpgrade Period In Days 
- (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.
- securityPatch IntegerUpgrade Period In Days 
- (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.
- bundleRelease numberUpgrade Period In Days 
- (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.
- interimRelease numberUpgrade Period In Days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- isInterim booleanRelease Auto Upgrade Enabled 
- (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.
- majorRelease numberUpgrade Period In Days 
- (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.
- securityPatch numberUpgrade Period In Days 
- (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_ intupgrade_ period_ in_ days 
- (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_ intupgrade_ period_ in_ days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- is_interim_ boolrelease_ auto_ upgrade_ enabled 
- (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_ intupgrade_ period_ in_ days 
- (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_ intupgrade_ period_ in_ days 
- (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.
- bundleRelease NumberUpgrade Period In Days 
- (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.
- interimRelease NumberUpgrade Period In Days 
- (Updatable) Defines auto upgrade period for interim releases. This period must be shorter or equal to bundle release upgrade period.
- isInterim BooleanRelease Auto Upgrade Enabled 
- (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.
- majorRelease NumberUpgrade Period In Days 
- (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.
- securityPatch NumberUpgrade Period In Days 
- (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 str
- (Updatable) Days of the week.
- start_hour int
- (Updatable) Start hour for maintenance period. Hour is in UTC.
DeploymentOggData, DeploymentOggDataArgs      
- DeploymentName string
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- AdminPassword string
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- AdminUsername string
- (Updatable) The GoldenGate deployment console username.
- Certificate string
- (Updatable) The base64 encoded content of the PEM file containing the SSL certificate.
- CredentialStore string
- (Updatable) The type of credential store for OGG.
- GroupTo DeploymentRoles Mapping Ogg Data Group To Roles Mapping 
- (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.
- IdentityDomain stringId 
- (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
- PasswordSecret stringId 
- (Updatable) The OCID of the Secret where the deployment password is stored.
- DeploymentName string
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- AdminPassword string
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- AdminUsername string
- (Updatable) The GoldenGate deployment console username.
- Certificate string
- (Updatable) The base64 encoded content of the PEM file containing the SSL certificate.
- CredentialStore string
- (Updatable) The type of credential store for OGG.
- GroupTo DeploymentRoles Mapping Ogg Data Group To Roles Mapping 
- (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.
- IdentityDomain stringId 
- (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
- PasswordSecret stringId 
- (Updatable) The OCID of the Secret where the deployment password is stored.
- deploymentName String
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- adminPassword String
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- adminUsername String
- (Updatable) The GoldenGate deployment console username.
- certificate String
- (Updatable) The base64 encoded content of the PEM file containing the SSL certificate.
- credentialStore String
- (Updatable) The type of credential store for OGG.
- groupTo DeploymentRoles Mapping Ogg Data Group To Roles Mapping 
- (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.
- identityDomain StringId 
- (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
- passwordSecret StringId 
- (Updatable) The OCID of the Secret where the deployment password is stored.
- deploymentName string
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- adminPassword string
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- adminUsername string
- (Updatable) The GoldenGate deployment console username.
- certificate string
- (Updatable) The base64 encoded content of the PEM file containing the SSL certificate.
- credentialStore string
- (Updatable) The type of credential store for OGG.
- groupTo DeploymentRoles Mapping Ogg Data Group To Roles Mapping 
- (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.
- identityDomain stringId 
- (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
- passwordSecret stringId 
- (Updatable) The OCID of the Secret where the deployment password is stored.
- deployment_name str
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- admin_password str
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- admin_username str
- (Updatable) The GoldenGate deployment console username.
- certificate str
- (Updatable) 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_ Deploymentroles_ mapping Ogg Data Group To Roles Mapping 
- (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_ strid 
- (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_ strid 
- (Updatable) The OCID of the Secret where the deployment password is stored.
- deploymentName String
- The name given to the GoldenGate service deployment. The name must be 1 to 32 characters long, must contain only alphanumeric characters and must start with a letter.
- adminPassword String
- (Updatable) The password associated with the GoldenGate deployment console username. The password must be 8 to 30 characters long and must contain at least 1 uppercase, 1 lowercase, 1 numeric, and 1 special character. Special characters such as ‘$’, ‘^’, or ‘?’ are not allowed. This field will be deprecated and replaced by "passwordSecretId".
- adminUsername String
- (Updatable) The GoldenGate deployment console username.
- certificate String
- (Updatable) The base64 encoded content of the PEM file containing the SSL certificate.
- credentialStore String
- (Updatable) The type of credential store for OGG.
- groupTo Property MapRoles Mapping 
- (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.
- identityDomain StringId 
- (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
- passwordSecret StringId 
- (Updatable) The OCID of the Secret where the deployment password is stored.
DeploymentOggDataGroupToRolesMapping, DeploymentOggDataGroupToRolesMappingArgs              
- SecurityGroup stringId 
- (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.
- AdministratorGroup stringId 
- (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.
- OperatorGroup stringId 
- (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.
- UserGroup stringId 
- (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
- SecurityGroup stringId 
- (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.
- AdministratorGroup stringId 
- (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.
- OperatorGroup stringId 
- (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.
- UserGroup stringId 
- (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
- securityGroup StringId 
- (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.
- administratorGroup StringId 
- (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.
- operatorGroup StringId 
- (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.
- userGroup StringId 
- (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
- securityGroup stringId 
- (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.
- administratorGroup stringId 
- (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.
- operatorGroup stringId 
- (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.
- userGroup stringId 
- (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_ strid 
- (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_ strid 
- (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_ strid 
- (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_ strid 
- (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
- securityGroup StringId 
- (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.
- administratorGroup StringId 
- (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.
- operatorGroup StringId 
- (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.
- userGroup StringId 
- (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
DeploymentPlacement, DeploymentPlacementArgs    
- AvailabilityDomain string
- (Updatable) The availability domain of a placement.
- FaultDomain string
- (Updatable) The fault domain of a placement.
- AvailabilityDomain string
- (Updatable) The availability domain of a placement.
- FaultDomain string
- (Updatable) The fault domain of a placement.
- availabilityDomain String
- (Updatable) The availability domain of a placement.
- faultDomain String
- (Updatable) The fault domain of a placement.
- availabilityDomain string
- (Updatable) The availability domain of a placement.
- faultDomain string
- (Updatable) The fault domain of a placement.
- availability_domain str
- (Updatable) The availability domain of a placement.
- fault_domain str
- (Updatable) The fault domain of a placement.
- availabilityDomain String
- (Updatable) The availability domain of a placement.
- faultDomain String
- (Updatable) The fault domain of a placement.
Import
Deployments can be imported using the id, e.g.
$ pulumi import oci:GoldenGate/deployment:Deployment test_deployment "id"
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 ociTerraform Provider.