oci logo
Oracle Cloud Infrastructure v0.6.0, Jan 23 23

oci.CloudBridge.AgentPlugin

This resource provides the Agent Plugin resource in Oracle Cloud Infrastructure Cloud Bridge service.

Updates the plugin.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testAgentPlugin = new Oci.CloudBridge.AgentPlugin("testAgentPlugin", new()
    {
        AgentId = oci_cloud_bridge_agent.Test_agent.Id,
        PluginName = @var.Agent_plugin_plugin_name,
        DesiredState = @var.Agent_plugin_desired_state,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := CloudBridge.NewAgentPlugin(ctx, "testAgentPlugin", &CloudBridge.AgentPluginArgs{
			AgentId:      pulumi.Any(oci_cloud_bridge_agent.Test_agent.Id),
			PluginName:   pulumi.Any(_var.Agent_plugin_plugin_name),
			DesiredState: pulumi.Any(_var.Agent_plugin_desired_state),
		})
		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.CloudBridge.AgentPlugin;
import com.pulumi.oci.CloudBridge.AgentPluginArgs;
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 testAgentPlugin = new AgentPlugin("testAgentPlugin", AgentPluginArgs.builder()        
            .agentId(oci_cloud_bridge_agent.test_agent().id())
            .pluginName(var_.agent_plugin_plugin_name())
            .desiredState(var_.agent_plugin_desired_state())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_agent_plugin = oci.cloud_bridge.AgentPlugin("testAgentPlugin",
    agent_id=oci_cloud_bridge_agent["test_agent"]["id"],
    plugin_name=var["agent_plugin_plugin_name"],
    desired_state=var["agent_plugin_desired_state"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testAgentPlugin = new oci.cloudbridge.AgentPlugin("testAgentPlugin", {
    agentId: oci_cloud_bridge_agent.test_agent.id,
    pluginName: _var.agent_plugin_plugin_name,
    desiredState: _var.agent_plugin_desired_state,
});
resources:
  testAgentPlugin:
    type: oci:CloudBridge:AgentPlugin
    properties:
      #Required
      agentId: ${oci_cloud_bridge_agent.test_agent.id}
      pluginName: ${var.agent_plugin_plugin_name}
      #Optional
      desiredState: ${var.agent_plugin_desired_state}

Create AgentPlugin Resource

new AgentPlugin(name: string, args: AgentPluginArgs, opts?: CustomResourceOptions);
@overload
def AgentPlugin(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                agent_id: Optional[str] = None,
                desired_state: Optional[str] = None,
                plugin_name: Optional[str] = None)
@overload
def AgentPlugin(resource_name: str,
                args: AgentPluginArgs,
                opts: Optional[ResourceOptions] = None)
func NewAgentPlugin(ctx *Context, name string, args AgentPluginArgs, opts ...ResourceOption) (*AgentPlugin, error)
public AgentPlugin(string name, AgentPluginArgs args, CustomResourceOptions? opts = null)
public AgentPlugin(String name, AgentPluginArgs args)
public AgentPlugin(String name, AgentPluginArgs args, CustomResourceOptions options)
type: oci:CloudBridge:AgentPlugin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

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

AgentId string

Unique Agent identifier path parameter.

PluginName string

Unique plugin identifier path parameter.

DesiredState string

(Updatable) State to which the customer wants the plugin to move to.

AgentId string

Unique Agent identifier path parameter.

PluginName string

Unique plugin identifier path parameter.

DesiredState string

(Updatable) State to which the customer wants the plugin to move to.

agentId String

Unique Agent identifier path parameter.

pluginName String

Unique plugin identifier path parameter.

desiredState String

(Updatable) State to which the customer wants the plugin to move to.

agentId string

Unique Agent identifier path parameter.

pluginName string

Unique plugin identifier path parameter.

desiredState string

(Updatable) State to which the customer wants the plugin to move to.

agent_id str

Unique Agent identifier path parameter.

plugin_name str

Unique plugin identifier path parameter.

desired_state str

(Updatable) State to which the customer wants the plugin to move to.

agentId String

Unique Agent identifier path parameter.

pluginName String

Unique plugin identifier path parameter.

desiredState String

(Updatable) State to which the customer wants the plugin to move to.

Outputs

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

DefinedTags Dictionary<string, object>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags Dictionary<string, object>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Name string

Plugin identifier, which can be renamed.

PluginVersion string

Plugin version.

State string

The current state of the plugin.

SystemTags 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}}

TimeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

DefinedTags map[string]interface{}

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

FreeformTags map[string]interface{}

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The provider-assigned unique ID for this managed resource.

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Name string

Plugin identifier, which can be renamed.

PluginVersion string

Plugin version.

State string

The current state of the plugin.

SystemTags 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}}

TimeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

definedTags Map<String,Object>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<String,Object>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name String

Plugin identifier, which can be renamed.

pluginVersion String

Plugin version.

state String

The current state of the plugin.

systemTags 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}}

timeCreated String

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the Agent was updated. An RFC3339 formatted datetime string.

