Oracle Cloud Infrastructure
Deployment
This resource provides the Deployment resource in Oracle Cloud Infrastructure Golden Gate service.
Creates a new Deployment.
Create a Deployment Resource
new Deployment(name: string, args: DeploymentArgs, opts?: CustomResourceOptions);
@overload
def Deployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
cpu_core_count: Optional[int] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
deployment_backup_id: Optional[str] = None,
deployment_type: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
fqdn: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
is_auto_scaling_enabled: Optional[bool] = None,
is_public: Optional[bool] = None,
license_model: Optional[str] = None,
nsg_ids: Optional[Sequence[str]] = None,
ogg_data: Optional[_goldengate.DeploymentOggDataArgs] = None,
subnet_id: Optional[str] = None)
@overload
def Deployment(resource_name: str,
args: DeploymentArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The Deployment resource accepts the following input properties:
- Compartment
Id string (Updatable) The OCID of the compartment being referenced.
- Cpu
Core intCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Deployment
Type string The deployment type.
- Display
Name string (Updatable) An object's Display Name.
- Is
Auto boolScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- License
Model string (Updatable) The Oracle license model that applies to a Deployment.
- Subnet
Id string (Updatable) The OCID of the subnet being referenced.
- Dictionary<string, object>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Backup stringId The OCID of the backup being referenced.
- Description string
(Updatable) Metadata about this specific object.
- Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Dictionary<string, object>
(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
Public bool (Updatable) True if this object is publicly available.
- Nsg
Ids List<string> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- Ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- Compartment
Id string (Updatable) The OCID of the compartment being referenced.
- Cpu
Core intCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Deployment
Type string The deployment type.
- Display
Name string (Updatable) An object's Display Name.
- Is
Auto boolScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- License
Model string (Updatable) The Oracle license model that applies to a Deployment.
- Subnet
Id string (Updatable) The OCID of the subnet being referenced.
- map[string]interface{}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Backup stringId The OCID of the backup being referenced.
- Description string
(Updatable) Metadata about this specific object.
- Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- map[string]interface{}
(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
Public bool (Updatable) True if this object is publicly available.
- Nsg
Ids []string (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- Ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- compartment
Id String (Updatable) The OCID of the compartment being referenced.
- cpu
Core IntegerCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- deployment
Type String The deployment type.
- display
Name String (Updatable) An object's Display Name.
- is
Auto BooleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- license
Model String (Updatable) The Oracle license model that applies to a Deployment.
- subnet
Id String (Updatable) The OCID of the subnet being referenced.
- Map<String,Object>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup StringId The OCID of the backup being referenced.
- description String
(Updatable) Metadata about this specific object.
- fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Map<String,Object>
(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
Public Boolean (Updatable) True if this object is publicly available.
- nsg
Ids List<String> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- compartment
Id string (Updatable) The OCID of the compartment being referenced.
- cpu
Core numberCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- deployment
Type string The deployment type.
- display
Name string (Updatable) An object's Display Name.
- is
Auto booleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- license
Model string (Updatable) The Oracle license model that applies to a Deployment.
- subnet
Id string (Updatable) The OCID of the subnet being referenced.
- {[key: string]: any}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup stringId The OCID of the backup being referenced.
- description string
(Updatable) Metadata about this specific object.
- fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- {[key: string]: any}
(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
Public boolean (Updatable) True if this object is publicly available.
- nsg
Ids string[] (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- 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.
- deployment_
type str The deployment type.
- display_
name str (Updatable) An object's Display Name.
- is_
auto_ boolscaling_ enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- license_
model str (Updatable) The Oracle license model that applies to a Deployment.
- subnet_
id str (Updatable) The OCID of the subnet being referenced.
- Mapping[str, Any]
(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.
- description str
(Updatable) Metadata about this specific object.
- fqdn str
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Mapping[str, Any]
(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_
public bool (Updatable) True if this object is publicly available.
- nsg_
ids Sequence[str] (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg_
data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- compartment
Id String (Updatable) The OCID of the compartment being referenced.
- cpu
Core NumberCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- deployment
Type String The deployment type.
- display
Name String (Updatable) An object's Display Name.
- is
Auto BooleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- license
Model String (Updatable) The Oracle license model that applies to a Deployment.
- subnet
Id String (Updatable) The OCID of the subnet being referenced.
- Map<Any>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup StringId The OCID of the backup being referenced.
- description String
(Updatable) Metadata about this specific object.
- fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Map<Any>
(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
Public Boolean (Updatable) True if this object is publicly available.
- nsg
Ids List<String> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data Property Map (Updatable) Deployment Data for creating an OggDeployment
Outputs
All input properties are implicitly available as output properties. Additionally, the Deployment resource produces the following output properties:
- Deployment
Url string The URL of a resource.
- Id string
The provider-assigned unique ID for this managed resource.
- 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 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 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.
- Lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- Private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- State string
Possible lifecycle states.
- Storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- Dictionary<string, object>
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Upgrade stringRequired 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
.
- Deployment
Url string The URL of a resource.
- Id string
The provider-assigned unique ID for this managed resource.
- 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 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 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.
- Lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- Private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- State string
Possible lifecycle states.
- Storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- map[string]interface{}
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Upgrade stringRequired 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
.
- deployment
Url String The URL of a resource.
- id String
The provider-assigned unique ID for this managed resource.
- is
Healthy Boolean True if all of the aggregate resources are working correctly.
- is
Latest BooleanVersion Indicates if the resource is the the latest available version.
- is
Storage BooleanUtilization Limit Exceeded 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 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.
- lifecycle
Sub StringState Possible GGS lifecycle sub-states.
- private
Ip StringAddress 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 StringAddress The public IP address representing the access point for the Deployment.
- state String
Possible lifecycle states.
- storage
Utilization StringIn Bytes The amount of storage being utilized (in bytes)
- Map<String,Object>
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 String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade StringRequired 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
.
- deployment
Url string The URL of a resource.
- id string
The provider-assigned unique ID for this managed resource.
- is
Healthy boolean True if all of the aggregate resources are working correctly.
- is
Latest booleanVersion Indicates if the resource is the the latest available version.
- is
Storage booleanUtilization Limit Exceeded 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 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.
- lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- state string
Possible lifecycle states.
- storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- {[key: string]: any}
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade stringRequired 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
.
- deployment_
url str The URL of a resource.
- id str
The provider-assigned unique ID for this managed resource.
- 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 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.
- 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.
- state str
Possible lifecycle states.
- storage_
utilization_ strin_ bytes The amount of storage being utilized (in bytes)
- Mapping[str, Any]
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_
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 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
.
- deployment
Url String The URL of a resource.
- id String
The provider-assigned unique ID for this managed resource.
- is
Healthy Boolean True if all of the aggregate resources are working correctly.
- is
Latest BooleanVersion Indicates if the resource is the the latest available version.
- is
Storage BooleanUtilization Limit Exceeded 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 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.
- lifecycle
Sub StringState Possible GGS lifecycle sub-states.
- private
Ip StringAddress 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 StringAddress The public IP address representing the access point for the Deployment.
- state String
Possible lifecycle states.
- storage
Utilization StringIn Bytes The amount of storage being utilized (in bytes)
- Map<Any>
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 String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade StringRequired 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 an 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,
compartment_id: Optional[str] = None,
cpu_core_count: Optional[int] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
deployment_backup_id: Optional[str] = None,
deployment_type: Optional[str] = None,
deployment_url: Optional[str] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
fqdn: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
is_auto_scaling_enabled: Optional[bool] = None,
is_healthy: Optional[bool] = None,
is_latest_version: 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,
nsg_ids: Optional[Sequence[str]] = None,
ogg_data: Optional[_goldengate.DeploymentOggDataArgs] = None,
private_ip_address: Optional[str] = None,
public_ip_address: Optional[str] = None,
state: Optional[str] = None,
storage_utilization_in_bytes: Optional[str] = None,
subnet_id: Optional[str] = None,
system_tags: Optional[Mapping[str, Any]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None,
time_upgrade_required: Optional[str] = None) -> Deployment
func GetDeployment(ctx *Context, name string, id IDInput, state *DeploymentState, opts ...ResourceOption) (*Deployment, error)
public static Deployment Get(string name, Input<string> id, DeploymentState? state, CustomResourceOptions? opts = null)
public static Deployment get(String name, Output<String> id, DeploymentState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- 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.
- Compartment
Id string (Updatable) The OCID of the compartment being referenced.
- Cpu
Core intCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Dictionary<string, object>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Backup stringId The OCID of the backup being referenced.
- Deployment
Type string The deployment type.
- Deployment
Url string The URL of a resource.
- Description string
(Updatable) Metadata about this specific object.
- Display
Name string (Updatable) An object's Display Name.
- Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Dictionary<string, object>
(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
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
Public bool (Updatable) True if this object is publicly available.
- Is
Storage boolUtilization Limit Exceeded 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 string (Updatable) The Oracle license model that applies to a Deployment.
- Lifecycle
Details 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.
- Lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- Nsg
Ids List<string> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- Ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- Private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- State string
Possible lifecycle states.
- Storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- Subnet
Id string (Updatable) The OCID of the subnet being referenced.
- Dictionary<string, object>
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Upgrade stringRequired 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
.
- Compartment
Id string (Updatable) The OCID of the compartment being referenced.
- Cpu
Core intCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- map[string]interface{}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Deployment
Backup stringId The OCID of the backup being referenced.
- Deployment
Type string The deployment type.
- Deployment
Url string The URL of a resource.
- Description string
(Updatable) Metadata about this specific object.
- Display
Name string (Updatable) An object's Display Name.
- Fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- map[string]interface{}
(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
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
Public bool (Updatable) True if this object is publicly available.
- Is
Storage boolUtilization Limit Exceeded 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 string (Updatable) The Oracle license model that applies to a Deployment.
- Lifecycle
Details 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.
- Lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- Nsg
Ids []string (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- Ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- Private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- State string
Possible lifecycle states.
- Storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- Subnet
Id string (Updatable) The OCID of the subnet being referenced.
- map[string]interface{}
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- Time
Upgrade stringRequired 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
.
- compartment
Id String (Updatable) The OCID of the compartment being referenced.
- cpu
Core IntegerCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<String,Object>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup StringId The OCID of the backup being referenced.
- deployment
Type String The deployment type.
- deployment
Url String The URL of a resource.
- description String
(Updatable) Metadata about this specific object.
- display
Name String (Updatable) An object's Display Name.
- fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Map<String,Object>
(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 BooleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- is
Healthy Boolean True if all of the aggregate resources are working correctly.
- is
Latest BooleanVersion Indicates if the resource is the the latest available version.
- is
Public Boolean (Updatable) True if this object is publicly available.
- is
Storage BooleanUtilization Limit Exceeded 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 String (Updatable) The Oracle license model that applies to a Deployment.
- lifecycle
Details 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.
- lifecycle
Sub StringState Possible GGS lifecycle sub-states.
- nsg
Ids List<String> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- private
Ip StringAddress 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 StringAddress The public IP address representing the access point for the Deployment.
- state String
Possible lifecycle states.
- storage
Utilization StringIn Bytes The amount of storage being utilized (in bytes)
- subnet
Id String (Updatable) The OCID of the subnet being referenced.
- Map<String,Object>
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 String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade StringRequired 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
.
- compartment
Id string (Updatable) The OCID of the compartment being referenced.
- cpu
Core numberCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- {[key: string]: any}
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup stringId The OCID of the backup being referenced.
- deployment
Type string The deployment type.
- deployment
Url string The URL of a resource.
- description string
(Updatable) Metadata about this specific object.
- display
Name string (Updatable) An object's Display Name.
- fqdn string
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- {[key: string]: any}
(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 booleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- is
Healthy boolean True if all of the aggregate resources are working correctly.
- is
Latest booleanVersion Indicates if the resource is the the latest available version.
- is
Public boolean (Updatable) True if this object is publicly available.
- is
Storage booleanUtilization Limit Exceeded 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 string (Updatable) The Oracle license model that applies to a Deployment.
- lifecycle
Details 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.
- lifecycle
Sub stringState Possible GGS lifecycle sub-states.
- nsg
Ids string[] (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- private
Ip stringAddress 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 stringAddress The public IP address representing the access point for the Deployment.
- state string
Possible lifecycle states.
- storage
Utilization stringIn Bytes The amount of storage being utilized (in bytes)
- subnet
Id string (Updatable) The OCID of the subnet being referenced.
- {[key: string]: any}
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 string The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated string The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade stringRequired 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
.
- 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, Any]
(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 deployment type.
- 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.
- fqdn str
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Mapping[str, Any]
(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_
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_
public bool (Updatable) True if this object is publicly available.
- is_
storage_ boolutilization_ limit_ exceeded 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.
- nsg_
ids Sequence[str] (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg_
data DeploymentOgg Data Args (Updatable) Deployment Data for creating an OggDeployment
- 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.
- state str
Possible lifecycle states.
- storage_
utilization_ strin_ bytes The amount of storage being utilized (in bytes)
- subnet_
id str (Updatable) The OCID of the subnet being referenced.
- Mapping[str, Any]
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_
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 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
.
- compartment
Id String (Updatable) The OCID of the compartment being referenced.
- cpu
Core NumberCount (Updatable) The Minimum number of OCPUs to be made available for this Deployment.
- Map<Any>
(Updatable) Tags defined for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- deployment
Backup StringId The OCID of the backup being referenced.
- deployment
Type String The deployment type.
- deployment
Url String The URL of a resource.
- description String
(Updatable) Metadata about this specific object.
- display
Name String (Updatable) An object's Display Name.
- fqdn String
(Updatable) A three-label Fully Qualified Domain Name (FQDN) for a resource.
- Map<Any>
(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 BooleanScaling Enabled (Updatable) Indicates if auto scaling is enabled for the Deployment's CPU core count.
- is
Healthy Boolean True if all of the aggregate resources are working correctly.
- is
Latest BooleanVersion Indicates if the resource is the the latest available version.
- is
Public Boolean (Updatable) True if this object is publicly available.
- is
Storage BooleanUtilization Limit Exceeded 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 String (Updatable) The Oracle license model that applies to a Deployment.
- lifecycle
Details 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.
- lifecycle
Sub StringState Possible GGS lifecycle sub-states.
- nsg
Ids List<String> (Updatable) An array of Network Security Group OCIDs used to define network access for a deployment.
- ogg
Data Property Map (Updatable) Deployment Data for creating an OggDeployment
- private
Ip StringAddress 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 StringAddress The public IP address representing the access point for the Deployment.
- state String
Possible lifecycle states.
- storage
Utilization StringIn Bytes The amount of storage being utilized (in bytes)
- subnet
Id String (Updatable) The OCID of the subnet being referenced.
- Map<Any>
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 String The time the resource was created. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Updated String The time the resource was last updated. The format is defined by RFC3339, such as
2016-08-25T21:10:29.600Z
.- time
Upgrade StringRequired 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
DeploymentOggData
- Admin
Password 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.
- Admin
Username string (Updatable) The GoldenGate deployment console username.
- Deployment
Name 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.
- Certificate string
(Updatable) A PEM-encoded SSL certificate.
- Key string
(Updatable) A PEM-encoded private key.
- Ogg
Version string Version of OGG
- Admin
Password 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.
- Admin
Username string (Updatable) The GoldenGate deployment console username.
- Deployment
Name 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.
- Certificate string
(Updatable) A PEM-encoded SSL certificate.
- Key string
(Updatable) A PEM-encoded private key.
- Ogg
Version string Version of OGG
- admin
Password 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.
- admin
Username String (Updatable) The GoldenGate deployment console username.
- deployment
Name 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.
- certificate String
(Updatable) A PEM-encoded SSL certificate.
- key String
(Updatable) A PEM-encoded private key.
- ogg
Version String Version of OGG
- admin
Password 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.
- admin
Username string (Updatable) The GoldenGate deployment console username.
- deployment
Name 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.
- certificate string
(Updatable) A PEM-encoded SSL certificate.
- key string
(Updatable) A PEM-encoded private key.
- ogg
Version string Version of OGG
- 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.
- admin_
username str (Updatable) The GoldenGate deployment console username.
- 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.
- certificate str
(Updatable) A PEM-encoded SSL certificate.
- key str
(Updatable) A PEM-encoded private key.
- ogg_
version str Version of OGG
- admin
Password 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.
- admin
Username String (Updatable) The GoldenGate deployment console username.
- deployment
Name 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.
- certificate String
(Updatable) A PEM-encoded SSL certificate.
- key String
(Updatable) A PEM-encoded private key.
- ogg
Version String Version of OGG
Import
Deployments can be imported using the id
, e.g.
$ pulumi import oci:GoldenGate/deployment:Deployment test_deployment "id"
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.