Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace CreateDeploymentDetails

The information about a new Deployment.

Properties

Optional availabilityDomain

availabilityDomain: undefined | string

The availability domain of a placement.

Optional backupSchedule

backupSchedule: model.CreateBackupScheduleDetails

Optional byolCpuCoreCountLimit

byolCpuCoreCountLimit: undefined | number

The maximum number of CPUs allowed with a 'Bring Your Own License' (BYOL) license type. Any CPU usage above this limit is considered as License Included and billed. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional clusterPlacementGroupId

clusterPlacementGroupId: undefined | string

The OCID(/Content/General/Concepts/identifiers.htm) of the cluster placement group for the resource. Only applicable for multicloud subscriptions. The cluster placement group id must be provided when a multicloud subscription id is provided. Otherwise the cluster placement group must not be provided.

compartmentId

compartmentId: string

The OCID of the compartment being referenced.

Optional cpuCoreCount

cpuCoreCount: undefined | number

The Minimum number of OCPUs to be made available for this Deployment. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional definedTags

definedTags: undefined | object

Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {@code {\"foo-namespace\": {\"bar-key\": \"value\"}}}

Optional deploymentBackupId

deploymentBackupId: undefined | string

The OCID of the backup being referenced.

Optional deploymentType

deploymentType: model.DeploymentType

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'.

Optional description

description: undefined | string

Metadata about this specific object.

displayName

displayName: string

An object's Display Name.

Optional environmentType

environmentType: model.EnvironmentType

Specifies whether the deployment is used in a production or development/testing environment.

Optional faultDomain

faultDomain: undefined | string

The fault domain of a placement.

Optional fqdn

fqdn: undefined | string

A three-label Fully Qualified Domain Name (FQDN) for a resource.

Optional freeformTags

freeformTags: undefined | object

A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {@code {\"bar-key\": \"value\"}}

Optional isAutoScalingEnabled

isAutoScalingEnabled: undefined | false | true

Indicates if auto scaling is enabled for the Deployment's CPU core count.

Optional isByolCpuCoreCountLimitEnabled

isByolCpuCoreCountLimitEnabled: undefined | false | true

Flag to allow to configure the 'Bring Your Own License' (BYOL) license type CPU limit. If enabled, the exact number of CPUs must be provided via byolCpuCoreCountLimit.

Optional isPublic

isPublic: undefined | false | true

True if this object is publicly available.

Optional licenseModel

licenseModel: model.LicenseModel

The Oracle license model that applies to a Deployment.

Optional loadBalancerSubnetId

loadBalancerSubnetId: undefined | string

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.

Optional locks

Locks associated with this resource.

Optional maintenanceConfiguration

maintenanceConfiguration: model.CreateMaintenanceConfigurationDetails

Optional maintenanceWindow

maintenanceWindow: model.CreateMaintenanceWindowDetails

Optional nsgIds

nsgIds: Array<string>

An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Optional oggData

oggData: model.CreateOggDeploymentDetails

Optional placements

An array of local peers of deployment

Optional securityAttributes

securityAttributes: undefined | object

Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {@code {\"Oracle-ZPR\": {\"MaxEgressCount\": {\"value\": \"42\", \"mode\": \"enforce\"}}}}

Optional sourceDeploymentId

sourceDeploymentId: undefined | string

The OCID of the deployment being referenced.

subnetId

subnetId: string

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.

Optional subscriptionId

subscriptionId: undefined | string

The OCID of the subscription with which resource needs to be associated with.

Functions

getDeserializedJsonObj

getJsonObj