Agent

Manages an AWS DataSync Agent deployed on premises.

NOTE: One of activation_key or ip_address must be provided for resource creation (agent activation). Neither is required for resource import. If using ip_address, this provider must be able to make an HTTP (port 80) GET request to the specified IP address from where it is running. The agent will turn off that HTTP server after activation.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.DataSync.Agent("example", new Aws.DataSync.AgentArgs
        {
            IpAddress = "1.2.3.4",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/datasync"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := datasync.NewAgent(ctx, "example", &datasync.AgentArgs{
            IpAddress: pulumi.String("1.2.3.4"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.datasync.Agent("example", ip_address="1.2.3.4")

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

const example = new aws.datasync.Agent("example", {
    ipAddress: "1.2.3.4",
});

Create a Agent Resource

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

def Agent(resource_name, opts=None, activation_key=None, ip_address=None, name=None, tags=None, __props__=None);

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

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

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.
opts ResourceOptions: A bag of options that control this 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.

Agent Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Agent resource accepts the following input properties:

ActivationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
IpAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
Name string: Name of the DataSync Agent.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Agent.

ActivationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
IpAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
Name string: Name of the DataSync Agent.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Agent.

activationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
ipAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
name string: Name of the DataSync Agent.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Agent.

activation_key str: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
ip_address str: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
name str: Name of the DataSync Agent.
tags Dict[str, str]: Key-value pairs of resource tags to assign to the DataSync Agent.

Outputs

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

Arn string: Amazon Resource Name (ARN) of the DataSync Agent.
Id string: The provider-assigned unique ID for this managed resource.

Arn string: Amazon Resource Name (ARN) of the DataSync Agent.
Id string: The provider-assigned unique ID for this managed resource.

arn string: Amazon Resource Name (ARN) of the DataSync Agent.
id string: The provider-assigned unique ID for this managed resource.

arn str: Amazon Resource Name (ARN) of the DataSync Agent.
id str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, activation_key=None, arn=None, ip_address=None, name=None, tags=None, __props__=None);

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)

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.

The following state arguments are supported:

ActivationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
Arn string: Amazon Resource Name (ARN) of the DataSync Agent.
IpAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
Name string: Name of the DataSync Agent.
Tags Dictionary<string, string>: Key-value pairs of resource tags to assign to the DataSync Agent.

ActivationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
Arn string: Amazon Resource Name (ARN) of the DataSync Agent.
IpAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
Name string: Name of the DataSync Agent.
Tags map[string]string: Key-value pairs of resource tags to assign to the DataSync Agent.

activationKey string: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
arn string: Amazon Resource Name (ARN) of the DataSync Agent.
ipAddress string: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
name string: Name of the DataSync Agent.
tags {[key: string]: string}: Key-value pairs of resource tags to assign to the DataSync Agent.

activation_key str: DataSync Agent activation key during resource creation. Conflicts with ip_address. If an ip_address is provided instead, the provider will retrieve the activation_key as part of the resource creation.
arn str: Amazon Resource Name (ARN) of the DataSync Agent.
ip_address str: DataSync Agent IP address to retrieve activation key during resource creation. Conflicts with activation_key. DataSync Agent must be accessible on port 80 from where the provider is running.
name str: Name of the DataSync Agent.
tags Dict[str, str]: Key-value pairs of resource tags to assign to the DataSync Agent.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud