oci.DataSafe.TargetDatabaseGroup
Explore with Pulumi AI
This resource provides the Target Database Group resource in Oracle Cloud Infrastructure Data Safe service.
Creates a new target database group.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testTargetDatabaseGroup = new oci.datasafe.TargetDatabaseGroup("test_target_database_group", {
compartmentId: compartmentId,
displayName: targetDatabaseGroupDisplayName,
matchingCriteria: {
include: {
compartments: [{
id: targetDatabaseGroupMatchingCriteriaIncludeCompartmentsId,
isIncludeSubtree: targetDatabaseGroupMatchingCriteriaIncludeCompartmentsIsIncludeSubtree,
}],
definedTags: {
"Operations.CostCenter": "42",
},
freeformTags: {
Department: "Finance",
},
targetDatabaseIds: targetDatabaseGroupMatchingCriteriaIncludeTargetDatabaseIds,
},
exclude: {
targetDatabaseIds: targetDatabaseGroupMatchingCriteriaExcludeTargetDatabaseIds,
},
},
definedTags: {
"Operations.CostCenter": "42",
},
description: targetDatabaseGroupDescription,
freeformTags: {
Department: "Finance",
},
});
import pulumi
import pulumi_oci as oci
test_target_database_group = oci.datasafe.TargetDatabaseGroup("test_target_database_group",
compartment_id=compartment_id,
display_name=target_database_group_display_name,
matching_criteria={
"include": {
"compartments": [{
"id": target_database_group_matching_criteria_include_compartments_id,
"is_include_subtree": target_database_group_matching_criteria_include_compartments_is_include_subtree,
}],
"defined_tags": {
"Operations.CostCenter": "42",
},
"freeform_tags": {
"Department": "Finance",
},
"target_database_ids": target_database_group_matching_criteria_include_target_database_ids,
},
"exclude": {
"target_database_ids": target_database_group_matching_criteria_exclude_target_database_ids,
},
},
defined_tags={
"Operations.CostCenter": "42",
},
description=target_database_group_description,
freeform_tags={
"Department": "Finance",
})
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/datasafe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := datasafe.NewTargetDatabaseGroup(ctx, "test_target_database_group", &datasafe.TargetDatabaseGroupArgs{
CompartmentId: pulumi.Any(compartmentId),
DisplayName: pulumi.Any(targetDatabaseGroupDisplayName),
MatchingCriteria: &datasafe.TargetDatabaseGroupMatchingCriteriaArgs{
Include: &datasafe.TargetDatabaseGroupMatchingCriteriaIncludeArgs{
Compartments: datasafe.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArray{
&datasafe.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs{
Id: pulumi.Any(targetDatabaseGroupMatchingCriteriaIncludeCompartmentsId),
IsIncludeSubtree: pulumi.Any(targetDatabaseGroupMatchingCriteriaIncludeCompartmentsIsIncludeSubtree),
},
},
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
TargetDatabaseIds: pulumi.Any(targetDatabaseGroupMatchingCriteriaIncludeTargetDatabaseIds),
},
Exclude: &datasafe.TargetDatabaseGroupMatchingCriteriaExcludeArgs{
TargetDatabaseIds: pulumi.Any(targetDatabaseGroupMatchingCriteriaExcludeTargetDatabaseIds),
},
},
DefinedTags: pulumi.StringMap{
"Operations.CostCenter": pulumi.String("42"),
},
Description: pulumi.Any(targetDatabaseGroupDescription),
FreeformTags: pulumi.StringMap{
"Department": pulumi.String("Finance"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testTargetDatabaseGroup = new Oci.DataSafe.TargetDatabaseGroup("test_target_database_group", new()
{
CompartmentId = compartmentId,
DisplayName = targetDatabaseGroupDisplayName,
MatchingCriteria = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaArgs
{
Include = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaIncludeArgs
{
Compartments = new[]
{
new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs
{
Id = targetDatabaseGroupMatchingCriteriaIncludeCompartmentsId,
IsIncludeSubtree = targetDatabaseGroupMatchingCriteriaIncludeCompartmentsIsIncludeSubtree,
},
},
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
FreeformTags =
{
{ "Department", "Finance" },
},
TargetDatabaseIds = targetDatabaseGroupMatchingCriteriaIncludeTargetDatabaseIds,
},
Exclude = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaExcludeArgs
{
TargetDatabaseIds = targetDatabaseGroupMatchingCriteriaExcludeTargetDatabaseIds,
},
},
DefinedTags =
{
{ "Operations.CostCenter", "42" },
},
Description = targetDatabaseGroupDescription,
FreeformTags =
{
{ "Department", "Finance" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataSafe.TargetDatabaseGroup;
import com.pulumi.oci.DataSafe.TargetDatabaseGroupArgs;
import com.pulumi.oci.DataSafe.inputs.TargetDatabaseGroupMatchingCriteriaArgs;
import com.pulumi.oci.DataSafe.inputs.TargetDatabaseGroupMatchingCriteriaIncludeArgs;
import com.pulumi.oci.DataSafe.inputs.TargetDatabaseGroupMatchingCriteriaExcludeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var testTargetDatabaseGroup = new TargetDatabaseGroup("testTargetDatabaseGroup", TargetDatabaseGroupArgs.builder()
.compartmentId(compartmentId)
.displayName(targetDatabaseGroupDisplayName)
.matchingCriteria(TargetDatabaseGroupMatchingCriteriaArgs.builder()
.include(TargetDatabaseGroupMatchingCriteriaIncludeArgs.builder()
.compartments(TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs.builder()
.id(targetDatabaseGroupMatchingCriteriaIncludeCompartmentsId)
.isIncludeSubtree(targetDatabaseGroupMatchingCriteriaIncludeCompartmentsIsIncludeSubtree)
.build())
.definedTags(Map.of("Operations.CostCenter", "42"))
.freeformTags(Map.of("Department", "Finance"))
.targetDatabaseIds(targetDatabaseGroupMatchingCriteriaIncludeTargetDatabaseIds)
.build())
.exclude(TargetDatabaseGroupMatchingCriteriaExcludeArgs.builder()
.targetDatabaseIds(targetDatabaseGroupMatchingCriteriaExcludeTargetDatabaseIds)
.build())
.build())
.definedTags(Map.of("Operations.CostCenter", "42"))
.description(targetDatabaseGroupDescription)
.freeformTags(Map.of("Department", "Finance"))
.build());
}
}
resources:
testTargetDatabaseGroup:
type: oci:DataSafe:TargetDatabaseGroup
name: test_target_database_group
properties:
compartmentId: ${compartmentId}
displayName: ${targetDatabaseGroupDisplayName}
matchingCriteria:
include:
compartments:
- id: ${targetDatabaseGroupMatchingCriteriaIncludeCompartmentsId}
isIncludeSubtree: ${targetDatabaseGroupMatchingCriteriaIncludeCompartmentsIsIncludeSubtree}
definedTags:
Operations.CostCenter: '42'
freeformTags:
Department: Finance
targetDatabaseIds: ${targetDatabaseGroupMatchingCriteriaIncludeTargetDatabaseIds}
exclude:
targetDatabaseIds: ${targetDatabaseGroupMatchingCriteriaExcludeTargetDatabaseIds}
definedTags:
Operations.CostCenter: '42'
description: ${targetDatabaseGroupDescription}
freeformTags:
Department: Finance
Create TargetDatabaseGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new TargetDatabaseGroup(name: string, args: TargetDatabaseGroupArgs, opts?: CustomResourceOptions);
@overload
def TargetDatabaseGroup(resource_name: str,
args: TargetDatabaseGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def TargetDatabaseGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
display_name: Optional[str] = None,
matching_criteria: Optional[TargetDatabaseGroupMatchingCriteriaArgs] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None)
func NewTargetDatabaseGroup(ctx *Context, name string, args TargetDatabaseGroupArgs, opts ...ResourceOption) (*TargetDatabaseGroup, error)
public TargetDatabaseGroup(string name, TargetDatabaseGroupArgs args, CustomResourceOptions? opts = null)
public TargetDatabaseGroup(String name, TargetDatabaseGroupArgs args)
public TargetDatabaseGroup(String name, TargetDatabaseGroupArgs args, CustomResourceOptions options)
type: oci:DataSafe:TargetDatabaseGroup
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 TargetDatabaseGroupArgs
- 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 TargetDatabaseGroupArgs
- 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 TargetDatabaseGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TargetDatabaseGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TargetDatabaseGroupArgs
- 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 targetDatabaseGroupResource = new Oci.DataSafe.TargetDatabaseGroup("targetDatabaseGroupResource", new()
{
CompartmentId = "string",
DisplayName = "string",
MatchingCriteria = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaArgs
{
Include = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaIncludeArgs
{
Compartments = new[]
{
new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs
{
Id = "string",
IsIncludeSubtree = false,
},
},
DefinedTags =
{
{ "string", "string" },
},
FreeformTags =
{
{ "string", "string" },
},
TargetDatabaseIds = new[]
{
"string",
},
},
Exclude = new Oci.DataSafe.Inputs.TargetDatabaseGroupMatchingCriteriaExcludeArgs
{
TargetDatabaseIds = new[]
{
"string",
},
},
},
DefinedTags =
{
{ "string", "string" },
},
Description = "string",
FreeformTags =
{
{ "string", "string" },
},
});
example, err := datasafe.NewTargetDatabaseGroup(ctx, "targetDatabaseGroupResource", &datasafe.TargetDatabaseGroupArgs{
CompartmentId: pulumi.String("string"),
DisplayName: pulumi.String("string"),
MatchingCriteria: &datasafe.TargetDatabaseGroupMatchingCriteriaArgs{
Include: &datasafe.TargetDatabaseGroupMatchingCriteriaIncludeArgs{
Compartments: datasafe.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArray{
&datasafe.TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs{
Id: pulumi.String("string"),
IsIncludeSubtree: pulumi.Bool(false),
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TargetDatabaseIds: pulumi.StringArray{
pulumi.String("string"),
},
},
Exclude: &datasafe.TargetDatabaseGroupMatchingCriteriaExcludeArgs{
TargetDatabaseIds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
DefinedTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
Description: pulumi.String("string"),
FreeformTags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var targetDatabaseGroupResource = new TargetDatabaseGroup("targetDatabaseGroupResource", TargetDatabaseGroupArgs.builder()
.compartmentId("string")
.displayName("string")
.matchingCriteria(TargetDatabaseGroupMatchingCriteriaArgs.builder()
.include(TargetDatabaseGroupMatchingCriteriaIncludeArgs.builder()
.compartments(TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs.builder()
.id("string")
.isIncludeSubtree(false)
.build())
.definedTags(Map.of("string", "string"))
.freeformTags(Map.of("string", "string"))
.targetDatabaseIds("string")
.build())
.exclude(TargetDatabaseGroupMatchingCriteriaExcludeArgs.builder()
.targetDatabaseIds("string")
.build())
.build())
.definedTags(Map.of("string", "string"))
.description("string")
.freeformTags(Map.of("string", "string"))
.build());
target_database_group_resource = oci.datasafe.TargetDatabaseGroup("targetDatabaseGroupResource",
compartment_id="string",
display_name="string",
matching_criteria={
"include": {
"compartments": [{
"id": "string",
"is_include_subtree": False,
}],
"defined_tags": {
"string": "string",
},
"freeform_tags": {
"string": "string",
},
"target_database_ids": ["string"],
},
"exclude": {
"target_database_ids": ["string"],
},
},
defined_tags={
"string": "string",
},
description="string",
freeform_tags={
"string": "string",
})
const targetDatabaseGroupResource = new oci.datasafe.TargetDatabaseGroup("targetDatabaseGroupResource", {
compartmentId: "string",
displayName: "string",
matchingCriteria: {
include: {
compartments: [{
id: "string",
isIncludeSubtree: false,
}],
definedTags: {
string: "string",
},
freeformTags: {
string: "string",
},
targetDatabaseIds: ["string"],
},
exclude: {
targetDatabaseIds: ["string"],
},
},
definedTags: {
string: "string",
},
description: "string",
freeformTags: {
string: "string",
},
});
type: oci:DataSafe:TargetDatabaseGroup
properties:
compartmentId: string
definedTags:
string: string
description: string
displayName: string
freeformTags:
string: string
matchingCriteria:
exclude:
targetDatabaseIds:
- string
include:
compartments:
- id: string
isIncludeSubtree: false
definedTags:
string: string
freeformTags:
string: string
targetDatabaseIds:
- string
TargetDatabaseGroup 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 TargetDatabaseGroup resource accepts the following input properties:
- Compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- Display
Name string - (Updatable) The name of the target database group.
- Matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) Description of the target database group (optional).
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- Display
Name string - (Updatable) The name of the target database group.
- Matching
Criteria TargetDatabase Group Matching Criteria Args - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) Description of the target database group (optional).
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- compartment
Id String - (Updatable) The OCID of the compartment to create the target database group.
- display
Name String - (Updatable) The name of the target database group.
- matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) Description of the target database group (optional).
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- display
Name string - (Updatable) The name of the target database group.
- matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) Description of the target database group (optional).
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- compartment_
id str - (Updatable) The OCID of the compartment to create the target database group.
- display_
name str - (Updatable) The name of the target database group.
- matching_
criteria TargetDatabase Group Matching Criteria Args - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) Description of the target database group (optional).
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- compartment
Id String - (Updatable) The OCID of the compartment to create the target database group.
- display
Name String - (Updatable) The name of the target database group.
- matching
Criteria Property Map - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) Description of the target database group (optional).
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
Outputs
All input properties are implicitly available as output properties. Additionally, the TargetDatabaseGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Details for the lifecycle status of the target database group.
- Membership
Count int - The number of target databases in the specified target database group.
- Membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- State string
- The lifecycle status of the target database group.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time when the target database group was created.
- Time
Updated string - Time when the target database group was last updated.
- Id string
- The provider-assigned unique ID for this managed resource.
- Lifecycle
Details string - Details for the lifecycle status of the target database group.
- Membership
Count int - The number of target databases in the specified target database group.
- Membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- State string
- The lifecycle status of the target database group.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time when the target database group was created.
- Time
Updated string - Time when the target database group was last updated.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Details for the lifecycle status of the target database group.
- membership
Count Integer - The number of target databases in the specified target database group.
- membership
Update StringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state String
- The lifecycle status of the target database group.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time when the target database group was created.
- time
Updated String - Time when the target database group was last updated.
- id string
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details string - Details for the lifecycle status of the target database group.
- membership
Count number - The number of target databases in the specified target database group.
- membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state string
- The lifecycle status of the target database group.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - Time when the target database group was created.
- time
Updated string - Time when the target database group was last updated.
- id str
- The provider-assigned unique ID for this managed resource.
- lifecycle_
details str - Details for the lifecycle status of the target database group.
- membership_
count int - The number of target databases in the specified target database group.
- membership_
update_ strtime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state str
- The lifecycle status of the target database group.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - Time when the target database group was created.
- time_
updated str - Time when the target database group was last updated.
- id String
- The provider-assigned unique ID for this managed resource.
- lifecycle
Details String - Details for the lifecycle status of the target database group.
- membership
Count Number - The number of target databases in the specified target database group.
- membership
Update StringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state String
- The lifecycle status of the target database group.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time when the target database group was created.
- time
Updated String - Time when the target database group was last updated.
Look up Existing TargetDatabaseGroup Resource
Get an existing TargetDatabaseGroup 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?: TargetDatabaseGroupState, opts?: CustomResourceOptions): TargetDatabaseGroup
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
defined_tags: Optional[Mapping[str, str]] = None,
description: Optional[str] = None,
display_name: Optional[str] = None,
freeform_tags: Optional[Mapping[str, str]] = None,
lifecycle_details: Optional[str] = None,
matching_criteria: Optional[TargetDatabaseGroupMatchingCriteriaArgs] = None,
membership_count: Optional[int] = None,
membership_update_time: Optional[str] = None,
state: Optional[str] = None,
system_tags: Optional[Mapping[str, str]] = None,
time_created: Optional[str] = None,
time_updated: Optional[str] = None) -> TargetDatabaseGroup
func GetTargetDatabaseGroup(ctx *Context, name string, id IDInput, state *TargetDatabaseGroupState, opts ...ResourceOption) (*TargetDatabaseGroup, error)
public static TargetDatabaseGroup Get(string name, Input<string> id, TargetDatabaseGroupState? state, CustomResourceOptions? opts = null)
public static TargetDatabaseGroup get(String name, Output<String> id, TargetDatabaseGroupState state, CustomResourceOptions options)
resources: _: type: oci:DataSafe:TargetDatabaseGroup 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.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) Description of the target database group (optional).
- Display
Name string - (Updatable) The name of the target database group.
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Lifecycle
Details string - Details for the lifecycle status of the target database group.
- Matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Membership
Count int - The number of target databases in the specified target database group.
- Membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- State string
- The lifecycle status of the target database group.
- Dictionary<string, string>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time when the target database group was created.
- Time
Updated string - Time when the target database group was last updated.
- Compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
- (Updatable) Description of the target database group (optional).
- Display
Name string - (Updatable) The name of the target database group.
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Lifecycle
Details string - Details for the lifecycle status of the target database group.
- Matching
Criteria TargetDatabase Group Matching Criteria Args - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- Membership
Count int - The number of target databases in the specified target database group.
- Membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- State string
- The lifecycle status of the target database group.
- map[string]string
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Time
Created string - Time when the target database group was created.
- Time
Updated string - Time when the target database group was last updated.
- compartment
Id String - (Updatable) The OCID of the compartment to create the target database group.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) Description of the target database group (optional).
- display
Name String - (Updatable) The name of the target database group.
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- lifecycle
Details String - Details for the lifecycle status of the target database group.
- matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- membership
Count Integer - The number of target databases in the specified target database group.
- membership
Update StringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state String
- The lifecycle status of the target database group.
- Map<String,String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time when the target database group was created.
- time
Updated String - Time when the target database group was last updated.
- compartment
Id string - (Updatable) The OCID of the compartment to create the target database group.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
- (Updatable) Description of the target database group (optional).
- display
Name string - (Updatable) The name of the target database group.
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- lifecycle
Details string - Details for the lifecycle status of the target database group.
- matching
Criteria TargetDatabase Group Matching Criteria - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- membership
Count number - The number of target databases in the specified target database group.
- membership
Update stringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state string
- The lifecycle status of the target database group.
- {[key: string]: string}
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created string - Time when the target database group was created.
- time
Updated string - Time when the target database group was last updated.
- compartment_
id str - (Updatable) The OCID of the compartment to create the target database group.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
- (Updatable) Description of the target database group (optional).
- display_
name str - (Updatable) The name of the target database group.
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- lifecycle_
details str - Details for the lifecycle status of the target database group.
- matching_
criteria TargetDatabase Group Matching Criteria Args - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- membership_
count int - The number of target databases in the specified target database group.
- membership_
update_ strtime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state str
- The lifecycle status of the target database group.
- Mapping[str, str]
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time_
created str - Time when the target database group was created.
- time_
updated str - Time when the target database group was last updated.
- compartment
Id String - (Updatable) The OCID of the compartment to create the target database group.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
- (Updatable) Description of the target database group (optional).
- display
Name String - (Updatable) The name of the target database group.
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- lifecycle
Details String - Details for the lifecycle status of the target database group.
- matching
Criteria Property Map - (Updatable) Criteria to either include or exclude target databases from the target database group. These criteria can be based on compartments or tags or a list of target databases. See examples below for more details. Include: Target databases will be added to the target database group if they match at least one of the include criteria. Exclude: Target databases that will be excluded from the target database group (even if they match any of the include criteria).
- membership
Count Number - The number of target databases in the specified target database group.
- membership
Update StringTime - Time when the members of the target database group were last changed, i.e. the list was refreshed, a target database was added or removed.
- state String
- The lifecycle status of the target database group.
- Map<String>
- System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example:
{"orcl-cloud.free-tier-retained": "true"}
- time
Created String - Time when the target database group was created.
- time
Updated String - Time when the target database group was last updated.
Supporting Types
TargetDatabaseGroupMatchingCriteria, TargetDatabaseGroupMatchingCriteriaArgs
- Include
Target
Database Group Matching Criteria Include - (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- Exclude
Target
Database Group Matching Criteria Exclude - (Updatable) Criteria to exclude certain target databases from the target database group.
- Include
Target
Database Group Matching Criteria Include - (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- Exclude
Target
Database Group Matching Criteria Exclude - (Updatable) Criteria to exclude certain target databases from the target database group.
- include
Target
Database Group Matching Criteria Include - (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- exclude
Target
Database Group Matching Criteria Exclude - (Updatable) Criteria to exclude certain target databases from the target database group.
- include
Target
Database Group Matching Criteria Include - (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- exclude
Target
Database Group Matching Criteria Exclude - (Updatable) Criteria to exclude certain target databases from the target database group.
- include
Target
Database Group Matching Criteria Include - (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- exclude
Target
Database Group Matching Criteria Exclude - (Updatable) Criteria to exclude certain target databases from the target database group.
- include Property Map
- (Updatable) Criteria to determine whether a target database should be included in the target database group. If the database satisfies any of compartments, targetDatabaseIds, freeformTags, or definedTags criteria, it qualifies for inclusion in the target database group
- exclude Property Map
- (Updatable) Criteria to exclude certain target databases from the target database group.
TargetDatabaseGroupMatchingCriteriaExclude, TargetDatabaseGroupMatchingCriteriaExcludeArgs
- Target
Database List<string>Ids - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
- Target
Database []stringIds - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
- target
Database List<String>Ids - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
- target
Database string[]Ids - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
- target_
database_ Sequence[str]ids - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
- target
Database List<String>Ids - (Updatable) The list of target database OCIDS, that should be excluded from the target database group (even if they match some of the other criteria).
TargetDatabaseGroupMatchingCriteriaInclude, TargetDatabaseGroupMatchingCriteriaIncludeArgs
- Compartments
List<Target
Database Group Matching Criteria Include Compartment> - (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- Dictionary<string, string>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Dictionary<string, string>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Target
Database List<string>Ids (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- Compartments
[]Target
Database Group Matching Criteria Include Compartment - (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- map[string]string
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- map[string]string
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- Target
Database []stringIds (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartments
List<Target
Database Group Matching Criteria Include Compartment> - (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- Map<String,String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Map<String,String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- target
Database List<String>Ids (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartments
Target
Database Group Matching Criteria Include Compartment[] - (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- {[key: string]: string}
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- {[key: string]: string}
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- target
Database string[]Ids (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartments
Sequence[Target
Database Group Matching Criteria Include Compartment] - (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- Mapping[str, str]
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Mapping[str, str]
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- target_
database_ Sequence[str]ids (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
- compartments List<Property Map>
- (Updatable) List of compartment objects, each containing the OCID of the compartment and a boolean value that indicates whether the target databases in the compartments and sub-compartments should also be included in the target database group.
- Map<String>
- (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Map<String>
- (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags Example:
{"Department": "Finance"}
- target
Database List<String>Ids (Updatable) The list of target database OCIDs to be included in the target database group.
** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values
TargetDatabaseGroupMatchingCriteriaIncludeCompartment, TargetDatabaseGroupMatchingCriteriaIncludeCompartmentArgs
- Id string
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- Is
Include boolSubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
- Id string
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- Is
Include boolSubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
- id String
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- is
Include BooleanSubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
- id string
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- is
Include booleanSubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
- id str
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- is_
include_ boolsubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
- id String
- (Updatable) The OCID of the compartment for including target databases to the target database group. All target databases in the compartment will be members of the target database group.
- is
Include BooleanSubtree - (Updatable) This indicates whether the target databases of sub-compartments should also be included in the target database group. By default, this parameter is set to false.
Import
TargetDatabaseGroups can be imported using the id
, e.g.
$ pulumi import oci:DataSafe/targetDatabaseGroup:TargetDatabaseGroup test_target_database_group "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
oci
Terraform Provider.