1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. CloudBridge
  5. Agent
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.CloudBridge.Agent

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

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

    Creates an Agent.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testAgent = new oci.cloudbridge.Agent("test_agent", {
        agentType: agentAgentType,
        agentVersion: agentAgentVersion,
        compartmentId: compartmentId,
        displayName: agentDisplayName,
        environmentId: testEnvironment.id,
        osVersion: agentOsVersion,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_agent = oci.cloud_bridge.Agent("test_agent",
        agent_type=agent_agent_type,
        agent_version=agent_agent_version,
        compartment_id=compartment_id,
        display_name=agent_display_name,
        environment_id=test_environment["id"],
        os_version=agent_os_version,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/CloudBridge"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := CloudBridge.NewAgent(ctx, "test_agent", &CloudBridge.AgentArgs{
    			AgentType:     pulumi.Any(agentAgentType),
    			AgentVersion:  pulumi.Any(agentAgentVersion),
    			CompartmentId: pulumi.Any(compartmentId),
    			DisplayName:   pulumi.Any(agentDisplayName),
    			EnvironmentId: pulumi.Any(testEnvironment.Id),
    			OsVersion:     pulumi.Any(agentOsVersion),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("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 testAgent = new Oci.CloudBridge.Agent("test_agent", new()
        {
            AgentType = agentAgentType,
            AgentVersion = agentAgentVersion,
            CompartmentId = compartmentId,
            DisplayName = agentDisplayName,
            EnvironmentId = testEnvironment.Id,
            OsVersion = agentOsVersion,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.CloudBridge.Agent;
    import com.pulumi.oci.CloudBridge.AgentArgs;
    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 testAgent = new Agent("testAgent", AgentArgs.builder()
                .agentType(agentAgentType)
                .agentVersion(agentAgentVersion)
                .compartmentId(compartmentId)
                .displayName(agentDisplayName)
                .environmentId(testEnvironment.id())
                .osVersion(agentOsVersion)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testAgent:
        type: oci:CloudBridge:Agent
        name: test_agent
        properties:
          agentType: ${agentAgentType}
          agentVersion: ${agentAgentVersion}
          compartmentId: ${compartmentId}
          displayName: ${agentDisplayName}
          environmentId: ${testEnvironment.id}
          osVersion: ${agentOsVersion}
          definedTags:
            Operations.CostCenter: '42'
          freeformTags:
            Department: Finance
    

    Create Agent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Agent(name: string, args: AgentArgs, opts?: CustomResourceOptions);
    @overload
    def Agent(resource_name: str,
              args: AgentArgs,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Agent(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              agent_type: Optional[str] = None,
              agent_version: Optional[str] = None,
              compartment_id: Optional[str] = None,
              display_name: Optional[str] = None,
              environment_id: Optional[str] = None,
              os_version: Optional[str] = None,
              defined_tags: Optional[Mapping[str, Any]] = None,
              freeform_tags: Optional[Mapping[str, Any]] = 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:CloudBridge:Agent
    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 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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var agentResource = new Oci.CloudBridge.Agent("agentResource", new()
    {
        AgentType = "string",
        AgentVersion = "string",
        CompartmentId = "string",
        DisplayName = "string",
        EnvironmentId = "string",
        OsVersion = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
    });
    
    example, err := CloudBridge.NewAgent(ctx, "agentResource", &CloudBridge.AgentArgs{
    	AgentType:     pulumi.String("string"),
    	AgentVersion:  pulumi.String("string"),
    	CompartmentId: pulumi.String("string"),
    	DisplayName:   pulumi.String("string"),
    	EnvironmentId: pulumi.String("string"),
    	OsVersion:     pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    })
    
    var agentResource = new Agent("agentResource", AgentArgs.builder()
        .agentType("string")
        .agentVersion("string")
        .compartmentId("string")
        .displayName("string")
        .environmentId("string")
        .osVersion("string")
        .definedTags(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .build());
    
    agent_resource = oci.cloud_bridge.Agent("agentResource",
        agent_type="string",
        agent_version="string",
        compartment_id="string",
        display_name="string",
        environment_id="string",
        os_version="string",
        defined_tags={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        })
    
    const agentResource = new oci.cloudbridge.Agent("agentResource", {
        agentType: "string",
        agentVersion: "string",
        compartmentId: "string",
        displayName: "string",
        environmentId: "string",
        osVersion: "string",
        definedTags: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
    });
    
    type: oci:CloudBridge:Agent
    properties:
        agentType: string
        agentVersion: string
        compartmentId: string
        definedTags:
            string: any
        displayName: string
        environmentId: string
        freeformTags:
            string: any
        osVersion: string
    

    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:

    AgentType string
    Agent identifier.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    (Updatable) Compartment identifier.
    DisplayName string
    (Updatable) Agent identifier.
    EnvironmentId string
    Environment identifier.
    OsVersion string

    OS version.

    ** 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

    DefinedTags Dictionary<string, object>
    (Updatable) 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>
    (Updatable) 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"}
    AgentType string
    Agent identifier.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    (Updatable) Compartment identifier.
    DisplayName string
    (Updatable) Agent identifier.
    EnvironmentId string
    Environment identifier.
    OsVersion string

    OS version.

    ** 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

    DefinedTags map[string]interface{}
    (Updatable) 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{}
    (Updatable) 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"}
    agentType String
    Agent identifier.
    agentVersion String
    Agent identifier.
    compartmentId String
    (Updatable) Compartment identifier.
    displayName String
    (Updatable) Agent identifier.
    environmentId String
    Environment identifier.
    osVersion String

    OS version.

    ** 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

    definedTags Map<String,Object>
    (Updatable) 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>
    (Updatable) 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"}
    agentType string
    Agent identifier.
    agentVersion string
    Agent identifier.
    compartmentId string
    (Updatable) Compartment identifier.
    displayName string
    (Updatable) Agent identifier.
    environmentId string
    Environment identifier.
    osVersion string

    OS version.

    ** 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

    definedTags {[key: string]: any}
    (Updatable) 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}
    (Updatable) 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"}
    agent_type str
    Agent identifier.
    agent_version str
    Agent identifier.
    compartment_id str
    (Updatable) Compartment identifier.
    display_name str
    (Updatable) Agent identifier.
    environment_id str
    Environment identifier.
    os_version str

    OS version.

    ** 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

    defined_tags Mapping[str, Any]
    (Updatable) 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]
    (Updatable) 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"}
    agentType String
    Agent identifier.
    agentVersion String
    Agent identifier.
    compartmentId String
    (Updatable) Compartment identifier.
    displayName String
    (Updatable) Agent identifier.
    environmentId String
    Environment identifier.
    osVersion String

    OS version.

    ** 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

    definedTags Map<Any>
    (Updatable) 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>
    (Updatable) 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"}

    Outputs

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

    AgentPubKey string
    Resource principal public key.
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    PluginLists List<AgentPluginList>
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    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.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    AgentPubKey string
    Resource principal public key.
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    PluginLists []AgentPluginList
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    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.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey String
    Resource principal public key.
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    pluginLists List<AgentPluginList>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey string
    Resource principal public key.
    heartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    pluginLists AgentPluginList[]
    List of plugins associated with the agent.
    state string
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agent_pub_key str
    Resource principal public key.
    heart_beat_status str
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    plugin_lists Sequence[cloudbridge.AgentPluginList]
    List of plugins associated with the agent.
    state str
    The current state of the Agent.
    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_expire_agent_key_in_ms str
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    time_last_sync_received str
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    time_updated str
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey String
    Resource principal public key.
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    pluginLists List<Property Map>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. 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_pub_key: Optional[str] = None,
            agent_type: Optional[str] = None,
            agent_version: Optional[str] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            display_name: Optional[str] = None,
            environment_id: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            heart_beat_status: Optional[str] = None,
            lifecycle_details: Optional[str] = None,
            os_version: Optional[str] = None,
            plugin_lists: Optional[Sequence[_cloudbridge.AgentPluginListArgs]] = None,
            state: Optional[str] = None,
            system_tags: Optional[Mapping[str, Any]] = None,
            time_created: Optional[str] = None,
            time_expire_agent_key_in_ms: Optional[str] = None,
            time_last_sync_received: Optional[str] = None,
            time_updated: 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:
    AgentPubKey string
    Resource principal public key.
    AgentType string
    Agent identifier.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    (Updatable) Compartment identifier.
    DefinedTags Dictionary<string, object>
    (Updatable) 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"}
    DisplayName string
    (Updatable) Agent identifier.
    EnvironmentId string
    Environment identifier.
    FreeformTags Dictionary<string, object>
    (Updatable) 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"}
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    OsVersion string

    OS version.

    ** 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

    PluginLists List<AgentPluginList>
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    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.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    AgentPubKey string
    Resource principal public key.
    AgentType string
    Agent identifier.
    AgentVersion string
    Agent identifier.
    CompartmentId string
    (Updatable) Compartment identifier.
    DefinedTags map[string]interface{}
    (Updatable) 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"}
    DisplayName string
    (Updatable) Agent identifier.
    EnvironmentId string
    Environment identifier.
    FreeformTags map[string]interface{}
    (Updatable) 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"}
    HeartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    OsVersion string

    OS version.

    ** 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

    PluginLists []AgentPluginListArgs
    List of plugins associated with the agent.
    State string
    The current state of the Agent.
    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.
    TimeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    TimeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    TimeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey String
    Resource principal public key.
    agentType String
    Agent identifier.
    agentVersion String
    Agent identifier.
    compartmentId String
    (Updatable) Compartment identifier.
    definedTags Map<String,Object>
    (Updatable) 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"}
    displayName String
    (Updatable) Agent identifier.
    environmentId String
    Environment identifier.
    freeformTags Map<String,Object>
    (Updatable) 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"}
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    osVersion String

    OS version.

    ** 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

    pluginLists List<AgentPluginList>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey string
    Resource principal public key.
    agentType string
    Agent identifier.
    agentVersion string
    Agent identifier.
    compartmentId string
    (Updatable) Compartment identifier.
    definedTags {[key: string]: any}
    (Updatable) 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"}
    displayName string
    (Updatable) Agent identifier.
    environmentId string
    Environment identifier.
    freeformTags {[key: string]: any}
    (Updatable) 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"}
    heartBeatStatus string
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    osVersion string

    OS version.

    ** 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

    pluginLists AgentPluginList[]
    List of plugins associated with the agent.
    state string
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs string
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived string
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated string
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agent_pub_key str
    Resource principal public key.
    agent_type str
    Agent identifier.
    agent_version str
    Agent identifier.
    compartment_id str
    (Updatable) Compartment identifier.
    defined_tags Mapping[str, Any]
    (Updatable) 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"}
    display_name str
    (Updatable) Agent identifier.
    environment_id str
    Environment identifier.
    freeform_tags Mapping[str, Any]
    (Updatable) 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"}
    heart_beat_status str
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    os_version str

    OS version.

    ** 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

    plugin_lists Sequence[cloudbridge.AgentPluginListArgs]
    List of plugins associated with the agent.
    state str
    The current state of the Agent.
    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_expire_agent_key_in_ms str
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    time_last_sync_received str
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    time_updated str
    The time when the Agent was updated. An RFC3339 formatted datetime string.
    agentPubKey String
    Resource principal public key.
    agentType String
    Agent identifier.
    agentVersion String
    Agent identifier.
    compartmentId String
    (Updatable) Compartment identifier.
    definedTags Map<Any>
    (Updatable) 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"}
    displayName String
    (Updatable) Agent identifier.
    environmentId String
    Environment identifier.
    freeformTags Map<Any>
    (Updatable) 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"}
    heartBeatStatus String
    The current heartbeat status of the Agent based on its timeLastSyncReceived value.
    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.
    osVersion String

    OS version.

    ** 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

    pluginLists List<Property Map>
    List of plugins associated with the agent.
    state String
    The current state of the Agent.
    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.
    timeExpireAgentKeyInMs String
    The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.
    timeLastSyncReceived String
    The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.
    timeUpdated String
    The time when the Agent was updated. An RFC3339 formatted datetime string.

    Supporting Types

    AgentPluginList, AgentPluginListArgs

    AgentId string
    Agent identifier.
    DefinedTags Dictionary<string, object>
    (Updatable) 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>
    (Updatable) 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.
    PluginVersion string
    Plugin version.
    State string
    The current state of the Agent.
    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
    Agent identifier.
    DefinedTags map[string]interface{}
    (Updatable) 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{}
    (Updatable) 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.
    PluginVersion string
    Plugin version.
    State string
    The current state of the Agent.
    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
    Agent identifier.
    definedTags Map<String,Object>
    (Updatable) 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>
    (Updatable) 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.
    pluginVersion String
    Plugin version.
    state String
    The current state of the Agent.
    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
    Agent identifier.
    definedTags {[key: string]: any}
    (Updatable) 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}
    (Updatable) 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.
    pluginVersion string
    Plugin version.
    state string
    The current state of the Agent.
    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
    Agent identifier.
    defined_tags Mapping[str, Any]
    (Updatable) 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]
    (Updatable) 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_version str
    Plugin version.
    state str
    The current state of the Agent.
    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
    Agent identifier.
    definedTags Map<Any>
    (Updatable) 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>
    (Updatable) 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.
    pluginVersion String
    Plugin version.
    state String
    The current state of the Agent.
    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

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

    $ pulumi import oci:CloudBridge/agent:Agent test_agent "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.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi