Docs Packages
  1. Packages
  2. Control Plane (cpln)
  3. API Docs
  4. Agent
Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
pulumiverse/pulumi-cpln

cpln.Agent

Explore with Pulumi AI

cpln logo
Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
pulumiverse/pulumi-cpln

    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: Optional[AgentArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Agent(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          description: Optional[str] = None,
          name: Optional[str] = None,
          tags: Optional[Mapping[str, str]] = None)
    func NewAgent(ctx *Context, name string, args *AgentArgs, opts ...ResourceOption) (*Agent, error)
    public Agent(string name, AgentArgs? args = null, CustomResourceOptions? opts = null)
    public Agent(String name, AgentArgs args)
public Agent(String name, AgentArgs args, CustomResourceOptions options)

    type: cpln: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 Cpln.Agent("agentResource", new()
{
    Description = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := cpln.NewAgent(ctx, "agentResource", &cpln.AgentArgs{
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var agentResource = new Agent("agentResource", AgentArgs.builder()
    .description("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    agent_resource = cpln.Agent("agentResource",
    description="string",
    name="string",
    tags={
        "string": "string",
    })

    const agentResource = new cpln.Agent("agentResource", {
    description: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: cpln:Agent
properties:
    description: string
    name: string
    tags:
        string: 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:

    Description string
    Description of the Agent.
    Name string
    Name of the Agent.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    Description string
    Description of the Agent.
    Name string
    Name of the Agent.
    Tags map[string]string
    Key-value map of resource tags.
    description String
    Description of the Agent.
    name String
    Name of the Agent.
    tags Map<String,String>
    Key-value map of resource tags.
    description string
    Description of the Agent.
    name string
    Name of the Agent.
    tags {[key: string]: string}
    Key-value map of resource tags.
    description str
    Description of the Agent.
    name str
    Name of the Agent.
    tags Mapping[str, str]
    Key-value map of resource tags.
    description String
    Description of the Agent.
    name String
    Name of the Agent.
    tags Map<String>
    Key-value map of resource tags.

    Outputs

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

    CplnId string
    The ID, in GUID format, of the Agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    UserData string
    The JSON output needed when creating an agent.
    CplnId string
    The ID, in GUID format, of the Agent.
    Id string
    The provider-assigned unique ID for this managed resource.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    UserData string
    The JSON output needed when creating an agent.
    cplnId String
    The ID, in GUID format, of the Agent.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    userData String
    The JSON output needed when creating an agent.
    cplnId string
    The ID, in GUID format, of the Agent.
    id string
    The provider-assigned unique ID for this managed resource.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    userData string
    The JSON output needed when creating an agent.
    cpln_id str
    The ID, in GUID format, of the Agent.
    id str
    The provider-assigned unique ID for this managed resource.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    user_data str
    The JSON output needed when creating an agent.
    cplnId String
    The ID, in GUID format, of the Agent.
    id String
    The provider-assigned unique ID for this managed resource.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    userData String
    The JSON output needed when creating an agent.

    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,
        cpln_id: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        self_link: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        user_data: 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:
    CplnId string
    The ID, in GUID format, of the Agent.
    Description string
    Description of the Agent.
    Name string
    Name of the Agent.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Tags Dictionary<string, string>
    Key-value map of resource tags.
    UserData string
    The JSON output needed when creating an agent.
    CplnId string
    The ID, in GUID format, of the Agent.
    Description string
    Description of the Agent.
    Name string
    Name of the Agent.
    SelfLink string
    Full link to this resource. Can be referenced by other resources.
    Tags map[string]string
    Key-value map of resource tags.
    UserData string
    The JSON output needed when creating an agent.
    cplnId String
    The ID, in GUID format, of the Agent.
    description String
    Description of the Agent.
    name String
    Name of the Agent.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    tags Map<String,String>
    Key-value map of resource tags.
    userData String
    The JSON output needed when creating an agent.
    cplnId string
    The ID, in GUID format, of the Agent.
    description string
    Description of the Agent.
    name string
    Name of the Agent.
    selfLink string
    Full link to this resource. Can be referenced by other resources.
    tags {[key: string]: string}
    Key-value map of resource tags.
    userData string
    The JSON output needed when creating an agent.
    cpln_id str
    The ID, in GUID format, of the Agent.
    description str
    Description of the Agent.
    name str
    Name of the Agent.
    self_link str
    Full link to this resource. Can be referenced by other resources.
    tags Mapping[str, str]
    Key-value map of resource tags.
    user_data str
    The JSON output needed when creating an agent.
    cplnId String
    The ID, in GUID format, of the Agent.
    description String
    Description of the Agent.
    name String
    Name of the Agent.
    selfLink String
    Full link to this resource. Can be referenced by other resources.
    tags Map<String>
    Key-value map of resource tags.
    userData String
    The JSON output needed when creating an agent.

    Package Details

    Repository
    cpln pulumiverse/pulumi-cpln
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cpln Terraform Provider.
    cpln logo
    Control Plane v0.0.27 published on Saturday, May 25, 2024 by pulumiverse
    pulumiverse/pulumi-cpln