Class 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",
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Agent

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.DataSync

Assembly: Pulumi.Aws.dll

Syntax

public class Agent : CustomResource

Constructors

Agent(String, AgentArgs, CustomResourceOptions)

Create a Agent resource with the given unique name, arguments, and options.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AgentArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ActivationKey

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.

Declaration

public Output<string> ActivationKey { get; }

Property Value

Type	Description
Output<System.String>

Arn

Amazon Resource Name (ARN) of the DataSync Agent.

Declaration

public Output<string> Arn { get; }

Property Value

Type	Description
Output<System.String>

IpAddress

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.

Declaration

public Output<string> IpAddress { get; }

Property Value

Type	Description
Output<System.String>

Name

Name of the DataSync Agent.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Tags

Key-value pairs of resource tags to assign to the DataSync Agent.

Declaration

public Output<ImmutableDictionary<string, object>> Tags { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Methods

Get(String, Input<String>, AgentState, CustomResourceOptions)

Get an existing Agent resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

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

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AgentState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Agent