Oracle Cloud Infrastructure v0.19.0, May 26 23

oci.DatabaseMigration.getAgent

Explore with Pulumi AI

This data source provides details about a specific Agent resource in Oracle Cloud Infrastructure Database Migration service.

Display the ODMS Agent configuration.

Example Usage

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testAgent = Oci.DatabaseMigration.GetAgent.Invoke(new()
    {
        AgentId = oci_database_migration_agent.Test_agent.Id,
    });

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/go/oci/DatabaseMigration"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DatabaseMigration.GetAgent(ctx, &databasemigration.GetAgentArgs{
			AgentId: oci_database_migration_agent.Test_agent.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DatabaseMigration.DatabaseMigrationFunctions;
import com.pulumi.oci.DatabaseMigration.inputs.GetAgentArgs;
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) {
        final var testAgent = DatabaseMigrationFunctions.getAgent(GetAgentArgs.builder()
            .agentId(oci_database_migration_agent.test_agent().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_agent = oci.DatabaseMigration.get_agent(agent_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAgent = oci.DatabaseMigration.getAgent({
    agentId: oci_database_migration_agent.test_agent.id,
});

variables:
  testAgent:
    fn::invoke:
      Function: oci:DatabaseMigration:getAgent
      Arguments:
        agentId: ${oci_database_migration_agent.test_agent.id}

Using getAgent

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAgent(args: GetAgentArgs, opts?: InvokeOptions): Promise<GetAgentResult>
function getAgentOutput(args: GetAgentOutputArgs, opts?: InvokeOptions): Output<GetAgentResult>

def get_agent(agent_id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetAgentResult
def get_agent_output(agent_id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetAgentResult]

func GetAgent(ctx *Context, args *GetAgentArgs, opts ...InvokeOption) (*GetAgentResult, error)
func GetAgentOutput(ctx *Context, args *GetAgentOutputArgs, opts ...InvokeOption) GetAgentResultOutput

> Note: This function is named GetAgent in the Go SDK.

public static class GetAgent 
{
    public static Task<GetAgentResult> InvokeAsync(GetAgentArgs args, InvokeOptions? opts = null)
    public static Output<GetAgentResult> Invoke(GetAgentInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAgentResult> getAgent(GetAgentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:DatabaseMigration/getAgent:getAgent
  arguments:
    # arguments dictionary

The following arguments are supported:

AgentId string: The OCID of the agent

AgentId string: The OCID of the agent

agentId String: The OCID of the agent

agentId string: The OCID of the agent

agent_id str: The OCID of the agent

agentId String: The OCID of the agent

getAgent Result

The following output properties are available:

AgentId string
CompartmentId string: OCID of the compartment
DefinedTags Dictionary<string, object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: ODMS Agent name
FreeformTags Dictionary<string, object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the resource
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
PublicKey string: ODMS Agent public key.
State string: The current state of the ODMS on-premises Agent.
StreamId string: The OCID of the Stream
SystemTags Dictionary<string, object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Agent was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time of the last Agent details update. An RFC3339 formatted datetime string.
Version string: ODMS Agent version

AgentId string
CompartmentId string: OCID of the compartment
DefinedTags map[string]interface{}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: ODMS Agent name
FreeformTags map[string]interface{}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: The OCID of the resource
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
PublicKey string: ODMS Agent public key.
State string: The current state of the ODMS on-premises Agent.
StreamId string: The OCID of the Stream
SystemTags map[string]interface{}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the Agent was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time of the last Agent details update. An RFC3339 formatted datetime string.
Version string: ODMS Agent version

agentId String
compartmentId String: OCID of the compartment
definedTags Map<String,Object>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: ODMS Agent name
freeformTags Map<String,Object>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the resource
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
publicKey String: ODMS Agent public key.
state String: The current state of the ODMS on-premises Agent.
streamId String: The OCID of the Stream
systemTags Map<String,Object>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Agent was created. An RFC3339 formatted datetime string.
timeUpdated String: The time of the last Agent details update. An RFC3339 formatted datetime string.
version String: ODMS Agent version

agentId string
compartmentId string: OCID of the compartment
definedTags {[key: string]: any}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: ODMS Agent name
freeformTags {[key: string]: any}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: The OCID of the resource
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
publicKey string: ODMS Agent public key.
state string: The current state of the ODMS on-premises Agent.
streamId string: The OCID of the Stream
systemTags {[key: string]: any}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the Agent was created. An RFC3339 formatted datetime string.
timeUpdated string: The time of the last Agent details update. An RFC3339 formatted datetime string.
version string: ODMS Agent version

agent_id str
compartment_id str: OCID of the compartment
defined_tags Mapping[str, Any]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: ODMS Agent name
freeform_tags Mapping[str, Any]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: The OCID of the resource
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
public_key str: ODMS Agent public key.
state str: The current state of the ODMS on-premises Agent.
stream_id str: The OCID of the Stream
system_tags Mapping[str, Any]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the Agent was created. An RFC3339 formatted datetime string.
time_updated str: The time of the last Agent details update. An RFC3339 formatted datetime string.
version str: ODMS Agent version

agentId String
compartmentId String: OCID of the compartment
definedTags Map<Any>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: ODMS Agent name
freeformTags Map<Any>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: The OCID of the resource
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.
publicKey String: ODMS Agent public key.
state String: The current state of the ODMS on-premises Agent.
streamId String: The OCID of the Stream
systemTags Map<Any>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the Agent was created. An RFC3339 formatted datetime string.
timeUpdated String: The time of the last Agent details update. An RFC3339 formatted datetime string.
version String: ODMS Agent version

Package Details

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

oci.DatabaseMigration.getAgent

Example Usage

Using getAgent

getAgent Result

Package Details

On this page