Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.DatabaseMigration.Agent

This resource provides the Agent resource in Oracle Cloud Infrastructure Database Migration service.

Modifies the ODMS Agent represented by the given ODMS Agent ID.

Create Agent Resource

new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);

@overload
def Agent(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          agent_id: Optional[str] = None,
          compartment_id: Optional[str] = None,
          defined_tags: Optional[Mapping[str, Any]] = None,
          display_name: Optional[str] = None,
          freeform_tags: Optional[Mapping[str, Any]] = None,
          public_key: Optional[str] = None,
          stream_id: Optional[str] = None,
          version: Optional[str] = None)
@overload
def Agent(resource_name: str,
          args: AgentArgs,
          opts: Optional[ResourceOptions] = None)

func NewAgent(ctx *Context, name string, args AgentArgs, opts ...ResourceOption) (*Agent, error)

public Agent(string name, AgentArgs args, CustomResourceOptions? opts = null)

public Agent(String name, AgentArgs args)
public Agent(String name, AgentArgs args, CustomResourceOptions options)

type: oci:DatabaseMigration:Agent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AgentArgs: 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 AgentArgs: 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 AgentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AgentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AgentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Agent 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 Agent resource accepts the following input properties:

AgentId string: The OCID of the agent
CompartmentId string: (Updatable) OCID of the compartment
DefinedTags Dictionary<string, object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) ODMS Agent name
FreeformTags Dictionary<string, object>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
PublicKey string: (Updatable) ODMS Agent public key.
StreamId string: (Updatable) The OCID of the Stream
Version string: (Updatable) ODMS Agent version

AgentId string: The OCID of the agent
CompartmentId string: (Updatable) OCID of the compartment
DefinedTags map[string]interface{}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) ODMS Agent name
FreeformTags map[string]interface{}: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
PublicKey string: (Updatable) ODMS Agent public key.
StreamId string: (Updatable) The OCID of the Stream
Version string: (Updatable) ODMS Agent version

agentId String: The OCID of the agent
compartmentId String: (Updatable) OCID of the compartment
definedTags Map<String,Object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) ODMS Agent name
freeformTags Map<String,Object>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
publicKey String: (Updatable) ODMS Agent public key.
streamId String: (Updatable) The OCID of the Stream
version String: (Updatable) ODMS Agent version

agentId string: The OCID of the agent
compartmentId string: (Updatable) OCID of the compartment
definedTags {[key: string]: any}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: (Updatable) ODMS Agent name
freeformTags {[key: string]: any}: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
publicKey string: (Updatable) ODMS Agent public key.
streamId string: (Updatable) The OCID of the Stream
version string: (Updatable) ODMS Agent version

agent_id str: The OCID of the agent
compartment_id str: (Updatable) OCID of the compartment
defined_tags Mapping[str, Any]: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: (Updatable) ODMS Agent name
freeform_tags Mapping[str, Any]: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
public_key str: (Updatable) ODMS Agent public key.
stream_id str: (Updatable) The OCID of the Stream
version str: (Updatable) ODMS Agent version

agentId String: The OCID of the agent
compartmentId String: (Updatable) OCID of the compartment
definedTags Map<Any>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) ODMS Agent name
freeformTags Map<Any>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
publicKey String: (Updatable) ODMS Agent public key.
streamId String: (Updatable) The OCID of the Stream
version String: (Updatable) ODMS Agent version

Outputs

All input properties are implicitly available as output properties. Additionally, the Agent resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed 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.
State string: The current state of the ODMS on-premises Agent.
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.

Id string: The provider-assigned unique ID for this managed 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.
State string: The current state of the ODMS on-premises Agent.
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.

id String: The provider-assigned unique ID for this managed 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.
state String: The current state of the ODMS on-premises Agent.
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.

id string: The provider-assigned unique ID for this managed 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.
state string: The current state of the ODMS on-premises Agent.
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.

id str: The provider-assigned unique ID for this managed 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.
state str: The current state of the ODMS on-premises Agent.
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.

id String: The provider-assigned unique ID for this managed 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.
state String: The current state of the ODMS on-premises Agent.
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.

Look up Existing Agent Resource

Get an existing Agent 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?: AgentState, opts?: CustomResourceOptions): Agent

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        display_name: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        public_key: Optional[str] = None,
        state: Optional[str] = None,
        stream_id: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        version: Optional[str] = None) -> Agent

func GetAgent(ctx *Context, name string, id IDInput, state *AgentState, opts ...ResourceOption) (*Agent, error)

public static Agent Get(string name, Input<string> id, AgentState? state, CustomResourceOptions? opts = null)

public static Agent get(String name, Output<String> id, AgentState 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.

The following state arguments are supported:

AgentId string: The OCID of the agent
CompartmentId string: (Updatable) OCID of the compartment
DefinedTags Dictionary<string, object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) ODMS Agent name
FreeformTags Dictionary<string, object>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
State string: The current state of the ODMS on-premises Agent.
StreamId string: (Updatable) 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: (Updatable) ODMS Agent version

AgentId string: The OCID of the agent
CompartmentId string: (Updatable) OCID of the compartment
DefinedTags map[string]interface{}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: (Updatable) ODMS Agent name
FreeformTags map[string]interface{}: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
State string: The current state of the ODMS on-premises Agent.
StreamId string: (Updatable) 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: (Updatable) ODMS Agent version

agentId String: The OCID of the agent
compartmentId String: (Updatable) OCID of the compartment
definedTags Map<String,Object>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) ODMS Agent name
freeformTags Map<String,Object>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
state String: The current state of the ODMS on-premises Agent.
streamId String: (Updatable) 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: (Updatable) ODMS Agent version

agentId string: The OCID of the agent
compartmentId string: (Updatable) OCID of the compartment
definedTags {[key: string]: any}: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName string: (Updatable) ODMS Agent name
freeformTags {[key: string]: any}: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
state string: The current state of the ODMS on-premises Agent.
streamId string: (Updatable) 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: (Updatable) ODMS Agent version

agent_id str: The OCID of the agent
compartment_id str: (Updatable) OCID of the compartment
defined_tags Mapping[str, Any]: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
display_name str: (Updatable) ODMS Agent name
freeform_tags Mapping[str, Any]: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
state str: The current state of the ODMS on-premises Agent.
stream_id str: (Updatable) 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: (Updatable) ODMS Agent version

agentId String: The OCID of the agent
compartmentId String: (Updatable) OCID of the compartment
definedTags Map<Any>: (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
displayName String: (Updatable) ODMS Agent name
freeformTags Map<Any>: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
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: (Updatable) ODMS Agent public key.
state String: The current state of the ODMS on-premises Agent.
streamId String: (Updatable) 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: (Updatable) ODMS Agent version

Import

Agents can be imported using the id, e.g.

 $ pulumi import oci:DatabaseMigration/agent:Agent test_agent "id"

Package Details

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