definedTags {[key: string]: any}

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags {[key: string]: any}

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The provider-assigned unique ID for this managed resource.

lifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name string

Plugin identifier, which can be renamed.

pluginVersion string

Plugin version.

state string

The current state of the plugin.

systemTags {[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}}

timeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

defined_tags Mapping[str, Any]

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeform_tags Mapping[str, Any]

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

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, it can be used to provide actionable information for a resource in Failed state.

name str

Plugin identifier, which can be renamed.

plugin_version str

Plugin version.

state str

The current state of the plugin.

system_tags 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 when the Agent was created. An RFC3339 formatted datetime string.

time_updated str

The time when the Agent was updated. An RFC3339 formatted datetime string.

definedTags Map<Any>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

freeformTags Map<Any>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The provider-assigned unique ID for this managed resource.

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name String

Plugin identifier, which can be renamed.

pluginVersion String

Plugin version.

state String

The current state of the plugin.

systemTags 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}}

timeCreated String

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the Agent was updated. An RFC3339 formatted datetime string.

Look up Existing AgentPlugin Resource

Get an existing AgentPlugin 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?: AgentPluginState, opts?: CustomResourceOptions): AgentPlugin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        agent_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, Any]] = None,
        desired_state: Optional[str] = None,
        freeform_tags: Optional[Mapping[str, Any]] = None,
        lifecycle_details: Optional[str] = None,
        name: Optional[str] = None,
        plugin_name: Optional[str] = None,
        plugin_version: Optional[str] = None,
        state: Optional[str] = None,
        system_tags: Optional[Mapping[str, Any]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None) -> AgentPlugin
func GetAgentPlugin(ctx *Context, name string, id IDInput, state *AgentPluginState, opts ...ResourceOption) (*AgentPlugin, error)
public static AgentPlugin Get(string name, Input<string> id, AgentPluginState? state, CustomResourceOptions? opts = null)
public static AgentPlugin get(String name, Output<String> id, AgentPluginState 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

Unique Agent identifier path parameter.

DefinedTags Dictionary<string, object>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) State to which the customer wants the plugin to move to.

FreeformTags Dictionary<string, object>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Name string

Plugin identifier, which can be renamed.

PluginName string

Unique plugin identifier path parameter.

PluginVersion string

Plugin version.

State string

The current state of the plugin.

SystemTags 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}}

TimeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

AgentId string

Unique Agent identifier path parameter.

DefinedTags map[string]interface{}

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DesiredState string

(Updatable) State to which the customer wants the plugin to move to.

FreeformTags map[string]interface{}

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

LifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Name string

Plugin identifier, which can be renamed.

PluginName string

Unique plugin identifier path parameter.

PluginVersion string

Plugin version.

State string

The current state of the plugin.

SystemTags 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}}

TimeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

agentId String

Unique Agent identifier path parameter.

definedTags Map<String,Object>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) State to which the customer wants the plugin to move to.

freeformTags Map<String,Object>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name String

Plugin identifier, which can be renamed.

pluginName String

Unique plugin identifier path parameter.

pluginVersion String

Plugin version.

state String

The current state of the plugin.

systemTags 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}}

timeCreated String

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the Agent was updated. An RFC3339 formatted datetime string.

agentId string

Unique Agent identifier path parameter.

definedTags {[key: string]: any}

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState string

(Updatable) State to which the customer wants the plugin to move to.

freeformTags {[key: string]: any}

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

lifecycleDetails string

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name string

Plugin identifier, which can be renamed.

pluginName string

Unique plugin identifier path parameter.

pluginVersion string

Plugin version.

state string

The current state of the plugin.

systemTags {[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}}

timeCreated string

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated string

The time when the Agent was updated. An RFC3339 formatted datetime string.

agent_id str

Unique Agent identifier path parameter.

defined_tags Mapping[str, Any]

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desired_state str

(Updatable) State to which the customer wants the plugin to move to.

freeform_tags Mapping[str, Any]

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

lifecycle_details str

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name str

Plugin identifier, which can be renamed.

plugin_name str

Unique plugin identifier path parameter.

plugin_version str

Plugin version.

state str

The current state of the plugin.

system_tags 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 when the Agent was created. An RFC3339 formatted datetime string.

time_updated str

The time when the Agent was updated. An RFC3339 formatted datetime string.

agentId String

Unique Agent identifier path parameter.

definedTags Map<Any>

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

desiredState String

(Updatable) State to which the customer wants the plugin to move to.

freeformTags Map<Any>

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {"Department": "Finance"}

lifecycleDetails String

A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

name String

Plugin identifier, which can be renamed.

pluginName String

Unique plugin identifier path parameter.

pluginVersion String

Plugin version.

state String

The current state of the plugin.

systemTags 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}}

timeCreated String

The time when the Agent was created. An RFC3339 formatted datetime string.

timeUpdated String

The time when the Agent was updated. An RFC3339 formatted datetime string.

Import

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

 $ pulumi import oci:CloudBridge/agentPlugin:AgentPlugin test_agent_plugin "agents/{agentId}/plugins/{pluginName}"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.